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

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.

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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/mellanox/onyx/onyx_vlan_module.html