Documentation

dladm_iptun - Manage IP tunnel interfaces on Solaris/illumos systems.

New in version 2.3.

Synopsis

  • Manage IP tunnel interfaces on Solaris/illumos systems.

Options

parameter required default choices comments
local_address
no
Literat IP address or hostname corresponding to the tunnel source.

aliases: local
name
yes
IP tunnel interface name.

aliases: tunnel, link
remote_address
no
Literal IP address or hostname corresponding to the tunnel destination.

aliases: remote
state
no present
  • present
  • absent
Create or delete Solaris/illumos VNIC.
temporary
no
Specifies that the IP tunnel interface is temporary. Temporary IP tunnel interfaces do not persist across reboots.
type
no ipv4
  • ipv4
  • ipv6
  • 6to4
Specifies the type of tunnel to be created.

Examples

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

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

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

name: Remove 'iptun0' tunnel interface
dladm_iptun: name=iptun0 state=absent

Return Values

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

name description returned type sample
state state of the target always string present
temporary specifies if operation will persist across reboots always boolean True
name tunnel interface name always string iptun0
local_address local IP address always string 1.1.1.1/32
type tunnel type always string ipv4
remote_address remote IP address always string 2.2.2.2/32


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.