addSyslogServer

The addSyslogServer 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
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
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.

Example

- name: Execute 'addSyslogServer' operation
  ftd_configuration:
    operation: "addSyslogServer"
    data:
        name: "{{ name }}"
        deviceInterface: "{{ device_interface }}"
        useManagementInterface: "{{ use_management_interface }}"
        host: "{{ host }}"
        port: "{{ port }}"
        protocol: "{{ protocol }}"
        type: "{{ type }}"