editIntrusionSettings

The editIntrusionSettings operation handles configuration related to IntrusionSettings 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
syslogServers False [object] An optional list of SyslogServer objects. Specify a list of syslog servers if you want a copy of intrusion events to be sent to an external syslog server. Snort will send logs out the management interface, regardless of which interface is configured for the syslog server.
Allowed types are: [SyslogServer]
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 'editIntrusionSettings' operation
  ftd_configuration:
    operation: "editIntrusionSettings"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        syslogServers: "{{ syslog_servers }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"