You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.network.dladm_iptun – Manage IP tunnel interfaces on Solaris/illumos systems.

Note

This plugin is part of the community.network collection (version 3.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.dladm_iptun.

Synopsis

• Manage IP tunnel interfaces on Solaris/illumos systems.

Parameters

Parameter	Comments
local_address aliases: local string	Literal IP address or hostname corresponding to the tunnel source.
name string / required	IP tunnel interface name.
remote_address aliases: remote string	Literal IP address or hostname corresponding to the tunnel destination.
state string	Create or delete Solaris/illumos VNIC. Choices: present ← (default) absent
temporary boolean	Specifies that the IP tunnel interface is temporary. Temporary IP tunnel interfaces do not persist across reboots. Choices: no ← (default) yes
type aliases: tunnel_type string	Specifies the type of tunnel to be created. Choices: ipv4 ← (default) ipv6 6to4

Examples

- name: Create IPv4 tunnel interface 'iptun0'
  community.network.dladm_iptun: name=iptun0 local_address=192.0.2.23 remote_address=203.0.113.10 state=present

- name: Change IPv4 tunnel remote address
  community.network.dladm_iptun: name=iptun0 type=ipv4 local_address=192.0.2.23 remote_address=203.0.113.11

- name: Create IPv6 tunnel interface 'tun0'
  community.network.dladm_iptun: name=tun0 type=ipv6 local_address=192.0.2.23 remote_address=203.0.113.42

- name: Remove 'iptun0' tunnel interface
  community.network.dladm_iptun: name=iptun0 state=absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
local_address string	local IP address Returned: always Sample: “1.1.1.1/32”
name string	tunnel interface name Returned: always Sample: “iptun0”
remote_address string	remote IP address Returned: always Sample: “2.2.2.2/32”
state string	state of the target Returned: always Sample: “present”
temporary boolean	specifies if operation will persist across reboots Returned: always Sample: true
type string	tunnel type Returned: always Sample: “ipv4”

Authors

• Adam Števko (@xen0l)