editFlexConfigPolicy

The editFlexConfigPolicy operation handles configuration related to FlexConfigPolicy 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 mandatory unicode alphanumeric string containing a unique name for the object, from 1 to 128 characters without spaces. The string cannot include HTML tags. You can create one FlexConfigPolicy object only.
flexConfigObjects False [object] The list of FlexConfigObjects that should be deployed to the device. You must list the FlexConfigObjects in the right order to ensure that configuration commands that depend on other features having been configured come after those commands are issued.
Allowed types are: [FlexConfigObject]
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 'editFlexConfigPolicy' operation
  ftd_configuration:
    operation: "editFlexConfigPolicy"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        flexConfigObjects: "{{ flex_config_objects }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"