variable_values

Last published : Aug 10, 2026
Configuration for Variable Values required for config template execution resource.
Related information

Properties

(click to see Operations )
Name Data Type Permissions Description
parent_name <String> Read-write .
value <String> Read-write Value of the Variable to be used for all device ips/groups.
name <String> Read-write Variable name. Minimum length = 1 Maximum length = 128
valuex <String> Read-write Secure Value of the Variable to be used for all device ips/groups.
display_name <String> Read-write Display name of configuration variable. Minimum length = 1 Maximum length = 1024
description <String> Read-write Description of configuration variable. Minimum length = 1 Maximum length = 1024
device_values <device_values_map[]> Read-write Values of variables used in commands of the configuration template for individual devices.
parent_id <String> Read-write .
default_value <String> Read-write Default Value of configuration variable.
id <String> Read-write .
type <String> Read-write Type of Variable. Minimum length = 1 Maximum length = 64
values_enum_db <String> Read-write Comma separated list of possible values of variable.

Operations

(click to see Properties )
  • GET (ALL)
Some options that you can use for each operations:
  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes
    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
    To do this, you must specify the username and password in the request header of the NITRO request as follows:
    X-NITRO-USER: <username>
    X-NITRO-PASS: <password>
    Note: In such cases, make sure that the request header DOES not include the following:
    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
*Note: * Mandatory parameters are marked in red and placeholder content is marked in green
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:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "variable_values":[{
"device_values_mapping":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"valuex":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"valuex":<String_value>,
"device_group":<String_value>,
"device":<String_value>,
"parent_id":<String_value>}],
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>}]}