editSuccessNetwork

The editSuccessNetwork operation handles configuration related to SuccessNetwork model.

Description

Allows to enable or disable this service

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.
enableService	False	boolean	A mandatory boolean value, TRUE or FALSE (default value). The value TRUE indicates that the device usage information and statistics will be sent to the cloud. FALSE will disable sending of device usage information and statistics 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.

Path Parameters

Parameter	Required	Type	Description
objId	True	string

Example

- name: Execute 'editSuccessNetwork' operation
  ftd_configuration:
    operation: "editSuccessNetwork"
    data:
        version: "{{ version }}"
        enableService: "{{ enable_service }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"