Documentation

ipadm_if - Manage IP interfaces on Solaris/illumos systems.

New in version 2.2.

Synopsis

  • Create, delete, enable or disable IP interfaces on Solaris/illumos systems.

Options

parameter required default choices comments
name
yes
IP interface name.
state
no present
  • present
  • absent
  • enabled
  • disabled
Create or delete Solaris/illumos IP interfaces.
temporary
no
  • true
  • false
Specifies that the IP interface is temporary. Temporary IP interfaces do not persist across reboots.

Examples

# Create vnic0 interface
- ipadm_if:
    name: vnic0
    state: enabled

# Disable vnic0 interface
- ipadm_if:
    name: vnic0
    state: disabled

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
state
state of the target
always string present
temporary
persistence of a IP interface
always boolean True
name
IP interface name
always string vnic0


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.