editDeviceLogSettings

The editDeviceLogSettings operation handles configuration related to DeviceLogSettings model. 

Description

This API call is not allowed on the standby unit in an HA pair.

Data Parameters

Parameter Required Type Description
version False string A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
name False string A string that represents the name of the object
consoleLogFilter False object A reference to the console log filter.
syslogServerLogFilter False object A reference to the syslog server log filter.
bufferedLogging False object Represents set of buffered loggging settings.
deviceLoggingEnabled False boolean A Boolean value, TRUE or FALSE (the default). The TRUE value indicates that diagnostic logging is enabled.
id False string A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type True string A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Path Parameters

Parameter Required Type Description
objId True string

Example

- name: Execute 'editDeviceLogSettings' operation
  ftd_configuration:
    operation: "editDeviceLogSettings"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        consoleLogFilter: "{{ console_log_filter }}"
        syslogServerLogFilter: "{{ syslog_server_log_filter }}"
        bufferedLogging: "{{ buffered_logging }}"
        deviceLoggingEnabled: "{{ device_logging_enabled }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"