addProtocolObject

The addProtocolObject operation handles configuration related to ProtocolObject model. 

Data Parameters

Parameter Required Type Description
name False string A mandatory unicode alphanumeric string containing a unique name for the Port Object, from 1 to 128 characters without spaces. The string cannot include HTML tag. The check for duplicates is performed with a case insensitive search.
Field level constraints: cannot be null, length must be between 0 and 128 (inclusive), must match pattern (^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][ a-zA-Z0-9.+-]*[a-zA-Z0-9.+-]$), cannot have HTML. (Note: Additional constraints might exist)
description False string An optional unicode alphanumeric string containing a description of the Port Object, up to 200 characters. The string cannot include HTML tags
Field level constraints: length must be between 0 and 200 (inclusive), cannot have HTML. (Note: Additional constraints might exist)
isSystemDefined False boolean A Boolean value, TRUE or FALSE (the default). The TRUE value indicates that this object is a system defined object
protocol False string An enum value that specifies a protocol.
Field level constraints: cannot be null. (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.

Example

- name: Execute 'addProtocolObject' operation
  ftd_configuration:
    operation: "addProtocolObject"
    data:
        name: "{{ name }}"
        description: "{{ description }}"
        isSystemDefined: "{{ is_system_defined }}"
        protocol: "{{ protocol }}"
        type: "{{ type }}"