community.network.ipadm_if module – Manage IP interfaces on Solaris/illumos systems.

Note

This module is part of the community.network collection (version 4.0.1).

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

Comments

name

string / required

IP interface name.

state

string

Create or delete Solaris/illumos IP interfaces.

Choices:

  • present ← (default)

  • absent

  • enabled

  • disabled

temporary

boolean

Specifies that the IP interface is temporary. Temporary IP interfaces do not persist across reboots.

Choices:

  • no ← (default)

  • yes

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

Description

name

string

IP interface name

Returned: always

Sample: “vnic0”

state

string

state of the target

Returned: always

Sample: “present”

temporary

boolean

persistence of a IP interface

Returned: always

Sample: “True”

Authors

  • Adam Števko (@xen0l)