netscaler.adc.inat (2.5.1) — module

Install collection

Install with ansible-galaxy collection install netscaler.adc:==2.5.1

Add to requirements.yml

  collections:
    - name: netscaler.adc
      version: 2.5.1

Description

Configuration for inbound nat resource.

Inputs

    
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

ftp:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable the FTP protocol on the server for transferring files between the client
      and the server.
    type: str

mode:
    choices:
    - STATELESS
    description:
    - Stateless translation.
    type: str

name:
    description:
    - 'Name for the Inbound NAT (INAT) entry. Leading character must be a number or letter.
      Other characters allowed, after the first character, are @ _ - . (period) : (colon)
      # and space ( ).'
    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

tftp:
    choices:
    - ENABLED
    - DISABLED
    description:
    - To enable/disable TFTP (Default C(DISABLED)).
    type: str

usip:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Enable the Citrix ADC to retain the source IP address of packets before sending
      the packets to the server.
    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

usnip:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Enable the Citrix ADC to use a SNIP address as the source IP address of packets
      before sending the packets to the server.
    type: str

proxyip:
    description:
    - Unique IP address used as the source IP address in packets sent to the server. Must
      be a MIP or SNIP address.
    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

publicip:
    description:
    - Public IP address of packets received on the Citrix ADC. Can be aNetScaler-owned
      VIP or VIP6 address.
    type: str

tcpproxy:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable TCP proxy, which enables the Citrix ADC to optimize the RNAT TCP traffic
      by using Layer 4 features.
    type: str

privateip:
    description:
    - IP address of the server to which the packet is sent by the Citrix ADC. Can be an
      IPv4 or IPv6 address.
    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

connfailover:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Synchronize connection information with the secondary appliance in a high availability
      (HA) pair. That is, synchronize all connection-related information for the INAT
      session
    type: str

useproxyport:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable the Citrix ADC to proxy the source port of packets before sending the packets
      to the server.
    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

Outputs

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