community.network.ipadm_if – Manage IP 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.ipadm_if.
Synopsis
- Create, delete, enable or disable IP interfaces on Solaris/illumos systems.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| name
string / required
|
IP interface name.
|
|
| state
string
|
|
Create or delete Solaris/illumos IP interfaces.
|
| temporary
boolean
|
|
Specifies that the IP interface is temporary. Temporary IP interfaces do not persist across reboots.
|
Examples
- name: Create vnic0 interface
community.network.ipadm_if:
name: vnic0
state: enabled
- name: Disable vnic0 interface
community.network.ipadm_if:
name: vnic0
state: disabled
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| name
string
|
always |
IP interface name
Sample:
vnic0
|
| state
string
|
always |
state of the target
Sample:
present
|
| temporary
boolean
|
always |
persistence of a IP interface
Sample:
True
|
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/ipadm_if_module.html