Documentation

dladm_etherstub - Manage etherstubs on Solaris/illumos systems.

New in version 2.2.

Synopsis

  • Create or delete etherstubs on Solaris/illumos systems.

Options

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

Examples

# Create 'stub0' etherstub
- dladm_etherstub:
    name: stub0
    state: present

# Remove 'stub0 etherstub
- dladm_etherstub:
    name: stub0
    state: absent

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 etherstub's persistence always boolean True
name etherstub name always string switch0


Status

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

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

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