netscaler.adc.gslbparameter module – Configuration for GSLB parameter 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.gslbparameter.

New in netscaler.adc 2.0.0

Synopsis

  • Configuration for GSLB parameter 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"

automaticconfigsync

any

GSLB configuration will be synced automatically to remote gslb sites if enabled.

Choices:

  • "ENABLED"

  • "DISABLED"

dropldnsreq

any

Drop LDNS requests if round-trip time (RTT) information is not available.

Choices:

  • "ENABLED"

  • "DISABLED"

gslbconfigsyncmonitor

any

If enabled, remote gslb site’s rsync port will be monitored and site is considered for configuration sync only when the monitor is successful.

Choices:

  • "ENABLED"

  • "DISABLED"

gslbsvcstatedelaytime

any

Amount of delay in updating the state of GSLB service to DOWN when MEP goes down.

This parameter is applicable only if monitors are not bound to GSLB services

gslbsyncinterval

any

Time duartion (in seconds) for which the gslb sync process will wait before checking for config changes.

gslbsynclocfiles

any

If disabled, Location files will not be synced to the remote sites as part of automatic sync.

Choices:

  • "ENABLED"

  • "DISABLED"

gslbsyncmode

any

Mode in which configuration will be synced from master site to remote sites.

Choices:

  • "IncrementalSync"

  • "FullSync"

gslbsyncsaveconfigcommand

any

If enabled, ‘save ns config’ command will be treated as other GSLB commands and synced to GSLB nodes when auto gslb sync option is enabled.

Choices:

  • "ENABLED"

  • "DISABLED"

ldnsentrytimeout

any

Time, in seconds, after which an inactive LDNS entry is removed.

ldnsmask

any

The IPv4 network mask with which to create LDNS entries.

ldnsprobeorder

any

Order in which monitors should be initiated to calculate RTT.

Choices:

  • "PING"

  • "DNS"

  • "TCP"

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.

mepkeepalivetimeout

any

Time duartion (in seconds) during which if no new packets received by Local gslb site from Remote gslb site then mark the MEP connection DOWN

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.

rtttolerance

any

Tolerance, in milliseconds, for newly learned round-trip time (RTT) values. If the difference between the old RTT value and the newly computed RTT value is less than or equal to the specified tolerance value, the LDNS entry in the network metric table is not updated with the new RTT value. Prevents the exchange of metrics when variations in RTT values are negligible.

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

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 unset, the resource will be unset on the NetScaler ADC node.

Choices:

  • "present" ← (default)

  • "unset"

svcstatelearningtime

any

Time (in seconds) within which local or child site services remain in learning phase. GSLB site will enter the learning phase after reboot, HA failover, Cluster GSLB owner node changes or MEP being enabled on local node. Backup parent (if configured) will selectively move the adopted children’s GSLB services to learning phase when primary parent goes down. While a service is in learning period, remote site will not honour the state and stats got through MEP for that service. State can be learnt from health monitor if bound explicitly.

undefaction

any

Action to perform when policy evaluation creates an UNDEF condition. Available settings function as follows:

* NOLBACTION - Does not consider LB action in making LB decision.

* RESET - Reset the request and notify the user, so that the user can resend the request.

* DROP - Drop the request without sending a response to the user.

v6ldnsmasklen

any

Mask for creating LDNS entries for IPv6 source addresses. The mask is defined as the number of leading bits to consider, in the source IP address, when creating an LDNS entry.

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)