onyx_vlan – Manage VLANs on Mellanox ONYX network devices

From Get docs
Ansible/docs/2.8/modules/onyx vlan module


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.

Parameters

Parameter Choices/Defaults Comments

aggregate

-

List of VLANs definitions.

name

-

Name of the VLAN.

purge

boolean

  • no

  • yes

Purge VLANs not defined in the aggregate parameter.

state

-

  • present

  • absent

State of the VLAN configuration.

vlan_id

-

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

always.

The list of configuration mode commands to send to the device


Sample:

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




Status

Authors

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

Hint

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


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/onyx_vlan_module.html