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 | Choices/Defaults | Comments |
|---|---|---|
| local_address
string
|
Literal IP address or hostname corresponding to the tunnel source.
aliases: local |
|
| name
string / required
|
IP tunnel interface name.
|
|
| remote_address
string
|
Literal IP address or hostname corresponding to the tunnel destination.
aliases: remote |
|
| state
string
|
|
Create or delete Solaris/illumos VNIC.
|
| temporary
boolean
|
|
Specifies that the IP tunnel interface is temporary. Temporary IP tunnel interfaces do not persist across reboots.
|
| type
string
|
|
Specifies the type of tunnel to be created.
aliases: tunnel_type |
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 | Returned | Description |
|---|---|---|
| local_address
string
|
always |
local IP address
Sample:
1.1.1.1/32
|
| name
string
|
always |
tunnel interface name
Sample:
iptun0
|
| remote_address
string
|
always |
remote IP address
Sample:
2.2.2.2/32
|
| state
string
|
always |
state of the target
Sample:
present
|
| temporary
boolean
|
always |
specifies if operation will persist across reboots
Sample:
True
|
| type
string
|
always |
tunnel type
Sample:
ipv4
|
Authors
- Adam Števko (@xen0l)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/dladm_iptun_module.html