editSecurityIntelligencePolicy

The editSecurityIntelligencePolicy operation handles configuration related to SecurityIntelligencePolicy 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 True string An optional string specifying the name of the Security Intelligence Policy. The string cannot have HTML tags or SQL characters.
securityIntelligenceNetworkPolicy True object An optional object specifying the URL Policy.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
Allowed types are: [SecurityIntelligenceNetworkPolicy]
securityIntelligenceURLPolicy True object An optional object specifying the Network Policy.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
Allowed types are: [SecurityIntelligenceURLPolicy]
securityIntelligenceDNSPolicy True object An optional object specifying the DNS Policy.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
Allowed types are: [SecurityIntelligenceDNSPolicy]
logEnabled False boolean A mandatory boolean object, TRUE or FALSE (default value). The value TRUE indicates syslog logging is enabled for the Security Intelligence policies. The value FALSE disables the logging for Security Intelligence policies.
syslogServer False object An optional syslog object specifying the syslog server details. Logs in the form of syslogs will be sent to the syslog server when specified.
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 'editSecurityIntelligencePolicy' operation
  ftd_configuration:
    operation: "editSecurityIntelligencePolicy"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        securityIntelligenceNetworkPolicy: "{{ security_intelligence_network_policy }}"
        securityIntelligenceURLPolicy: "{{ security_intelligence_url_policy }}"
        securityIntelligenceDNSPolicy: "{{ security_intelligence_dns_policy }}"
        logEnabled: "{{ log_enabled }}"
        syslogServer: "{{ syslog_server }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"