mellanox.onyx.onyx_vlan – Manage VLANs on Mellanox ONYX network devices
Note
This plugin is part of the mellanox.onyx collection (version 1.0.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 mellanox.onyx
.
To use it in a playbook, specify: mellanox.onyx.onyx_vlan
.
Parameters
Parameter |
Comments |
---|---|
List of VLANs definitions. |
|
Name of the VLAN. |
|
Purge VLANs not defined in the aggregate parameter. Choices:
|
|
State of the VLAN configuration. Choices:
|
|
ID of the VLAN. |
Examples
- name: Configure VLAN ID and name
onyx_vlan:
vlan_id: 20
name: test-vlan
- name: Remove configuration
onyx_vlan:
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The list of configuration mode commands to send to the device Returned: always. Sample: [“vlan 20”, “name test-vlan”, “exit”] |
Authors
Samer Deeb (@samerd) Alex Tabachnik (@atabachnik)