editSyslogServer

The editSyslogServer operation handles configuration related to SyslogServer 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
deviceInterface	False	object	The interface by which the remote syslog server is reached. Allowed types are: [BridgeGroupInterface, EtherChannelInterface, PhysicalInterface, SubInterface, VirtualTunnelInterface, VlanInterface]
useManagementInterface	False	boolean	Use management interface to reach syslog server
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)
host	True	string	The IP address of the remote syslog server. Field level constraints: cannot be null, must be a valid IP address. (Note: Additional constraints might exist)
port	False	string	The port(TCP/UDP) of the remote syslog server. Field level constraints: must be a valid port from 1 to 65535 or a valid port range. (Note: Additional constraints might exist)
protocol	True	string	Protocol type (UDP/TCP) Field level constraints: cannot be null. (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 'editSyslogServer' operation
  ftd_configuration:
    operation: "editSyslogServer"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        deviceInterface: "{{ device_interface }}"
        useManagementInterface: "{{ use_management_interface }}"
        id: "{{ id }}"
        host: "{{ host }}"
        port: "{{ port }}"
        protocol: "{{ protocol }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"