netscaler.adc.iptunnelparam (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 ip tunnel parameter resource.

Inputs

    
mac:
    description:
    - The shared MAC used for shared IP between cluster nodes/HA peers
    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

srcip:
    description:
    - Common source-IP address for all tunnels. For a specific tunnel, this global setting
      is overridden if you have specified another source IP address. Must be a MIP or
      SNIP address.
    type: str

state:
    choices:
    - present
    - 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(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

dropfrag:
    choices:
    - 'YES'
    - 'NO'
    description:
    - Drop any IP packet that requires fragmentation before it is sent through the tunnel.
    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

enablestrictrx:
    choices:
    - 'YES'
    - 'NO'
    description:
    - Strict PBR check for IPSec packets received through tunnel
    type: str

enablestricttx:
    choices:
    - 'YES'
    - 'NO'
    description:
    - Strict PBR check for packets to be sent IPSec protected
    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

srciproundrobin:
    choices:
    - 'YES'
    - 'NO'
    description:
    - Use a different source IP address for each new session through a particular IP tunnel,
      as determined by round robin selection of one of the SNIP addresses. This setting
      is ignored if a common global source IP address has been specified for all the IP
      tunnels. This setting does not apply to a tunnel for which a source IP address has
      been specified.
    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

useclientsourceip:
    choices:
    - 'YES'
    - 'NO'
    description:
    - Use client source IP as source IP for outer tunnel IP header
    type: str

dropfragcputhreshold:
    description:
    - Threshold value, as a percentage of CPU usage, at which to drop packets that require
      fragmentation to use the IP tunnel. Applies only if dropFragparameter is set to
      NO. The default value, 0, specifies that this parameter is not set.
    type: float

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