mellanox.onyx.onyx_vlan – Manage VLANs on Mellanox ONYX network devices

Note

This plugin is part of the mellanox.onyx collection.

To install it use: ansible-galaxy collection install mellanox.onyx.

To use it in a playbook, specify: mellanox.onyx.onyx_vlan.

Synopsis

  • This module provides declarative management of VLANs on Mellanox ONYX network devices.

Parameters

Parameter Choices/Defaults Comments
aggregate
string
List of VLANs definitions.
name
string
Name of the VLAN.
purge
boolean
    Choices:
  • no ←
  • yes
Purge VLANs not defined in the aggregate parameter.
state
string
    Choices:
  • present ←
  • absent
State of the VLAN configuration.
vlan_id
string
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 Returned Description
commands
list / elements=string
always.
The list of configuration mode commands to send to the device

Sample:
['vlan 20', 'name test-vlan', 'exit']


Authors

  • Samer Deeb (@samerd) Alex Tabachnik (@atabachnik)