- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# netscaler_gslb_site – Manage gslb site entities in Netscaler

New in version 2.4.0.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Manage gslb site entities in Netscaler.

## Requirements

The below requirements are needed on the host that executes this module.

- nitro python sdk

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
clip - |  | Cluster IP address. Specify this parameter to connect to the remote cluster site for GSLB auto-sync. Note: The cluster IP address is defined when creating the cluster.
metricexchange - | Choices: enabled disabled | Exchange metrics with other sites. Metrics are exchanged by using Metric Exchange Protocol (MEP). The appliances in the GSLB setup exchange health information once every second. If you disable metrics exchange, you can use only static load balancing methods (such as round robin, static proximity, or the hash-based methods), and if you disable metrics exchange when a dynamic load balancing method (such as least connection) is in operation, the appliance falls back to round robin. Also, if you disable metrics exchange, you must use a monitor to determine the state of GSLB services. Otherwise, the service is marked as DOWN.
naptrreplacementsuffix - |  | The naptr replacement suffix configured here will be used to construct the naptr replacement field in NAPTR record. Minimum length = 1
nitro_pass string / required |  | The password with which to authenticate to the netscaler node.
nitro_protocol string | Choices: http ← https | Which protocol to use when accessing the nitro API objects.
nitro_timeout float | Default: 310 | Time in seconds until a timeout error is thrown when establishing a new session with Netscaler
nitro_user string / required |  | The username with which to authenticate to the netscaler node.
nsip string / required |  | The ip address of the netscaler appliance where the nitro API calls will be made. The port can be specified with the colon (:). E.g. 192.168.1.1:555.
nwmetricexchange - | Choices: enabled disabled | Exchange, with other GSLB sites, network metrics such as round-trip time (RTT), learned from communications with various local DNS (LDNS) servers used by clients. RTT information is used in the dynamic RTT load balancing method, and is exchanged every 5 seconds.
parentsite - |  | Parent site of the GSLB site, in a parent-child topology.
publicclip - |  | IP address to be used to globally access the remote cluster when it is deployed behind a NAT. It can be same as the normal cluster IP address.
publicip - |  | Public IP address for the local site. Required only if the appliance is deployed in a private address space and the site has a public IP address hosted on an external firewall or a NAT device. Minimum length = 1
save_config boolean | Choices: no yes ← | If `yes` the module will save the configuration on the netscaler node if it makes any changes. The module will not save the configuration on the netscaler node if it made no changes.
sessionexchange - | Choices: enabled disabled | Exchange persistent session entries with other GSLB sites every five seconds.
siteipaddress - |  | IP address for the GSLB site. The GSLB site uses this IP address to communicate with other GSLB sites. For a local site, use any IP address that is owned by the appliance (for example, a SNIP or MIP address, or the IP address of the ADNS service). Minimum length = 1
sitename - |  | Name for the GSLB site. Must begin with an ASCII alphanumeric or underscore `_` character, and must contain only ASCII alphanumeric, underscore `_`, hash `#`, period `.`, space `` , colon `:`, at `@`, equals `=`, and hyphen `-` characters. Cannot be changed after the virtual server is created. Minimum length = 1
sitetype - | Choices: REMOTE LOCAL | Type of site to create. If the type is not specified, the appliance automatically detects and sets the type on the basis of the IP address being assigned to the site. If the specified site IP address is owned by the appliance (for example, a MIP address or SNIP address), the site is a local site. Otherwise, it is a remote site.
state string | Choices: absent present ← | The state of the resource being configured by the module on the netscaler node. When present the resource will be created if needed and configured according to the module's parameters. When absent the resource will be deleted from the netscaler node.
triggermonitor - | Choices: ALWAYS MEPDOWN MEPDOWN_SVCDOWN | Specify the conditions under which the GSLB service must be monitored by a monitor, if one is bound. Available settings function as follows: * `ALWAYS` - Monitor the GSLB service at all times. * `MEPDOWN` - Monitor the GSLB service only when the exchange of metrics through the Metrics Exchange Protocol (MEP) is disabled. `MEPDOWN_SVCDOWN` - Monitor the service in either of the following situations: * The exchange of metrics through MEP is disabled. * The exchange of metrics through MEP is enabled but the status of the service, learned through metrics exchange, is DOWN.
validate_certs boolean | Choices: no yes ← | If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

## Notes

Note

- For more information on using Ansible to manage Citrix NetScaler Network devices see https://www.ansible.com/ansible-netscaler.

## Examples

    - name: Setup gslb site
      delegate_to: localhost
      netscaler_gslb_site:
        nsip: 172.18.0.2
        nitro_user: nsroot
        nitro_pass: nsroot

        sitename: gslb-site-1
        siteipaddress: 192.168.1.1
        sitetype: LOCAL
        publicip: 192.168.1.1
        metricexchange: enabled
        nwmetricexchange: enabled
        sessionexchange: enabled
        triggermonitor: ALWAYS

## Return Values

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

Key | Returned | Description
--- | --- | ---
diff dictionary | failure | List of differences between the actual configured object and the configuration specified in the module Sample: { 'targetlbvserver': 'difference. ours: (str) server1 other: (str) server2' }
loglines list | always | list of logged messages by the module Sample: ['message 1', 'message 2']
msg string | failure | Message detailing the failure reason Sample: Action does not exist

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- George Nikolopoulos (@giorgos-nikolopoulos)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.