Try SpotterConfiguration for GSLB site resource.
| "added in version" 2.0.0 of netscaler.adc"
Authors: Sumanth Lingappa (@sumanth-lingappa)
preview | supported by community
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections:
- name: netscaler.adc
version: 2.5.1Configuration for GSLB site resource.
clip:
description:
- '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.'
type: str
nsip:
description:
- 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.
required: true
type: str
state:
choices:
- present
- absent
- unset
default: present
description:
- The state of the resource being configured by the module on the NetScaler ADC node.
- When C(present), the resource will be added/updated configured according to the
module's parameters.
- When C(absent), the resource will be deleted from the NetScaler ADC node.
- When C(unset), the resource will be unset on the NetScaler ADC node.
type: str
api_path:
default: nitro/v1/config
description:
- Base NITRO API path.
- Define only in case of an ADM service proxy call
type: str
publicip:
description:
- 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.
type: str
sitename:
description:
- 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.
- ''
- 'CLI Users: If the name includes one or more spaces, enclose the name in double
or single quotation marks (for example, "my gslbsite" or ''my gslbsite'').'
type: str
sitetype:
choices:
- REMOTE
- LOCAL
description:
- 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.
type: str
nitro_pass:
description:
- The password with which to authenticate to the NetScaler ADC node.
required: false
type: str
nitro_user:
description:
- The username with which to authenticate to the NetScaler ADC node.
required: false
type: str
parentsite:
description:
- Parent site of the GSLB site, in a parent-child topology.
type: str
publicclip:
description:
- 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.
type: str
save_config:
default: false
description:
- If C(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.
type: bool
siteipaddress:
description:
- 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).
type: str
metricexchange:
choices:
- ENABLED
- DISABLED
description:
- 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.
type: str
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
type: str
triggermonitor:
choices:
- ALWAYS
- MEPDOWN
- MEPDOWN_SVCDOWN
description:
- 'Specify the conditions under which the GSLB service must be monitored by a monitor,
if one is bound. Available settings function as follows:'
- '* C(ALWAYS) - Monitor the GSLB service at all times.'
- '* C(MEPDOWN) - Monitor the GSLB service only when the exchange of metrics through
the Metrics Exchange Protocol (MEP) is disabled.'
- 'C(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.'
type: str
validate_certs:
default: true
description:
- If C(false), SSL certificates will not be validated. This should only be used on
personally controlled sites using self-signed certificates.
required: false
type: bool
sessionexchange:
choices:
- ENABLED
- DISABLED
description:
- Exchange persistent session entries with other GSLB sites every five seconds.
type: str
backupparentlist:
description:
- The list of backup gslb sites configured in preferred order. Need to be parent gsb
sites.
elements: str
type: list
nitro_auth_token:
description:
- The authentication token provided by a login operation.
type: str
version_added: 2.6.0
version_added_collection: netscaler.adc
nwmetricexchange:
choices:
- ENABLED
- DISABLED
description:
- 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.
type: str
naptrreplacementsuffix:
description:
- The naptr replacement suffix configured here will be used to construct the naptr
replacement field in NAPTR record.
type: str
changed:
description: Indicates if any change is made by the module
returned: always
sample: true
type: bool
diff:
description: Dictionary of before and after changes
returned: always
sample:
after:
key2: pqr
before:
key1: xyz
prepared: changes done
type: dict
diff_list:
description: 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'
type: list
failed:
description: Indicates if the module failed or not
returned: always
sample: false
type: bool
loglines:
description: list of logged messages by the module
returned: always
sample:
- message 1
- message 2
type: list