Try SpotterConfiguration for GSLB service group 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 service group resource.
cip:
choices:
- ENABLED
- DISABLED
description:
- Insert the Client IP header in requests forwarded to the GSLB service.
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
port:
description:
- Server port number.
type: int
delay:
description:
- The time allowed (in seconds) for a graceful shutdown. During this period, new connections
or requests will continue to be sent to this service for clients who already have
a persistent session on the system. Connections or requests from fresh or new clients
who do not yet have a persistence sessions on the system will not be sent to the
service. Instead, they will be load balanced among other available services. After
the delay time expires, no new requests or connections will be sent to the service.
type: float
order:
description:
- Order number to be assigned to the gslb servicegroup member
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
hashid:
description:
- The hash identifier for the service. This must be unique for each service. This
parameter is used by hash based load balancing methods.
type: float
weight:
description:
- Weight to assign to the servers in the service group. Specifies the capacity of
the servers relative to the other servers in the load balancing configuration. The
higher the weight, the higher the percentage of requests sent to the service.
type: float
comment:
description:
- Any information about the GSLB service group.
type: str
newname:
description:
- New name for the GSLB service group.
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
graceful:
choices:
- 'YES'
- 'NO'
description:
- Wait for all existing connections to the service to terminate before shutting down
the service.
type: str
publicip:
description:
- The public IP address that a NAT device translates to the GSLB service's private
IP address. Optional.
type: str
sitename:
description:
- Name of the GSLB site to which the service group belongs.
type: str
autoscale:
choices:
- DISABLED
- DNS
description:
- Auto scale option for a GSLB servicegroup
type: str
cipheader:
description:
- Name of the HTTP header whose value must be set to the IP address of the client.
Used with the Client IP parameter. If client IP insertion is enabled, and the client
IP header is not specified, the value of Client IP Header parameter or the value
set by the set ns config command is used as client's IP header name.
type: str
maxclient:
description:
- Maximum number of simultaneous open connections for the GSLB service group.
type: float
appflowlog:
choices:
- ENABLED
- DISABLED
description:
- Enable logging of AppFlow information for the specified GSLB service group.
type: str
clttimeout:
description:
- Time, in seconds, after which to terminate an idle client connection.
type: float
dup_weight:
description:
- weight of the monitor that is bound to GSLB servicegroup.
type: float
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
publicport:
description:
- The public port associated with the GSLB service's public IP address. The port is
mapped to the service's private port number. Applicable to the local GSLB service.
Optional.
type: int
servername:
description:
- Name of the server to which to bind the service group.
type: str
siteprefix:
description:
- The site's prefix string. When the GSLB service group is bound to a GSLB virtual
server, a GSLB site domain is generated internally for each bound serviceitem-domain
pair by concatenating the site prefix of the service item and the name of the domain.
If the special string NONE is specified, the site-prefix string is unset. When implementing
HTTP redirect site persistence, the Citrix ADC redirects GSLB requests to GSLB services
by using their site domains.
type: str
svrtimeout:
description:
- Time, in seconds, after which to terminate an idle server connection.
type: float
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
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 to exchange data with the GSLB service.
type: str
maxbandwidth:
description:
- Maximum bandwidth, in Kbps, allocated for all the services in the GSLB service group.
type: float
monthreshold:
description:
- Minimum sum of weights of the monitors that are bound to this GSLB service. Used
to determine whether to mark a GSLB service as UP or DOWN.
type: float
healthmonitor:
choices:
- 'YES'
- 'NO'
description:
- 'Monitor the health of this GSLB service.Available settings function are as follows:'
- C(YES) - Send probes to check the health of the GSLB service.
- C(NO) - Do not send probes to check the health of the GSLB service. With the C(NO)
option, the appliance shows the service as UP at all times.
type: str
downstateflush:
choices:
- ENABLED
- DISABLED
description:
- Flush all active transactions associated with all the services in the GSLB service
group whose state transitions from UP to DOWN. Do not enable this option for applications
that must complete their transactions.
type: str
includemembers:
description:
- Display the members of the listed GSLB service groups in addition to their settings.
Can be specified when no service group name is provided in the command. In that
case, the details displayed for each service group are identical to the details
displayed when a service group name is provided, except that bound monitors are
not displayed.
type: bool
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
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
sitepersistence:
choices:
- ConnectionProxy
- HTTPRedirect
- NONE
description:
- Use cookie-based site persistence. Applicable only to HTTP and SSL non-autoscale
enabled GSLB servicegroups.
type: str
autodelayedtrofs:
choices:
- 'YES'
- 'NO'
description:
- Indicates graceful movement of the service to TROFS. System will wait for monitor
response time out before moving to TROFS
type: str
monitor_name_svc:
description:
- Name of the monitor bound to the GSLB service group. Used to assign a weight to
the monitor.
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:
- Name of the GSLB service group. Must begin with an ASCII alphabetic or underscore
(_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period
(.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Can be changed
after the name is created.
type: str
gslbservicegroup_lbmonitor_binding:
description: Bindings for gslbservicegroup_lbmonitor_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
gslbservicegroup_gslbservicegroupmember_binding:
description: Bindings for gslbservicegroup_gslbservicegroupmember_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