netscaler.adc.nsvariable module – Configuration for variable resource.

Note

This module is part of the netscaler.adc collection (version 2.6.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netscaler.adc.

To use it in a playbook, specify: netscaler.adc.nsvariable.

New in netscaler.adc 2.0.0

Synopsis

  • Configuration for variable resource.

Parameters

Parameter

Comments

api_path

string

Base NITRO API path.

Define only in case of an ADM service proxy call

Default: "nitro/v1/config"

comment

any

Comments associated with this variable.

expires

any

Value expiration in seconds. If the value is not referenced within the expiration period it will be deleted. 0 (the default) means no expiration.

iffull

any

Action to perform if an assignment to a map exceeds its configured max-entries:

lru - (default) reuse the least recently used entry in the map.

undef - force the assignment to return an undefined (Undef) result to the policy executing the assignment.

Choices:

  • "undef"

  • "lru"

ifnovalue

any

Action to perform if on a variable reference in an expression if the variable is single-valued and uninitialized

or if the variable is a map and there is no value for the specified key:

init - (default) initialize the single-value variable, or create a map entry for the key and the initial value,

using the -init value or its default.

undef - force the expression evaluation to return an undefined (Undef) result to the policy executing the expression.

Choices:

  • "undef"

  • "init"

ifvaluetoobig

any

Action to perform if an value is assigned to a text variable that exceeds its configured max-size,

or if a key is used that exceeds its configured max-size:

truncate - (default) truncate the text string to the first max-size bytes and proceed.

undef - force the assignment or expression evaluation to return an undefined (Undef) result to the policy executing the assignment or expression.

Choices:

  • "undef"

  • "truncate"

init

any

Initialization value for this variable, to which a singleton variable or map entry will be set if it is referenced before an assignment action has assigned it a value. If the singleton variable or map entry already has been assigned a value, setting this parameter will have no effect on that variable value. Default: 0 for ulong, NULL for text

managed_netscaler_instance_id

string

added in netscaler.adc 2.6.0

The ID of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_ip

string

added in netscaler.adc 2.6.0

The IP of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_name

string

added in netscaler.adc 2.6.0

The name of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_password

string

added in netscaler.adc 2.6.0

The password of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

managed_netscaler_instance_username

string

added in netscaler.adc 2.6.0

The username of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

name

any

Variable name. This follows the same syntax rules as other expression entity names:

It must begin with an alpha character (A-Z or a-z) or an underscore (_).

The rest of the characters must be alpha, numeric (0-9) or underscores.

It cannot be re or xp (reserved for regular and XPath expressions).

It cannot be an expression reserved word (e.g. SYS or HTTP).

It cannot be used for an existing expression object (HTTP callout, patset, dataset, stringmap, or named expression).

netscaler_console_as_proxy_server

boolean

added in netscaler.adc 2.6.0

The IP address of the NetScaler ADC appliance acting as a proxy server.

Define only in case of an ADM service proxy call

Choices:

  • false ← (default)

  • true

nitro_auth_token

string

The authentication token provided by a login operation.

nitro_pass

string

The password with which to authenticate to the NetScaler ADC node.

nitro_protocol

string

Which protocol to use when accessing the nitro API objects.

Choices:

  • "http"

  • "https" ← (default)

nitro_user

string

The username with which to authenticate to the NetScaler ADC node.

nsip

string / required

The ip address of the NetScaler ADC appliance where the nitro API calls will be made.

The port can be specified with the colon (:). E.g. 192.168.1.1:555.

save_config

boolean

If true the module will save the configuration on the NetScaler ADC node if it makes any changes.

The module will not save the configuration on the NetScaler ADC node if it made no changes.

Choices:

  • false ← (default)

  • true

scope

string

Scope of the variable:

global - (default) one set of values visible across all Packet Engines on a standalone Citrix ADC, an HA pair, or all nodes of a cluster

transaction - one value for each request-response transaction (singleton variables only; no expiration)

Choices:

  • "global"

  • "transaction"

state

string

The state of the resource being configured by the module on the NetScaler ADC node.

When present, the resource will be added/updated configured according to the module’s parameters.

When absent, the resource will be deleted from the NetScaler ADC node.

When unset, the resource will be unset on the NetScaler ADC node.

Choices:

  • "present" ← (default)

  • "absent"

  • "unset"

type

string

Specification of the variable type; one of the following:

ulong - singleton variable with an unsigned 64-bit value.

text(value-max-size) - singleton variable with a text string value.

map(text(key-max-size),ulong,max-entries) - map of text string keys to unsigned 64-bit values.

map(text(key-max-size),text(value-max-size),max-entries) - map of text string keys to text string values.

where

value-max-size is a positive integer that is the maximum number of bytes in a text string value.

key-max-size is a positive integer that is the maximum number of bytes in a text string key.

max-entries is a positive integer that is the maximum number of entries in a map variable.

For a global singleton text variable, value-max-size <= 64000.

For a global map with ulong values, key-max-size <= 64000.

For a global map with text values, key-max-size + value-max-size <= 64000.

max-entries is a positive integer that is the maximum number of entries in a map variable. This has a theoretical maximum of 2^64-1, but in actual use will be much smaller, considering the memory available for use by the map.

Example:

map(text(10),text(20),100) specifies a map of text string keys (max size 10 bytes) to text string values (max size 20 bytes), with 100 max entries.

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

Notes

Note

Examples

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Indicates if any change is made by the module

Returned: always

Sample: true

diff

dictionary

Dictionary of before and after changes

Returned: always

Sample: {"after": {"key2": "pqr"}, "before": {"key1": "xyz"}, "prepared": "changes done"}

diff_list

list / elements=string

List of differences between the actual configured object and the configuration specified in the module

Returned: when changed

Sample: ["Attribute `key1` differs. Desired: (<class 'str'>) XYZ. Existing: (<class 'str'>) PQR"]

failed

boolean

Indicates if the module failed or not

Returned: always

Sample: false

loglines

list / elements=string

list of logged messages by the module

Returned: always

Sample: ["message 1", "message 2"]

Authors

  • Sumanth Lingappa (@sumanth-lingappa)