addUDPPortObject
The addUDPPortObject operation handles configuration related to UDPPortObject 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 | ||
| port | False | 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, 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. | ||
Example
- name: Execute 'addUDPPortObject' operation
ftd_configuration:
operation: "addUDPPortObject"
data:
name: "{{ name }}"
description: "{{ description }}"
isSystemDefined: "{{ is_system_defined }}"
port: "{{ port }}"
type: "{{ type }}"