editAMPCloudConnection

The editAMPCloudConnection operation handles configuration related to AMPCloudConnection 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	Name of the AMPCloudConnection object
enableAmpForNetwork	False	boolean	A Boolean value that indicates whether to enable AMP for Networks (TRUE) or not (FALSE). The default is TRUE.
ampNetworkServer	True	object	An AMPServer object that defines the details of the AMP for Networks server. Default AMP server is US cloud. User can update it to APJC cloud or EU cloud Field level constraints: cannot be null. (Note: Additional constraints might exist) Allowed types are: [AMPServer]
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 'editAMPCloudConnection' operation
  ftd_configuration:
    operation: "editAMPCloudConnection"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        enableAmpForNetwork: "{{ enable_amp_for_network }}"
        ampNetworkServer: "{{ amp_network_server }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"