Try SpotterConfiguration for GSLB service 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 resource.
ip:
description:
- IP address for the GSLB service. Should represent a load balancing, content switching,
or VPN virtual server on the Citrix ADC, or the IP address of another load balancing
device.
type: str
cip:
choices:
- ENABLED
- DISABLED
description:
- In the request that is forwarded to the GSLB service, insert a header that stores
the client's IP address. Client IP header insertion is used in connection-proxy
based site persistence.
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:
- Port on which the load balancing entity represented by this GSLB service listens.
type: int
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
hashid:
description:
- Unique hash identifier for the GSLB service, used by hash based load balancing methods.
type: float
viewip:
description:
- IP address to be used for the given view
type: str
weight:
description:
- Weight to assign to the monitor-service binding. A larger number specifies a greater
weight. Contributes to the monitoring threshold, which determines the state of the
service.
type: float
comment:
description:
- Any comments that you might want to associate with the GSLB service.
type: str
newname:
description:
- New name for the GSLB service.
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:
- 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 belongs.
type: str
viewname:
description:
- Name of the DNS view of the service. A DNS view is used in global server load balancing
(GSLB) to return a predetermined IP address to a specific group of clients, which
are identified by using a DNS policy.
type: str
cipheader:
description:
- Name for the HTTP header that stores the client's IP address. Used with the Client
IP option. If client IP header insertion is enabled on the service and a name is
not specified for the header, the Citrix ADC uses the name specified by the cipHeader
parameter in the set ns param command or, in the GUI, the Client IP Header parameter
in the Configure HTTP Parameters dialog box.
type: str
ipaddress:
description:
- The new IP address of the service.
type: str
maxclient:
description:
- The maximum number of open connections that the service can support at any given
time. A GSLB service whose connection count reaches the maximum is not considered
when a GSLB decision is made, until the connection count drops below the maximum.
type: float
appflowlog:
choices:
- ENABLED
- DISABLED
description:
- Enable logging appflow flow information
type: str
clttimeout:
description:
- Idle time, in seconds, after which a client connection is terminated. Applicable
if connection proxy based site persistence is used.
type: float
cnameentry:
description:
- Canonical name of the GSLB service. Used in CNAME-based GSLB.
type: str
naptrorder:
description:
- An integer specifying the order in which the NAPTR records MUST be processed in
order to accurately represent the ordered list of Rules. The ordering is from lowest
to highest
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 hosting the GSLB service.
type: str
siteprefix:
description:
- The site's prefix string. When the service is bound to a GSLB virtual server, a
GSLB site domain is generated internally for each bound service-domain pair by concatenating
the site prefix of the service 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:
- Idle time, in seconds, after which a server connection is terminated. Applicable
if connection proxy based site persistence is used.
type: float
maxaaausers:
description:
- Maximum number of SSL VPN users that can be logged on concurrently to the VPN virtual
server that is represented by this GSLB service. A GSLB service whose user count
reaches the maximum is not considered when a GSLB decision is made, until the count
drops below the maximum.
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
servicename:
description:
- Name for the GSLB service. 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 GSLB service is created.
- ''
- 'CLI Users: If the name includes one or more spaces, enclose the name in double
or single quotation marks (for example, "my gslbsvc" or ''my gslbsvc'').'
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:
- Type of service to create.
type: str
maxbandwidth:
description:
- Integer specifying the maximum bandwidth allowed for the service. A GSLB service
whose bandwidth reaches the maximum is not considered when a GSLB decision is made,
until its bandwidth consumption drops below the maximum.
type: float
monthreshold:
description:
- Monitoring threshold value for the GSLB service. If the sum of the weights of the
monitors that are bound to this GSLB service and are in the UP state is not equal
to or greater than this threshold value, the service is marked as DOWN.
type: float
cookietimeout:
description:
- Timeout value, in minutes, for the cookie, when cookie based site persistence is
enabled.
type: float
healthmonitor:
choices:
- 'YES'
- 'NO'
description:
- Monitor the health of the GSLB service.
type: str
naptrservices:
description:
- Service Parameters applicable to this delegation path.
type: str
downstateflush:
choices:
- ENABLED
- DISABLED
description:
- Flush all active transactions associated with the GSLB service when its state transitions
from UP to DOWN. Do not enable this option for services that must complete their
transactions. Applicable if connection proxy based site persistence is used.
type: str
naptrdomainttl:
description:
- Modify the TTL of the internally created naptr domain
type: float
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
naptrpreference:
description:
- An integer specifying the preference of this NAPTR among NAPTR records having same
order. lower the number, higher the preference.
type: float
sitepersistence:
choices:
- ConnectionProxy
- HTTPRedirect
- NONE
description:
- Use cookie-based site persistence. Applicable only to HTTP and SSL GSLB services.
type: str
monitor_name_svc:
description:
- Name of the monitor to bind to the service.
type: str
naptrreplacement:
description:
- The replacement domain name for this NAPTR.
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
gslbservice_dnsview_binding:
description: Bindings for gslbservice_dnsview_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
gslbservice_lbmonitor_binding:
description: Bindings for gslbservice_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_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