variable_values

Configuration for Variable Values required for config template execution resource.

Read/write properties

type<String>

Type of Variable.
Minimum length = 1
Maximum length = 64

default_value<String>

Default Value of configuration variable.

description<String>

Description of configuration variable.
Minimum length = 1
Maximum length = 1024

id<String>

.

valuex<String>

Secure Value of the Variable to be used for all device ips/groups.

device_values<device_values_map[]>

Values of variables used in commands of the configuration template for individual devices.

parent_name<String>

.

values_enum_db<String>

Comma separated list of possible values of variable.

name<String>

Variable name.
Minimum length = 1
Maximum length = 128

display_name<String>

Display name of configuration variable.
Minimum length = 1
Maximum length = 1024

value<String>

Value of the Variable to be used for all device ips/groups.

parent_id<String>

.

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

The following parameters can be used in the nitro request :

onerror   <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE

get (all)

URL:https://<MGMT-IP>/nitro/v2/config/variable_values

Query-parameters:

filter

https://<MGMT-IP>/nitro/v2/config/variable_values?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of variable_values resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no&pageno=#no

https://<MGMT-IP>/nitro/v2/config/variable_values?pagesize=#no&pageno=#no

Use this query-parameter to get the variable_values resources in chunks.

count

https://<MGMT-IP>/nitro/v2/config/variable_values?count=yes

Use this query-parameter to get the count of variable_values resources.

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "variable_values":[{
      "type":<String_value>,
      "default_value":<String_value>,
      "description":<String_value>,
      "id":<String_value>,
      "device_values_mapping":<String_value>,
      "valuex":<String_value>,
      "device_values":[{
      "device":<String_value>,
      "id":<String_value>,
      "parent_name":<String_value>,
      "value":<String_value>,
      "valuex":<String_value>,
      "device_group":<String_value>,
      "parent_id":<String_value>}],
      "parent_name":<String_value>,
      "values_enum_db":<String_value>,
      "name":<String_value>,
      "display_name":<String_value>,
      "value":<String_value>,
      "parent_id":<String_value>}]}