VariableBase
Description
(Note: The field level constraints listed here might not cover all the constraints on the field. Additional constraints might exist.)
Model Properties
| Property | Required | Type | Description | |||
|---|---|---|---|---|---|---|
| name | True | string | A mandatory unicode alphanumeric string containing a unique name for the object, from 1 to 128 characters without spaces. The string cannot include HTML tag. Field level constraints: cannot be null, length must be between 0 and 128 (inclusive), must match pattern ^\w[\w+-]*. (Note: Additional constraints might exist) |
|||
| variableType | True | string | An enum value that specifies the type of the variable. Variable value must be assigned to the value field if variable type is STRING, NUMERIC, BOOLEAN, or IP, else value must be assigned to the entityValue field. ENUM is not a supported type for FlexVariables. Field level constraints: cannot be null. (Note: Additional constraints might exist) |
|||
| value | False | string | The value must be a valid string if variableType=STRING, must be a valid IP address denoted as string if variableType=IP, must be a valid integer denoted as string if variableType=NUMERIC, must be a boolean denoted as string if variableType=BOOLEAN, must be one of the allowed enum values or null if variableType=ENUM. In all other cases, this property must be null |
|||
| entityValue | False | object | The value must be a NetworkObject or NetworkObjectGroup if variableType=NETWORK, must be a TCPPortObject or UDPPortObject if variableType=PORT, must be a Secret Object if variableType=SECRET, or must be a PhysicalInterface Object, SubInterface Object, or BridgeGroupInterface object if variableType=INTERFACE. In all other cases, this property must be null |
|||
| type | True | string | A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name. | |||