Try SpotterConfiguration for LSN pool 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 LSN pool 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
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
nattype:
choices:
- DYNAMIC
- DETERMINISTIC
description:
- 'Type of NAT IP address and port allocation (from the LSN pools bound to an LSN
group) for subscribers (of the LSN client entity bound to the LSN group):'
- ''
- 'Available options function as follows:'
- ''
- '* Deterministic - Allocate a NAT IP address and a block of ports to each subscriber
(of the LSN client bound to the LSN group). The Citrix ADC sequentially allocates
NAT resources to these subscribers. The Citrix ADC ADC assigns the first block of
ports (block size determined by the port block size parameter of the LSN group)
on the beginning NAT IP address to the beginning subscriber IP address. The next
range of ports is assigned to the next subscriber, and so on, until the NAT address
does not have enough ports for the next subscriber. In this case, the first port
block on the next NAT address is used for the subscriber, and so on. Because each
subscriber now receives a deterministic NAT IP address and a block of ports, a subscriber
can be identified without any need for logging. For a connection, a subscriber can
be identified based only on the NAT IP address and port, and the destination IP
address and port.'
- ' '
- '* Dynamic - Allocate a random NAT IP address and a port from the LSN NAT pool for
a subscriber''s connection. If port block allocation is enabled (in LSN pool) and
a port block size is specified (in the LSN group), the Citrix ADC allocates a random
NAT IP address and a block of ports for a subscriber when it initiates a connection
for the first time. The ADC allocates this NAT IP address and a port (from the allocated
block of ports) for different connections from this subscriber. If all the ports
are allocated (for different subscriber''s connections) from the subscriber''s allocated
port block, the ADC allocates a new random port block for the subscriber.'
- Only LSN Pools and LSN groups with the same NAT type settings can be bound together.
Multiples LSN pools can be bound to an LSN group. A maximum of 16 LSN pools can
be bound to an LSN 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
poolname:
description:
- 'Name for the LSN pool. 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. Cannot be
changed after the LSN pool is created. The following requirement applies only to
the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in
double or single quotation marks (for example, "lsn pool1" or ''lsn pool1'').'
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
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
nitro_auth_token:
description:
- The authentication token provided by a login operation.
type: str
version_added: 2.6.0
version_added_collection: netscaler.adc
maxportrealloctmq:
description:
- Maximum number of ports for which the port reallocation timeout applies for each
NAT IP address. In other words, the maximum deallocated-port queue size for which
the reallocation timeout applies for each NAT IP address.
- ''
- When the queue size is full, the next port deallocated is reallocated immediately
for a new LSN session.
type: float
portrealloctimeout:
description:
- 'The waiting time, in seconds, between deallocating LSN NAT ports (when an LSN mapping
is removed) and reallocating them for a new LSN session. This parameter is necessary
in order to prevent collisions between old and new mappings and sessions. It ensures
that all established sessions are broken instead of redirected to a different subscriber.
This is not applicable for ports used in:'
- '* Deterministic NAT'
- '* Address-Dependent filtering and Address-Port-Dependent filtering'
- '* Dynamic NAT with port block allocation'
- In these cases, ports are immediately reallocated.
type: float
portblockallocation:
choices:
- ENABLED
- DISABLED
description:
- Allocate a random NAT port block, from the available NAT port pool of an NAT IP
address, for each subscriber when the NAT allocation is set as Dynamic NAT. For
any connection initiated from a subscriber, the Citrix ADC allocates a NAT port
from the subscriber's allocated NAT port block to create the LSN session.
- ''
- You must set the port block size in the bound LSN group. For a subscriber, if all
the ports are allocated from the subscriber's allocated port block, the Citrix ADC
allocates a new random port block for the subscriber.
- ''
- For Deterministic NAT, this parameter is enabled by default, and you cannot disable
it.
type: str
lsnpool_lsnip_binding:
description: Bindings for lsnpool_lsnip_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