Try SpotterConfiguration for Global Server Load Balancing Virtual Server 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 Global Server Load Balancing Virtual Server resource.
ecs:
choices:
- ENABLED
- DISABLED
description:
- If enabled, respond with EDNS Client Subnet (ECS) option in the response for a DNS
query with ECS. The ECS address will be used for persistence and spillover persistence
(if enabled) instead of the LDNS address. Persistence mask is ignored if ECS is
enabled.
type: str
edr:
choices:
- ENABLED
- DISABLED
description:
- Send clients an empty DNS response when the GSLB virtual server is DOWN.
type: str
mir:
choices:
- ENABLED
- DISABLED
description:
- Include multiple IP addresses in the DNS responses sent to clients.
type: str
ttl:
description:
- Time to live (TTL) for the domain.
type: float
name:
description:
- Name for the GSLB virtual server. 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. Can 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 vserver" or 'my vserver').
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
rule:
description:
- Expression, or name of a named expression, against which traffic is evaluated.
- This field is applicable only if gslb method or gslb backup method are set to API.
- 'The following requirements apply only to the Citrix ADC CLI:'
- '* If the expression includes one or more spaces, enclose the entire expression
in double quotation marks.'
- '* If the expression itself includes double quotation marks, escape the quotations
by using the \ character.'
- '* Alternatively, you can use single quotation marks to enclose the rule, in which
case you do not have to escape the double quotation marks.'
type: str
order:
description:
- Order number to be assigned to the service when it is bound to the lb vserver.
type: float
state:
choices:
- present
- absent
- enabled
- disabled
- 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(enabled), the resource will be enabled on the NetScaler ADC node.
- When C(disabled), the resource will be disabled on the NetScaler ADC node.
- When C(unset), the resource will be unset on the NetScaler ADC node.
type: str
iptype:
choices:
- IPV4
- IPV6
description:
- The IP type for this GSLB vserver.
type: str
weight:
description:
- Weight for the service.
type: float
comment:
description:
- Any comments that you might want to associate with the GSLB virtual server.
type: str
netmask:
description:
- IPv4 network mask for use in the SOURCEIPHASH load balancing method.
type: str
newname:
description:
- New name for the GSLB virtual server.
type: str
timeout:
description:
- Idle time, in minutes, after which a persistence entry is cleared.
type: float
api_path:
default: nitro/v1/config
description:
- Base NITRO API path.
- Define only in case of an ADM service proxy call
type: str
backupip:
description:
- The IP address of the backup service for the specified domain name. Used when all
the services bound to the domain are down, or when the backup chain of virtual servers
is down.
type: str
lbmethod:
choices:
- ROUNDROBIN
- LEASTCONNECTION
- LEASTRESPONSETIME
- SOURCEIPHASH
- LEASTBANDWIDTH
- LEASTPACKETS
- STATICPROXIMITY
- RTT
- CUSTOMLOAD
- API
description:
- Load balancing method for the GSLB virtual server.
type: str
somethod:
choices:
- CONNECTION
- DYNAMICCONNECTION
- BANDWIDTH
- HEALTH
- NONE
description:
- 'Type of threshold that, when exceeded, triggers spillover. Available settings function
as follows:'
- '* C(CONNECTION) - Spillover occurs when the number of client connections exceeds
the threshold.'
- '* C(DYNAMICCONNECTION) - Spillover occurs when the number of client connections
at the GSLB virtual server exceeds the sum of the maximum client (Max Clients) settings
for bound GSLB services. Do not specify a spillover threshold for this setting,
because the threshold is implied by the Max Clients settings of the bound GSLB services.'
- '* C(BANDWIDTH) - Spillover occurs when the bandwidth consumed by the GSLB virtual
server''s incoming and outgoing traffic exceeds the threshold.'
- '* C(HEALTH) - Spillover occurs when the percentage of weights of the GSLB services
that are UP drops below the threshold. For example, if services gslbSvc1, gslbSvc2,
and gslbSvc3 are bound to a virtual server, with weights 1, 2, and 3, and the spillover
threshold is 50%, spillover occurs if gslbSvc1 and gslbSvc3 or gslbSvc2 and gslbSvc3
transition to DOWN.'
- '* C(NONE) - Spillover does not occur.'
type: str
tolerance:
description:
- Site selection tolerance, in milliseconds, for implementing the RTT load balancing
method. If a site's RTT deviates from the lowest RTT by more than the specified
tolerance, the site is not considered when the Citrix ADC makes a GSLB decision.
The appliance implements the round robin method of global server load balancing
between sites whose RTT values are within the specified tolerance. If the tolerance
is 0 (zero), the appliance always sends clients the IP address of the site with
the lowest RTT.
type: float
appflowlog:
choices:
- ENABLED
- DISABLED
description:
- Enable logging appflow flow information
type: str
domainname:
description:
- Domain name for which to change the time to live (TTL) and/or backup service IP
address.
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
persistmask:
description:
- The optional IPv4 network mask applied to IPv4 addresses to establish source IP
address based persistence.
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
servicename:
description:
- Name of the GSLB service for which to change the weight.
type: str
servicetype:
choices:
- HTTP
- FTP
- TCP
- UDP
- SSL
- SSL_BRIDGE
- SSL_TCP
- NNTP
- ANY
- SIP_UDP
- SIP_TCP
- SIP_SSL
- RADIUS
- RDP
- RTSP
- MYSQL
- MSSQL
- ORACLE
description:
- Protocol used by services bound to the virtual server.
type: str
sothreshold:
description:
- Threshold at which spillover occurs. Specify an integer for the CONNECTION spillover
method, a bandwidth value in kilobits per second for the BANDWIDTH method (do not
enter the units), or a percentage for the HEALTH method (do not enter the percentage
symbol).
type: float
toggleorder:
choices:
- ASCENDING
- DESCENDING
description:
- Configure this option to toggle order preference
type: str
v6netmasklen:
description:
- Number of bits to consider, in an IPv6 source IP address, for creating the hash
that is required by the SOURCEIPHASH load balancing method.
type: float
backupvserver:
description:
- Name of the backup GSLB virtual server to which the appliance should to forward
requests if the status of the primary GSLB virtual server is down or exceeds its
spillover threshold.
type: str
cookie_domain:
description:
- The cookie domain for the GSLB site. Used when inserting the GSLB site cookie in
the HTTP response.
type: str
cookietimeout:
description:
- Timeout, in minutes, for the GSLB site cookie.
type: float
dnsrecordtype:
choices:
- A
- AAAA
- CNAME
- NAPTR
description:
- DNS record type to associate with the GSLB virtual server's domain name.
type: str
dynamicweight:
choices:
- SERVICECOUNT
- SERVICEWEIGHT
- DISABLED
description:
- Specify if the appliance should consider the service count, service weights, or
ignore both when using weight-based load balancing methods. The state of the number
of services bound to the virtual server help the appliance to select the service.
type: str
persistenceid:
description:
- The persistence ID for the GSLB virtual server. The ID is a positive integer that
enables GSLB sites to identify the GSLB virtual server, and is required if source
IP address based or spill over based persistence is enabled on the virtual server.
type: float
sitedomainttl:
description:
- TTL, in seconds, for all internally created site domains (created when a site prefix
is configured on a GSLB service) that are associated with this virtual server.
type: float
sopersistence:
choices:
- ENABLED
- DISABLED
description:
- If spillover occurs, maintain source IP address based persistence for both primary
and backup GSLB virtual servers.
type: str
backuplbmethod:
choices:
- ROUNDROBIN
- LEASTCONNECTION
- LEASTRESPONSETIME
- SOURCEIPHASH
- LEASTBANDWIDTH
- LEASTPACKETS
- STATICPROXIMITY
- RTT
- CUSTOMLOAD
- API
description:
- Backup load balancing method. Becomes operational if the primary load balancing
method fails or cannot be used. Valid only if the primary method is based on either
round-trip time (C(RTT)) or static proximity.
type: str
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
type: str
orderthreshold:
description:
- This option is used to to specify the threshold of minimum number of services to
be UP in an order, for it to be considered in Lb decision.
type: float
sobackupaction:
choices:
- DROP
- ACCEPT
- REDIRECT
description:
- Action to be performed if spillover is to take effect, but no backup chain to spillover
is usable or exists
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
persistencetype:
choices:
- SOURCEIP
- NONE
description:
- Use source IP address based persistence for the virtual server.
- After the load balancing method selects a service for the first packet, the IP address
received in response to the DNS query is used for subsequent requests from the same
client.
type: str
nitro_auth_token:
description:
- The authentication token provided by a login operation.
type: str
version_added: 2.6.0
version_added_collection: netscaler.adc
servicegroupname:
description:
- The GSLB service group name bound to the selected GSLB virtual server.
type: str
v6persistmasklen:
description:
- Number of bits to consider in an IPv6 source IP address when creating source IP
address based persistence sessions.
type: float
ecsaddrvalidation:
choices:
- ENABLED
- DISABLED
description:
- Validate if ECS address is a private or unroutable address and in such cases, use
the LDNS IP.
type: str
backupsessiontimeout:
description:
- A non zero value enables the feature whose minimum value is 2 minutes. The feature
can be disabled by setting the value to zero. The created session is in effect for
a specific client per domain.
type: float
disableprimaryondown:
choices:
- ENABLED
- DISABLED
description:
- Continue to direct traffic to the backup chain even after the primary GSLB virtual
server returns to the UP state. Used when spillover is configured for the virtual
server.
type: str
sopersistencetimeout:
description:
- Timeout for spillover persistence, in minutes.
type: float
considereffectivestate:
choices:
- NONE
- STATE_ONLY
description:
- If the primary state of all bound GSLB services is DOWN, consider the effective
states of all the GSLB services, obtained through the Metrics Exchange Protocol
(MEP), when determining the state of the GSLB virtual server. To consider the effective
state, set the parameter to C(STATE_ONLY). To disregard the effective state, set
the parameter to C(NONE).
- ''
- The effective state of a GSLB service is the ability of the corresponding virtual
server to serve traffic. The effective state of the load balancing virtual server,
which is transferred to the GSLB service, is UP even if only one virtual server
in the backup chain of virtual servers is in the UP state.
type: str
gslbvserver_domain_binding:
description: Bindings for gslbvserver_domain_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
gslbvserver_lbpolicy_binding:
description: Bindings for gslbvserver_lbpolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
gslbvserver_gslbservice_binding:
description: Bindings for gslbvserver_gslbservice_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
gslbvserver_spilloverpolicy_binding:
description: Bindings for gslbvserver_spilloverpolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
gslbvserver_gslbservicegroup_binding:
description: Bindings for gslbvserver_gslbservicegroup_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
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