community.network.dladm_vlan module – Manage VLAN interfaces on Solaris/illumos systems.

Note

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

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.dladm_vlan.

Synopsis

  • Create or delete VLAN interfaces on Solaris/illumos systems.

Parameters

Parameter

Comments

string / required

VLAN underlying link name.

name

string / required

VLAN interface name.

state

string

Create or delete Solaris/illumos VNIC.

Choices:

  • "present" ← (default)

  • "absent"

temporary

boolean

Specifies that the VLAN interface is temporary. Temporary VLANs do not persist across reboots.

Choices:

  • false ← (default)

  • true

vlan_id

aliases: vid

string

VLAN ID value for VLAN interface.

Default: false

Examples

- name: Create 'vlan42' VLAN over 'bnx0' link
  community.network.dladm_vlan: name=vlan42 link=bnx0 vlan_id=42 state=present

- name: Remove 'vlan1337' VLAN interface
  community.network.dladm_vlan: name=vlan1337 state=absent

Return Values

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

Key

Description

string

VLAN’s underlying link name

Returned: always

Sample: "e100g0"

name

string

VLAN name

Returned: always

Sample: "vlan42"

state

string

state of the target

Returned: always

Sample: "present"

temporary

boolean

specifies if operation will persist across reboots

Returned: always

Sample: true

vlan_id

string

VLAN ID

Returned: always

Sample: "42"

Authors

  • Adam Števko (@xen0l)