addTCPPortObject

The addTCPPortObject operation handles configuration related to TCPPortObject model.

Description

This API call is not allowed on the standby unit in an HA pair.

Data Parameters

Parameter	Required	Type	Description
name	True	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.
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). (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
port	True	string	A mandatory string representing a port or a port range. Valid port numbers are 1 to 65535. To specify a port range, separate the numbers with a hyphen, for example, 22-45. The second port number must be larger than the first port number. The string can only include digits or the hyphen symbol. Field level constraints: cannot be null, must be a valid port from 1 to 65535 or a valid port range. (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.

Example

- name: Execute 'addTCPPortObject' operation
  ftd_configuration:
    operation: "addTCPPortObject"
    data:
        name: "{{ name }}"
        description: "{{ description }}"
        isSystemDefined: "{{ is_system_defined }}"
        port: "{{ port }}"
        type: "{{ type }}"