netscaler.adc.iptunnel (2.5.1) — module

Configuration for ip Tunnel resource.

| "added in version" 2.0.0 of netscaler.adc"

Authors: Sumanth Lingappa (@sumanth-lingappa)

preview | supported by community

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 resource.

Inputs

    
name:
    description:
    - 'Name for the IP tunnel. 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

vlan:
    description:
    - The vlan for mulicast packets
    type: float

vnid:
    description:
    - Virtual network identifier (VNID) is the value that identifies a specific virtual
      network in the data plane.
    type: float

local:
    description:
    - Type of Citrix ADC owned public IPv4 address, configured on the local Citrix ADC
      and used to set up the tunnel.
    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

remote:
    description:
    - Public IPv4 address, of the remote device, used to set up the tunnel. For this parameter,
      you can alternatively specify a network 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

destport:
    description:
    - Specifies UDP destination port for Geneve packets. Default port is 6081.
    type: int

protocol:
    choices:
    - IPIP
    - GRE
    - IPSEC
    - UDP
    - GENEVE
    description:
    - Name of the protocol to be used on this tunnel.
    type: str

grepayload:
    choices:
    - ETHERNETwithDOT1Q
    - ETHERNET
    - IP
    description:
    - The payload GRE will carry
    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 the iptunnel.
    type: str

tosinherit:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Default behavior is to copy the ToS field of the internal IP Packet (Payload) to
      the outer IP packet (Transport packet). But the user can configure a new ToS field
      using this option.
    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

vlantagging:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Option to select Vlan Tagging.
    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

ipsecprofilename:
    description:
    - Name of IPSec profile to be associated.
    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

remotesubnetmask:
    description:
    - Subnet mask of the remote IP address of the tunnel.
    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