Skip to content

eventrule_variable_values

Configuration for Variable Values required for config template execution resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
parent_name<String>Read-write.
value<String>Read-writeValue of the Variable to be used for all device ips/groups.
name<String>Read-writeVariable name.
Minimum length = 1
Maximum length = 128
display_name<String>Read-writeDisplay name of configuration variable.
Minimum length = 1
Maximum length = 1024
description<String>Read-writeDescription of configuration variable.
Minimum length = 1
Maximum length = 1024
device_values<device_values_map[]>Read-writeValues of variables used in commands of the configuration template for individual devices.
parent_id<String>Read-write.
default_value<String>Read-writeDefault Value of configuration variable.
id<String>Read-write.
type<String>Read-writeType of Variable.
Minimum length = 1
Maximum length = 64
values_enum_db<String>Read-writeComma seperated 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>.

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/eventrule_variable_values

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "eventrule_variable_values":[{
"device_values_mapping":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<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>}]}