dladm_iptun - Manage IP tunnel interfaces on Solaris/illumos systems.
New in version 2.3.
Synopsis
- Manage IP tunnel interfaces on Solaris/illumos systems.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| local_address |
Literat IP address or hostname corresponding to the tunnel source.
aliases: local |
|
| name
required
|
IP tunnel interface name.
|
|
| remote_address |
Literal IP address or hostname corresponding to the tunnel destination.
aliases: remote |
|
| state |
|
Create or delete Solaris/illumos VNIC.
|
| temporary | Default:
"no"
|
Specifies that the IP tunnel interface is temporary. Temporary IP tunnel interfaces do not persist across reboots.
|
| type |
|
Specifies the type of tunnel to be created.
aliases: tunnel_type |
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, 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
|
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author
- Adam Števko (@xen0l)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/dladm_iptun_module.html