Try SpotterConfiguration for LSN Application 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 Application Profile resource.
td:
description:
- 'ID of the traffic domain through which the Citrix ADC sends the outbound traffic
after performing LSN. '
- ''
- If you do not specify an ID, the ADC sends the outbound traffic through the default
traffic domain, which has an ID of 0.
type: float
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
l2info:
choices:
- ENABLED
- DISABLED
description:
- Enable l2info by creating natpcbs for LSN, which enables the Citrix ADC to use L2CONN/MBF
with LSN.
type: str
mapping:
choices:
- ENDPOINT-INDEPENDENT
- ADDRESS-DEPENDENT
- ADDRESS-PORT-DEPENDENT
description:
- Type of LSN mapping to apply to subsequent packets originating from the same subscriber
IP address and port.
- ''
- Consider an example of an LSN mapping that includes the mapping of the subscriber
IP:port (X:x), NAT IP:port (N:n), and external host IP:port (Y:y).
- ''
- 'Available options function as follows: '
- ''
- '* C(ENDPOINT-INDEPENDENT) - Reuse the LSN mapping for subsequent packets sent from
the same subscriber IP address and port (X:x) to any external IP address and port. '
- ''
- '* C(ADDRESS-DEPENDENT) - Reuse the LSN mapping for subsequent packets sent from
the same subscriber IP address and port (X:x) to the same external IP address (Y),
regardless of the external port.'
- ''
- '* C(ADDRESS-PORT-DEPENDENT) - Reuse the LSN mapping for subsequent packets sent
from the same internal IP address and port (X:x) to the same external IP address
and port (Y:y) while the mapping is still active.'
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
tcpproxy:
choices:
- ENABLED
- DISABLED
description:
- Enable TCP proxy, which enables the Citrix ADC to optimize the TCP traffic by using
Layer 4 features.
type: str
filtering:
choices:
- ENDPOINT-INDEPENDENT
- ADDRESS-DEPENDENT
- ADDRESS-PORT-DEPENDENT
description:
- Type of filter to apply to packets originating from external hosts.
- ''
- Consider an example of an LSN mapping that includes the mapping of subscriber IP:port
(X:x), NAT IP:port (N:n), and external host IP:port (Y:y).
- ''
- 'Available options function as follows:'
- '* ENDPOINT INDEPENDENT - Filters out only packets not destined to the subscriber
IP address and port X:x, regardless of the external host IP address and port source
(Z:z). The Citrix ADC forwards any packets destined to X:x. In other words, sending
packets from the subscriber to any external IP address is sufficient to allow packets
from any external hosts to the subscriber.'
- ''
- '* ADDRESS DEPENDENT - Filters out packets not destined to subscriber IP address
and port X:x. In addition, the ADC filters out packets from Y:y destined for the
subscriber (X:x) if the client has not previously sent packets to Y:anyport (external
port independent). In other words, receiving packets from a specific external host
requires that the subscriber first send packets to that specific external host''s
IP address.'
- ''
- '* ADDRESS PORT DEPENDENT (the default) - Filters out packets not destined to subscriber
IP address and port (X:x). In addition, the Citrix ADC filters out packets from
Y:y destined for the subscriber (X:x) if the subscriber has not previously sent
packets to Y:y. In other words, receiving packets from a specific external host
requires that the subscriber first send packets first to that external IP address
and port.'
type: str
ippooling:
choices:
- PAIRED
- RANDOM
description:
- NAT IP address allocation options for sessions associated with the same subscriber.
- ''
- 'Available options function as follows:'
- '* Paired - The Citrix ADC allocates the same NAT IP address for all sessions associated
with the same subscriber. When all the ports of a NAT IP address are used in LSN
sessions (for same or multiple subscribers), the Citrix ADC ADC drops any new connection
from the subscriber.'
- '* Random - The Citrix ADC allocates random NAT IP addresses, from the pool, for
different sessions associated with the same subscriber.'
- ''
- This parameter is applicable to dynamic NAT allocation only.
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
appsprofilename:
description:
- 'Name for the LSN application 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 application 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 application profile1"
or ''lsn application profile1'').'
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
transportprotocol:
choices:
- TCP
- UDP
- ICMP
description:
- Name of the protocol for which the parameters of this LSN application profile applies.
type: str
lsnappsprofile_port_binding:
description: Bindings for lsnappsprofile_port_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
lsnappsprofile_lsnappsattributes_binding:
description: Bindings for lsnappsprofile_lsnappsattributes_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