addPortObjectGroup
The addPortObjectGroup operation handles configuration related to PortObjectGroup 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 the system created the object. FALSE indicates that the object is user-defined | ||
objects | False | [object] | A mandatory list of TCPPortObject, UDPPortObject, ProtocolObject, ICMPv4Object or ICMPv6Object Allowed types are: [UDPPortObject, ICMPv6PortObject, ICMPv4PortObject, ProtocolObject, TCPPortObject] |
||
type | True | string | A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name. |
Example
- name: Execute 'addPortObjectGroup' operation
ftd_configuration:
operation: "addPortObjectGroup"
data:
name: "{{ name }}"
description: "{{ description }}"
isSystemDefined: "{{ is_system_defined }}"
objects: "{{ objects }}"
type: "{{ type }}"