config_variable

Configuration for Configuration Variables for use in configuration template resource.

Read/write properties

parent_name<String>

Parent name of config variable.

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

parent_id<String>

Parent Id of config variable.

type<String>

Type of Variable Text Field, Numeric Text Field, Choice, File, IP Addrss Field, Password Field.
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

values_enum<String[]>

Possible Values values for choice type variable.

required<Boolean>

If it is required argument for command then true else false..

id<String>

Id is system generated key for all config variable.

valuex<String>

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

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)add

get (all)

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

Query-parameters:

filter

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

Use this query-parameter to get the filtered set of config_variable 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/config_variable?pagesize=#no&pageno=#no

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

count

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

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

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

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>, "config_variable":[{
      "parent_name":<String_value>,
      "values_enum_db":<String_value>,
      "name":<String_value>,
      "display_name":<String_value>,
      "parent_id":<String_value>,
      "type":<String_value>,
      "default_value":<String_value>,
      "description":<String_value>,
      "values_enum":<String_value>,
      "required":<Boolean_value>,
      "id":<String_value>,
      "valuex":<String_value>}]}

add

URL:https://<MGMT-IP>/nitro/v2/config/config_variable?onerror=<String_value>

HTTPS Method:POST