Try SpotterConfiguration for LB profile 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 profile resource.
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
dbslb:
choices:
- ENABLED
- DISABLED
description:
- Enable database specific load balancing for MySQL and MSSQL service types.
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
api_path:
default: nitro/v1/config
description:
- Base NITRO API path.
- Define only in case of an ADM service proxy call
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
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
processlocal:
choices:
- ENABLED
- DISABLED
description:
- By turning on this option packets destined to a vserver in a cluster will not under
go any steering. Turn this option for single pa
- cket request response mode or when the upstream device is performing a proper RSS
for connection based distribution.
type: str
lbhashfingers:
description:
- This option is used to specify the number of fingers to be used in PRAC and JARH
algorithms for hash based LB methods. Increasing the number of fingers might give
better distribution of traffic at the expense of additional memory.
type: float
lbprofilename:
description:
- Name of the LB profile.
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
lbhashalgorithm:
choices:
- DEFAULT
- PRAC
- JARH
description:
- This option dictates the hashing algorithm used for hash based LB methods (URLHASH,
DOMAINHASH, SOURCEIPHASH, DESTINATIONIPHASH, SRCIPDESTIPHASH, SRCIPSRCPORTHASH,
TOKEN, USER_TOKEN, CALLIDHASH).
type: str
cookiepassphrase:
description:
- Use this parameter to specify the passphrase used to generate secured persistence
cookie value. It specifies the passphrase with a maximum of 31 characters.
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
httponlycookieflag:
choices:
- ENABLED
- DISABLED
description:
- Include the HttpOnly attribute in persistence cookies. The HttpOnly attribute limits
the scope of a cookie to HTTP requests and helps mitigate the risk of cross-site
scripting attacks.
type: str
literaladccookieattribute:
description:
- 'String configured as LiteralADCCookieAttribute will be appended as attribute for
Citrix ADC cookie (for example: LB cookie persistence , GSLB site persistence, CS
cookie persistence, LB group cookie persistence).'
- ''
- Sample usage -
- ' add lb profile lbprof -LiteralADCCookieAttribute ";SameSite=None"'
type: str
computedadccookieattribute:
description:
- 'ComputedADCCookieAttribute accepts ns variable as input in form of string starting
with $ (to understand how to configure ns variable, please check man add ns variable).
policies can be configured to modify this variable for every transaction and the
final value of the variable after policy evaluation will be appended as attribute
to Citrix ADC cookie (for example: LB cookie persistence , GSLB sitepersistence,
CS cookie persistence, LB group cookie persistence). Only one of ComputedADCCookieAttribute,
LiteralADCCookieAttribute can be set.'
- ''
- Sample usage -
- ' add ns variable lbvar -type TEXT(100) -scope Transaction'
- ' add ns assignment lbassign -variable $lbvar -set "\\";SameSite=Strict\\""'
- ' add rewrite policy lbpol <valid policy expression> lbassign'
- ' bind rewrite global lbpol 100 next -type RES_OVERRIDE'
- ' add lb profile lbprof -ComputedADCCookieAttribute "$lbvar"'
- ' For incoming client request, if above policy evaluates TRUE, then
SameSite=Strict will be appended to ADC generated cookie'
type: str
usesecuredpersistencecookie:
choices:
- ENABLED
- DISABLED
description:
- Encode persistence cookie values using SHA2 hash.
type: str
storemqttclientidandusername:
choices:
- 'YES'
- 'NO'
description:
- This option allows to store the MQTT clientid and username in transactional logs
type: str
useencryptedpersistencecookie:
choices:
- ENABLED
- DISABLED
description:
- Encode persistence cookie values using SHA2 hash.
type: str
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