upsertNetworkAnalysisPolicy

The upsertNetworkAnalysisPolicy operation handles configuration related to NetworkAnalysisPolicy model.

Description

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

This API will update the base policy and inspection mode of the default Network Analysis Policy.

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 used to identify the Network Analysis Policy.
description	False	string	Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
basePolicy	False	object	The Cisco Talos policy which provides the base configuration for the specified Network Analysis Policy. Allowed types are: [NetworkAnalysisPolicy]
inspectionMode	False	string	An enum value (DETECTION or PREVENTION) that controls NAP inspection mode. Prevention(default) mode allows traffic to be modified or dropped by the network analysis policy. If NAP Prevention is enabled, Snort inspection mode is set to inline and the traffic passing through is modified or dropped based on the network analysis policy configured. The device should be configured in Routed/Inline mode for 'Prevention mode' to be actionable. Detection mode does not modify or drop traffic when anomalies are detected. It only notifies of the anomaly detected. If NAP Detection is enabled, Snort inspection mode is set to inline-test and no traffic modification or drop is performed on the output stream. Any anomalies detected will be notified as 'would' be modified or dropped based on the network analysis policy configured.
isSystemDefined	False	boolean	A boolean value that indicates if the policy is system defined.
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.

Query Parameters

Parameter	Required	Type	Description
filter	False	string	The criteria used to filter the models you are requesting. It should have the following format: {key}{operator}{value}[;{key}{operator}{value}]. Supported operators are: "!"(not equals), ":"(equals), "~"(similar). Supported keys are: "name", "fts". The "fts" filter cannot be used with other filters. Default filtering for Upsert operation is done by name.

Example

- name: Execute 'upsertNetworkAnalysisPolicy' operation
  ftd_configuration:
    operation: "upsertNetworkAnalysisPolicy"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        basePolicy: "{{ base_policy }}"
        inspectionMode: "{{ inspection_mode }}"
        isSystemDefined: "{{ is_system_defined }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"