Note
This module is part of the community.network collection (version 5.1.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.
Note
The community.network collection has been deprecated and will be removed from Ansible 12. See the discussion thread for more information.
version 6.0.0
This collection and all content in it is unmaintained and deprecated.
Unknown.
Aliases: network.illumos.ipadm_if
Parameter | Comments |
|---|---|
name string / required | IP interface name. |
state string | Create or delete Solaris/illumos IP interfaces. Choices:
|
temporary boolean | Specifies that the IP interface is temporary. Temporary IP interfaces do not persist across reboots. Choices:
|
- name: Create vnic0 interface
community.network.ipadm_if:
name: vnic0
state: enabled
- name: Disable vnic0 interface
community.network.ipadm_if:
name: vnic0
state: disabled
Common return values are documented here, the following are the fields unique to this module:
Key | Description |
|---|---|
name string | IP interface name Returned: always Sample: |
state string | state of the target Returned: always Sample: |
temporary boolean | persistence of a IP interface Returned: always Sample: |
© 2012–2018 Michael DeHaan
© 2018–2025 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