Try SpotterConfiguration for RNAT configured route 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 RNAT configured route resource.
td:
description:
- Integer value that uniquely identifies the traffic domain in which you want to configure
the entity. If you do not specify an ID, the entity becomes part of the default
traffic domain, which has an ID of 0.
type: float
name:
description:
- Name for the RNAT4 rule. Must begin with a letter, number, or the underscore character
(_), and can consist of letters, numbers, and the hyphen (-), period (.) pound (#),
space ( ), at sign (@), equals (=), colon (:), and underscore characters. Cannot
be changed after the rule is created. Choose a name that helps identify the RNAT4
rule.
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
natip:
description:
- Any NetScaler-owned IPv4 address except the NSIP address. The NetScaler appliance
replaces the source IP addresses of server-generated packets with the IP address
specified. The IP address must be a public NetScaler-owned IP address. If you specify
multiple addresses for this field, NATIP selection uses the round robin algorithm
for each session. By specifying a range of IP addresses, you can specify all NetScaler-owned
IP addresses, except the NSIP, that fall within the specified range.
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
aclname:
description:
- An extended ACL defined for the RNAT entry.
type: str
netmask:
description:
- The subnet mask for the network address.
type: str
network:
description:
- The network address defined for the RNAT entry.
type: str
newname:
description:
- New name for the RNAT4 rule. Must begin with an ASCII alphabetic or underscore (_)
character, and must contain only ASCII alphanumeric, underscore, hash (#),
period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.
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
ownergroup:
description:
- The owner node group in a Cluster for this rnat rule.
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
connfailover:
choices:
- ENABLED
- DISABLED
description:
- Synchronize all connection-related information for the RNAT sessions with the secondary
ADC in a high availability (HA) pair.
type: str
redirectport:
description:
- Port number to which the IPv4 packets are redirected. Applicable to TCP and UDP
protocols.
type: int
useproxyport:
choices:
- ENABLED
- DISABLED
description:
- Enable source port proxying, which enables the Citrix ADC to use the RNAT ips using
proxied source port.
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
nitro_auth_token:
description:
- The authentication token provided by a login operation.
type: str
version_added: 2.6.0
version_added_collection: netscaler.adc
srcippersistency:
choices:
- ENABLED
- DISABLED
description:
- Enables the Citrix ADC to use the same NAT IP address for all RNAT sessions initiated
from a particular server.
type: str
rnat_nsip_binding:
description: Bindings for rnat_nsip_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
rnat6_nsip6_binding:
description: Bindings for rnat6_nsip6_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
rnat_retainsourceportset_binding:
description: Bindings for rnat_retainsourceportset_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
rnatglobal_auditsyslogpolicy_binding:
description: Bindings for rnatglobal_auditsyslogpolicy_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