upsertCloudCommunicationSettings

The upsertCloudCommunicationSettings operation handles configuration related to CloudCommunicationSettings model. 

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.
telemetryEnabled False boolean A mandatory boolean value, TRUE or FALSE (default value). The value TRUE enables Cisco Success Network which indicates that the telemetry data will be send to the cloud. FALSE will disable Cisco Success Network that prevents telemetry data from being forwarded.

Cisco Success Network enablement provides usage information and statistics to Cisco which are essential for Cisco to provide technical support. This information also allows Cisco to improve the product and to make you aware of unused available features so that you can maximize the value of the product in your network. Check out the Sample Data that will be sent to Cisco.
defenseOrchestratorEnabled False boolean A mandatory boolean value, TRUE or FALSE (default value). The value TRUE indicates that Cisco Defense Orchestrator can connect to the device and make REST calls. FALSE will prevent Cisco Defense Orchestrator from communicating with the device.
eventToCloudEnabled False boolean A mandatory boolean value, TRUE or FALSE (default value). The value TRUE enables Cisco Visibility which indicates that the events will be send to the cloud. FALSE will disable Cisco Visibility that prevents events from being forwarded to the cloud.
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 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 'upsertCloudCommunicationSettings' operation
  ftd_configuration:
    operation: "upsertCloudCommunicationSettings"
    data:
        version: "{{ version }}"
        telemetryEnabled: "{{ telemetry_enabled }}"
        defenseOrchestratorEnabled: "{{ defense_orchestrator_enabled }}"
        eventToCloudEnabled: "{{ event_to_cloud_enabled }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"