onyx_vlan - Manage VLANs on Mellanox ONYX network devices¶

New in version 2.5.

Synopsis ¶

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

Parameter	Choices/Defaults	Comments
aggregate		List of VLANs definitions.
name		Name of the VLAN.
purge	Default: no	Purge VLANs not defined in the aggregate parameter.
state	Choices: present ← absent	State of the VLAN configuration.
vlan_id		ID of the VLAN.

- name: configure VLAN ID and name
  onyx_vlan:
    vlan_id: 20
    name: test-vlan

- name: remove configuration
  onyx_vlan:
    state: absent

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

Key	Returned	Description
commands list	always.	The list of configuration mode commands to send to the device Sample: ['vlan 20', 'name test-vlan', 'exit']

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

Hint

If you notice any issues in this documentation you can edit this document to improve it.