Try SpotterConfiguration for LB 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 LB group resource.
name:
description:
- Name of the load balancing virtual server group.
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.
- ''
- '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
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
newname:
description:
- New name for the load balancing virtual server group.
type: str
timeout:
description:
- Time period for which a persistence session is in effect.
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
cookiename:
description:
- Use this parameter to specify the cookie name for COOKIE peristence type. It specifies
the name of cookie with a maximum of 32 characters. If not specified, cookie name
is internally generated.
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:
- Persistence mask to apply to source IPv4 addresses when creating source IP based
persistence sessions.
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
cookiedomain:
description:
- Domain attribute for the HTTP cookie.
type: str
mastervserver:
description:
- When USE_VSERVER_PERSISTENCE is enabled, one can use this setting to designate a
member vserver as master which is responsible to create the persistence sessions
type: str
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
persistencetype:
choices:
- SOURCEIP
- COOKIEINSERT
- RULE
- NONE
description:
- 'Type of persistence for the group. Available settings function as follows:'
- '* C(SOURCEIP) - Create persistence sessions based on the client IP.'
- '* C(COOKIEINSERT) - Create persistence sessions based on a cookie in client requests.
The cookie is inserted by a Set-Cookie directive from the server, in its first response
to a client.'
- '* C(RULE) - Create persistence sessions based on a user defined rule.'
- '* C(NONE) - Disable persistence for the group.'
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
v6persistmasklen:
description:
- Persistence mask to apply to source IPv6 addresses when creating source IP based
persistence sessions.
type: float
persistencebackup:
choices:
- SOURCEIP
- NONE
description:
- Type of backup persistence for the group.
type: str
usevserverpersistency:
choices:
- ENABLED
- DISABLED
description:
- Use this parameter to enable vserver level persistence on group members. This allows
member vservers to have their own persistence, but need to be compatible with other
members persistence rules. When this setting is enabled persistence sessions created
by any of the members can be shared by other member vservers.
type: str
backuppersistencetimeout:
description:
- Time period, in minutes, for which backup persistence is in effect.
type: float
lbgroup_lbvserver_binding:
description: Bindings for lbgroup_lbvserver_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