netscaler.adc.lsnstatic (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 static mapping resource.

Inputs

    
td:
    description:
    - 'ID of the traffic domain to which the subscriber belongs. '
    - ''
    - If you do not specify an ID, the subscriber is assumed to be a part of the default
      traffic domain.
    type: float

name:
    description:
    - 'Name for the LSN static mapping entry. 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 static1" or ''lsn static1'').'
    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

dsttd:
    description:
    - ID of the traffic domain through which the destination IP address for this LSN mapping
      entry is reachable from the Citrix ADC.
    - ''
    - If you do not specify an ID, the destination IP address is assumed to be reachable
      through the default traffic domain, which has an ID of 0.
    type: float

natip:
    description:
    - IPv4 address, already existing on the Citrix ADC as type LSN, to be used as NAT
      IP address for this mapping entry.
    type: str

state:
    choices:
    - present
    - absent
    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.
    type: str

destip:
    description:
    - Destination IP address for the LSN mapping entry.
    type: str

natport:
    description:
    - NAT port for this LSN mapping entry. * represents all ports being used. Used in
      case of static wildcard
    type: int

nattype:
    choices:
    - NAT44
    - DS-Lite
    - NAT64
    description:
    - Type of sessions to be displayed.
    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

network6:
    description:
    - B4 address in DS-Lite setup
    type: str

subscrip:
    description:
    - IPv4(NAT44 & DS-Lite)/IPv6(NAT64) address of an LSN subscriber for the LSN static
      mapping entry.
    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

subscrport:
    description:
    - Port of the LSN subscriber for the LSN mapping entry. * represents all ports being
      used. Used in case of static wildcard
    type: int

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

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
    - ALL
    description:
    - Protocol for the LSN mapping entry.
    type: str

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