Skip to content
Was this article helpful?


Configuration for Configuration Variables for use in configuration template resource.


(click to see Operations )

Name Data Type Permissions Description
parent_name <String> Read-write Name of the parent rule.
name <String> Read-write Variable name.

Minimum length = 1

Maximum length = 128
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
parent_id <String> Read-write Id of parent rule.
default_value <String> Read-write Default Value of configuration variable.
id <String> Read-write Id is system generated key.
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.
values_enum <String[]> Read-write Possible Values Enum for the configuration variable.


(click to see Properties )

    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

    Was this article helpful?