editNetworkObjectGroup

The editNetworkObjectGroup operation handles configuration related to NetworkObjectGroup 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	A string that is the name of the network group object.
description	False	string	A string containing the description information Field level constraints: length must be between 0 and 200 (inclusive). (Note: Additional constraints might exist)
isSystemDefined	False	boolean	A Boolean value, TRUE or FALSE(the default). The TRUE value indicates that this Network object group is a system defined object
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)
objects	False	[object]	A comma-delimited list of references of NetworkObject or NetworkObjectGroup objects, or both, that are part of this group Allowed types are: [NetworkObject, NetworkObjectGroup]
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 'editNetworkObjectGroup' operation
  ftd_configuration:
    operation: "editNetworkObjectGroup"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        isSystemDefined: "{{ is_system_defined }}"
        id: "{{ id }}"
        objects: "{{ objects }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"