TCPPortObject
Description
A TCPPortObject defines a single TCP port or a range of ports. (Note: The field level constraints listed here might not cover all the constraints on the field. Additional constraints might exist.)
Supported Operations
- addTCPPortObject
- getTCPPortObjectList
- editTCPPortObject
- getTCPPortObject
- deleteTCPPortObject
- upsertTCPPortObject
Model Properties
| Property | 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 | 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) |
|||
| 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 ^((?!;).)*$. (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. | |||