Try SpotterConfiguration for LSN 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 LSN group resource.
ftp:
choices:
- ENABLED
- DISABLED
description:
- 'Enable Application Layer Gateway (ALG) for the FTP protocol. For some application-layer
protocols, the IP addresses and protocol port numbers are usually communicated in
the packet''s payload. When acting as an ALG, the Citrix ADC changes the packet''s
payload to ensure that the protocol continues to work over LSN. '
- ''
- 'Note: The Citrix ADC also includes ALG for ICMP and TFTP protocols. ALG for the
ICMP protocol is enabled by default, and there is no provision to disable it. ALG
for the TFTP protocol is disabled by default. ALG is enabled automatically for an
LSN group when you bind a UDP LSN application profile, with endpoint-independent-mapping,
endpoint-independent filtering, and destination port as 69 (well-known port for
TFTP), to the LSN 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
pptp:
choices:
- ENABLED
- DISABLED
description:
- Enable the PPTP Application Layer Gateway.
type: str
ftpcm:
choices:
- ENABLED
- DISABLED
description:
- Enable the FTP connection mirroring for specified LSN group. Connection mirroring
(CM or connection failover) refers to keeping active an established TCP or UDP connection
when a failover occurs.
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
sipalg:
choices:
- ENABLED
- DISABLED
description:
- Enable the SIP ALG.
type: str
logging:
choices:
- ENABLED
- DISABLED
description:
- Log mapping entries and sessions created or deleted for this LSN group. The Citrix
ADC logs LSN sessions for this LSN group only when both logging and session logging
parameters are enabled.
- ''
- 'The ADC uses its existing syslog and audit log framework to log LSN information.
You must enable global level LSN logging by enabling the LSN parameter in the related
NSLOG action and SYLOG action entities. When the Logging parameter is enabled, the
Citrix ADC generates log messages related to LSN mappings and LSN sessions of this
LSN group. The ADC then sends these log messages to servers associated with the
NSLOG action and SYSLOG actions entities. '
- ''
- 'A log message for an LSN mapping entry consists of the following information:'
- '* NSIP address of the Citrix ADC'
- '* Time stamp'
- '* Entry type (MAPPING or SESSION)'
- '* Whether the LSN mapping entry is created or deleted'
- '* Subscriber''s IP address, port, and traffic domain ID'
- '* NAT IP address and port'
- '* Protocol name'
- '* Destination IP address, port, and traffic domain ID might be present, depending
on the following conditions:'
- '** Destination IP address and port are not logged for Endpoint-Independent mapping'
- '** Only Destination IP address (and not port) is logged for Address-Dependent mapping'
- '** Destination IP address and port are logged for Address-Port-Dependent mapping'
type: str
nattype:
choices:
- DYNAMIC
- DETERMINISTIC
description:
- 'Type of NAT IP address and port allocation (from the bound LSN pools) for subscribers:'
- ''
- '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. The maximum number of LSN subscribers allowed, globally, is 1
million. '
- ''
- '* 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.'
type: str
rtspalg:
choices:
- ENABLED
- DISABLED
description:
- Enable the RTSP ALG.
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
groupname:
description:
- 'Name for the LSN group. 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 group 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 group1" or ''lsn group1'').'
type: str
clientname:
description:
- Name of the LSN client entity to be associated with the LSN group. You can associate
only one LSN client entity with an LSN group.You cannot remove this association
or replace with another LSN client entity once the LSN group is created.
type: str
ip6profile:
description:
- Name of the LSN ip6 profile to associate with the specified LSN group. An ip6 profile
can be associated with a group only during group creation.
- ''
- By default, no LSN ip6 profile is associated with an LSN group during its creation.
Only one ip6profile can be associated with a group.
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
allocpolicy:
choices:
- PORTS
- IPADDRS
description:
- NAT IP and PORT block allocation policy for Deterministic NAT. Supported Policies
are,
- '1: C(PORTS): Port blocks from single NATIP will be allocated to LSN subscribers
sequentially. After all blocks are exhausted, port blocks from next NATIP will be
allocated and so on.'
- '2: C(IPADDRS)(Default): One port block from each NATIP will be allocated and once
all the NATIPs are over second port block from each NATIP will be allocated and
so on.'
- To understand better if we assume port blocks of all NAT IPs as two dimensional
array, C(PORTS) policy follows "row major order" and C(IPADDRS) policy follows "column
major order" while allocating port blocks.
- 'Example:'
- 'Client IPs: 2.2.2.1, 2.2.2.2 and 2.2.2.3'
- 'NAT IPs and PORT Blocks: '
- 4.4.4.1:PB1, PB2, PB3,., PBn
- '4.4.4.2: PB1, PB2, PB3,., PBn'
- 'C(PORTS) Policy: '
- 2.2.2.1 => 4.4.4.1:PB1
- 2.2.2.2 => 4.4.4.1:PB2
- 2.2.2.3 => 4.4.4.1:PB3
- 'C(IPADDRS) Policy:'
- 2.2.2.1 => 4.4.4.1:PB1
- 2.2.2.2 => 4.4.4.2:PB1
- 2.2.2.3 => 4.4.4.1:PB2
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
sessionsync:
choices:
- ENABLED
- DISABLED
description:
- In a high availability (HA) deployment, synchronize information of all LSN sessions
related to this LSN group with the secondary node. After a failover, established
TCP connections and UDP packet flows are kept active and resumed on the secondary
node (new primary).
- ''
- For this setting to work, you must enable the global session synchronization parameter.
type: str
portblocksize:
description:
- Size of the NAT port block to be allocated for each subscriber.
- ''
- To set this parameter for Dynamic NAT, you must enable the port block allocation
parameter in the bound LSN pool. For Deterministic NAT, the port block allocation
parameter is always enabled, and you cannot disable it.
- ''
- In Dynamic NAT, the Citrix ADC allocates a random NAT port block, from the available
NAT port pool of an NAT IP address, for each subscriber. For a subscriber, if all
the ports are allocated from the subscriber's allocated port block, the ADC allocates
a new random port block for the subscriber.
- ''
- The default port block size is 256 for Deterministic NAT, and 0 for Dynamic NAT.
type: float
snmptraplimit:
description:
- Maximum number of SNMP Trap messages that can be generated for the LSN group in
one minute.
type: float
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
type: str
sessionlogging:
choices:
- ENABLED
- DISABLED
description:
- Log sessions created or deleted for the LSN group. The Citrix ADC logs LSN sessions
for this LSN group only when both logging and session logging parameters are enabled.
- ''
- 'A log message for an LSN session consists of the following information:'
- '* NSIP address of the Citrix ADC'
- '* Time stamp'
- '* Entry type (MAPPING or SESSION)'
- '* Whether the LSN session is created or removed'
- '* Subscriber''s IP address, port, and traffic domain ID'
- '* NAT IP address and port'
- '* Protocol name'
- '* Destination IP address, port, and traffic domain ID'
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
lsngroup_lsnpool_binding:
description: Bindings for lsngroup_lsnpool_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
lsngroup_pcpserver_binding:
description: Bindings for lsngroup_pcpserver_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
lsngroup_lsnlogprofile_binding:
description: Bindings for lsngroup_lsnlogprofile_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
lsngroup_lsnappsprofile_binding:
description: Bindings for lsngroup_lsnappsprofile_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
lsngroup_ipsecalgprofile_binding:
description: Bindings for lsngroup_ipsecalgprofile_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
lsngroup_lsnsipalgprofile_binding:
description: Bindings for lsngroup_lsnsipalgprofile_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
lsngroup_lsnrtspalgprofile_binding:
description: Bindings for lsngroup_lsnrtspalgprofile_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
lsngroup_lsntransportprofile_binding:
description: Bindings for lsngroup_lsntransportprofile_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
lsngroup_lsnhttphdrlogprofile_binding:
description: Bindings for lsngroup_lsnhttphdrlogprofile_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