editSecurityZone

The editSecurityZone operation handles configuration related to SecurityZone 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.
name False string A string containing the name of the object, up to 48 characters in length
Field level constraints: cannot be null, length must be between 0 and 48 (inclusive), must match pattern ^[a-zA-Z0-9][a-zA-Z0-9.+-]*, cannot have HTML. (Note: Additional constraints might exist)
description False string A string containing a description of the object, up to 200 characters in length
Field level constraints: length must be between 0 and 200 (inclusive), cannot have HTML. (Note: Additional constraints might exist)
interfaces False [object] A list of interfaces used inside this security zone
Allowed types are: [PhysicalInterface, SubInterface]
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 ^((?!;).)*$, cannot have HTML. (Note: Additional constraints might exist)
type False 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 'editSecurityZone' operation
  ftd_configuration:
    operation: "editSecurityZone"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        interfaces: "{{ interfaces }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"