upsertWebAnalyticsSetting

The upsertWebAnalyticsSetting operation handles configuration related to WebAnalyticsSetting 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 Alphanumeric string to identify the version of the object
disabled False boolean A Boolean value, TRUE or FALSE, that indicates whether Web Analytics is disabled. If FALSE, the feature is enabled.
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 webanalyticssetting

Query Parameters

Parameter Required Type Description
filter True 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".

Example

- name: Execute 'upsertWebAnalyticsSetting' operation
  ftd_configuration:
    operation: "upsertWebAnalyticsSetting"
    data:
        version: "{{ version }}"
        disabled: "{{ disabled }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"