Try SpotterConfiguration for LSN Transport 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 LSN Transport 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
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
syncheck:
choices:
- ENABLED
- DISABLED
description:
- 'Silently drop any non-SYN packets for connections for which there is no LSN-NAT
session present on the Citrix ADC. '
- ''
- 'If you disable this parameter, the Citrix ADC accepts any non-SYN packets and creates
a new LSN session entry for this connection. '
- ''
- 'Following are some reasons for the Citrix ADC to receive such packets:'
- ''
- '* LSN session for a connection existed but the Citrix ADC removed this session
because the LSN session was idle for a time that exceeded the configured session
timeout.'
- '* Such packets can be a part of a DoS attack.'
type: str
portquota:
description:
- Maximum number of LSN NAT ports to be used at a time by each subscriber for the
specified protocol. For example, each subscriber can be limited to a maximum of
500 TCP NAT ports. When the LSN NAT mappings for a subscriber reach the limit, the
Citrix ADC does not allocate additional NAT ports for that subscriber.
type: float
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
stuntimeout:
description:
- STUN protocol timeout
type: float
sessionquota:
description:
- 'Maximum number of concurrent LSN sessions allowed for each subscriber for the specified
protocol. '
- When the number of LSN sessions reaches the limit for a subscriber, the Citrix ADC
does not allow the subscriber to open additional sessions.
type: float
finrsttimeout:
description:
- Timeout, in seconds, for a TCP LSN session after a FIN or RST message is received
from one of the endpoints.
- ''
- If a TCP LSN session is idle (after the Citrix ADC receives a FIN or RST message)
for a time that exceeds this value, the Citrix ADC ADC removes the session.
- ''
- Since the LSN feature of the Citrix ADC does not maintain state information of any
TCP LSN sessions, this timeout accommodates the transmission of the FIN or RST,
and ACK messages from the other endpoint so that both endpoints can properly close
the connection.
type: float
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
type: str
sessiontimeout:
description:
- Timeout, in seconds, for an idle LSN session. If an LSN session is idle for a time
that exceeds this value, the Citrix ADC removes the session.
- ''
- This timeout does not apply for a TCP LSN session when a FIN or RST message is received
from either of the endpoints.
type: float
synidletimeout:
description:
- SYN Idle timeout
type: float
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
groupsessionlimit:
description:
- Maximum number of concurrent LSN sessions(for the specified protocol) allowed for
all subscriber of a group to which this profile has bound. This limit will get split
across the Citrix ADCs packet engines and rounded down. When the number of LSN sessions
reaches the limit for a group in packet engine, the Citrix ADC does not allow the
subscriber of that group to open additional sessions through that packet engine.
type: float
portpreserverange:
choices:
- ENABLED
- DISABLED
description:
- If a subscriber initiates a connection from a well-known port (0-1023), allocate
a NAT port from the well-known port range (0-1023) for this connection. For example,
if a subscriber initiates a connection from port 80, the Citrix ADC can allocate
port 100 as the NAT port for this connection.
- ''
- This parameter applies to dynamic NAT without port block allocation. It also applies
to Deterministic NAT if the range of ports allocated includes well-known ports.
- ''
- When all the well-known ports of all the available NAT IP addresses are used in
different subscriber's connections (LSN sessions), and a subscriber initiates a
connection from a well-known port, the Citrix ADC drops this connection.
type: str
transportprotocol:
choices:
- TCP
- UDP
- ICMP
description:
- Protocol for which to set the LSN transport profile parameters.
type: str
portpreserveparity:
choices:
- ENABLED
- DISABLED
description:
- 'Enable port parity between a subscriber port and its mapped LSN NAT port. For example,
if a subscriber initiates a connection from an odd numbered port, the Citrix ADC
allocates an odd numbered LSN NAT port for this connection. '
- You must set this parameter for proper functioning of protocols that require the
source port to be even or odd numbered, for example, in peer-to-peer applications
that use RTP or RTCP protocol.
type: str
transportprofilename:
description:
- 'Name for the LSN transport profile. 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 transport profile 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 transport profile1"
or ''lsn transport profile1'').'
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