netscaler.adc.servicegroup module – Configuration for service group resource.

Note

This module is part of the netscaler.adc collection (version 2.6.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netscaler.adc.

To use it in a playbook, specify: netscaler.adc.servicegroup.

New in netscaler.adc 2.0.0

Synopsis

  • Configuration for service group resource.

Parameters

Parameter

Comments

api_path

string

Base NITRO API path.

Define only in case of an ADM service proxy call

Default: "nitro/v1/config"

appflowlog

any

Enable logging of AppFlow information for the specified service group.

Choices:

  • "ENABLED"

  • "DISABLED"

autodelayedtrofs

any

Indicates graceful movement of IP-Port binding/s to TROFS when IP addresses are removed from DNS response. System will wait for monitor response timeout period before moving to TROFS .

Choices:

  • "YES"

  • "NO"

autodisabledelay

any

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.

autodisablegraceful

any

Indicates graceful shutdown of the service. System will wait for all outstanding connections to this service to be closed before disabling the service.

Choices:

  • "YES"

  • "NO"

autoscale

string

Auto scale option for a servicegroup

Choices:

  • "DISABLED"

  • "DNS"

  • "POLICY"

  • "CLOUD"

  • "API"

cacheable

any

Use the transparent cache redirection virtual server to forward the request to the cache server.

Note: Do not set this parameter if you set the Cache Type.

Choices:

  • "YES"

  • "NO"

cachetype

string

Cache type supported by the cache server.

Choices:

  • "TRANSPARENT"

  • "REVERSE"

  • "FORWARD"

cip

any

Insert the Client IP header in requests forwarded to the service.

Choices:

  • "ENABLED"

  • "DISABLED"

cipheader

any

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.

cka

any

Enable client keep-alive for the service group.

Choices:

  • "YES"

  • "NO"

clttimeout

any

Time, in seconds, after which to terminate an idle client connection.

cmp

any

Enable compression for the specified service.

Choices:

  • "YES"

  • "NO"

comment

any

Any information about the service group.

customserverid

any

The identifier for this IP:Port pair. Used when the persistency type is set to Custom Server ID.

dbsttl

any

Specify the TTL for DNS record for domain based service.The default value of ttl is 0 which indicates to use the TTL received in DNS response for monitors

delay

float

Time, in seconds, allocated for a shutdown of the services in the service group. During this period, new requests are sent to the service only for clients who already have persistent sessions on the appliance. Requests from new clients are load balanced among other available services. After the delay time expires, no requests are sent to the service, and the service is marked as unavailable (OUT OF SERVICE).

downstateflush

any

Flush all active transactions associated with all the services in the service group whose state transitions from UP to DOWN. Do not enable this option for applications that must complete their transactions.

Choices:

  • "ENABLED"

  • "DISABLED"

dup_weight

any

weight of the monitor that is bound to servicegroup.

graceful

string

Wait for all existing connections to the service to terminate before shutting down the service.

Choices:

  • "YES"

  • "NO"

hashid

any

The hash identifier for the service. This must be unique for each service. This parameter is used by hash based load balancing methods.

healthmonitor

any

Monitor the health of this service. Available settings function as follows:

YES - Send probes to check the health of the service.

NO - Do not send probes to check the health of the service. With the NO option, the appliance shows the service as UP at all times.

Choices:

  • "YES"

  • "NO"

httpprofilename

any

Name of the HTTP profile that contains HTTP configuration settings for the service group.

includemembers

boolean

Display the members of the listed 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.

Choices:

  • false

  • true

managed_netscaler_instance_id

string

added in netscaler.adc 2.6.0

The ID of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_ip

string

added in netscaler.adc 2.6.0

The IP of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_name

string

added in netscaler.adc 2.6.0

The name of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_password

string

added in netscaler.adc 2.6.0

The password of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

managed_netscaler_instance_username

string

added in netscaler.adc 2.6.0

The username of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

maxbandwidth

any

Maximum bandwidth, in Kbps, allocated for all the services in the service group.

maxclient

any

Maximum number of simultaneous open connections for the service group.

maxreq

any

Maximum number of requests that can be sent on a persistent connection to the service group.

Note: Connection requests beyond this value are rejected.

memberport

integer

member port

monconnectionclose

any

Close monitoring connections by sending the service a connection termination message with the specified bit set.

Choices:

  • "RESET"

  • "FIN"

monitor_name_svc

any

Name of the monitor bound to the service group. Used to assign a weight to the monitor.

monthreshold

any

Minimum sum of weights of the monitors that are bound to this service. Used to determine whether to mark a service as UP or DOWN.

nameserver

any

Specify the nameserver to which the query for bound domain needs to be sent. If not specified, use the global nameserver

netprofile

any

Network profile for the service group.

netscaler_console_as_proxy_server

boolean

added in netscaler.adc 2.6.0

The IP address of the NetScaler ADC appliance acting as a proxy server.

Define only in case of an ADM service proxy call

Choices:

  • false ← (default)

  • true

newname

string

New name for the service group.

nitro_auth_token

string

The authentication token provided by a login operation.

nitro_pass

string

The password with which to authenticate to the NetScaler ADC node.

nitro_protocol

string

Which protocol to use when accessing the nitro API objects.

Choices:

  • "http"

  • "https" ← (default)

nitro_user

string

The username with which to authenticate to the NetScaler ADC node.

nsip

string / required

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.

order

any

Order number to be assigned to the servicegroup member

pathmonitor

any

Path monitoring for clustering

Choices:

  • "YES"

  • "NO"

pathmonitorindv

any

Individual Path monitoring decisions.

Choices:

  • "YES"

  • "NO"

port

any

Server port number.

rtspsessionidremap

any

Enable RTSP session ID mapping for the service group.

Choices:

  • "ON"

  • "OFF"

save_config

boolean

If 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.

Choices:

  • false ← (default)

  • true

serverid

float

The identifier for the service. This is used when the persistency type is set to Custom Server ID.

servername

any

Name of the server to which to bind the service group.

servicegroup_lbmonitor_binding

dictionary

Bindings for servicegroup_lbmonitor_binding resource

binding_members

list / elements=dictionary

List of binding members

Default: []

mode

string

The mode in which to configure the bindings.

If mode is set to 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 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 unbind, the specified bindings will be removed from the resource. The existing bindings in the target ADCs will not be modified.

Choices:

  • "desired" ← (default)

  • "bind"

  • "unbind"

servicegroup_servicegroupmember_binding

dictionary

Bindings for servicegroup_servicegroupmember_binding resource

binding_members

list / elements=dictionary

List of binding members

Default: []

mode

string

The mode in which to configure the bindings.

If mode is set to 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 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 unbind, the specified bindings will be removed from the resource. The existing bindings in the target ADCs will not be modified.

Choices:

  • "desired" ← (default)

  • "bind"

  • "unbind"

servicegroupname

any

Name of the 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.

servicetype

string

Protocol used to exchange data with the service.

Choices:

  • "HTTP"

  • "FTP"

  • "TCP"

  • "UDP"

  • "SSL"

  • "SSL_BRIDGE"

  • "SSL_TCP"

  • "DTLS"

  • "NNTP"

  • "RPCSVR"

  • "DNS"

  • "ADNS"

  • "SNMP"

  • "RTSP"

  • "DHCPRA"

  • "ANY"

  • "SIP_UDP"

  • "SIP_TCP"

  • "SIP_SSL"

  • "DNS_TCP"

  • "ADNS_TCP"

  • "MYSQL"

  • "MSSQL"

  • "ORACLE"

  • "MONGO"

  • "MONGO_TLS"

  • "RADIUS"

  • "RADIUSListener"

  • "RDP"

  • "DIAMETER"

  • "SSL_DIAMETER"

  • "TFTP"

  • "SMPP"

  • "PPTP"

  • "GRE"

  • "SYSLOGTCP"

  • "SYSLOGUDP"

  • "FIX"

  • "SSL_FIX"

  • "USER_TCP"

  • "USER_SSL_TCP"

  • "QUIC"

  • "IPFIX"

  • "LOGSTREAM"

  • "LOGSTREAM_SSL"

  • "MQTT"

  • "MQTT_TLS"

  • "QUIC_BRIDGE"

sp

any

Enable surge protection for the service group.

Choices:

  • "ON"

  • "OFF"

state

string

The state of the resource being configured by the module on the NetScaler ADC node.

When present, the resource will be added/updated configured according to the module’s parameters.

When absent, the resource will be deleted from the NetScaler ADC node.

When enabled, the resource will be enabled on the NetScaler ADC node.

When disabled, the resource will be disabled on the NetScaler ADC node.

When unset, the resource will be unset on the NetScaler ADC node.

Choices:

  • "present" ← (default)

  • "absent"

  • "enabled"

  • "disabled"

  • "unset"

svrtimeout

any

Time, in seconds, after which to terminate an idle server connection.

tcpb

any

Enable TCP buffering for the service group.

Choices:

  • "YES"

  • "NO"

tcpprofilename

any

Name of the TCP profile that contains TCP configuration settings for the service group.

td

float

Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0.

useproxyport

any

Use the proxy port as the source port when initiating connections with the server. With the NO setting, the client-side connection port is used as the source port for the server-side connection.

Note: This parameter is available only when the Use Source IP (USIP) parameter is set to YES.

Choices:

  • "YES"

  • "NO"

usip

any

Use client’s IP address as the source IP address when initiating connection to the server. With the NO setting, which is the default, a mapped IP (MIP) address or subnet IP (SNIP) address is used as the source IP address to initiate server side connections.

Choices:

  • "YES"

  • "NO"

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

weight

any

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.

Notes

Note

Examples

---
- name: Sample Playbook
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Setup servers
      delegate_to: localhost
      netscaler.adc.server:
        state: present
        name: foo.example.com
        domain: foo.example.com
    - name: Setup servicegroups
      delegate_to: localhost
      tags: test
      netscaler.adc.servicegroup:
        state: absent
        servicegroupname: test1-1
        servicetype: TCP
        autoscale: DNS
        healthmonitor: "YES"
        servicegroup_servicegroupmember_binding:
          binding_members:
            - servername: foo.example.com
              port: 443
              servicegroupname: test1-1

Return Values

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

Key

Description

changed

boolean

Indicates if any change is made by the module

Returned: always

Sample: true

diff

dictionary

Dictionary of before and after changes

Returned: always

Sample: {"after": {"key2": "pqr"}, "before": {"key1": "xyz"}, "prepared": "changes done"}

diff_list

list / elements=string

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"]

failed

boolean

Indicates if the module failed or not

Returned: always

Sample: false

loglines

list / elements=string

list of logged messages by the module

Returned: always

Sample: ["message 1", "message 2"]

Authors

  • Sumanth Lingappa (@sumanth-lingappa)