/ home / community / community.general / 0.1.1 / module / onyx_vlan

community.general.onyx_vlan (0.1.1) — module

Manage VLANs on Mellanox ONYX network devices

Authors: Samer Deeb (@samerd) Alex Tabachnik (@atabachnik)

preview | supported by community

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

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

Usage examples

Scanned by Steampunk Spotter

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

Scanned by Steampunk Spotter

- name: remove configuration
  onyx_vlan:
    state: absent

Inputs

    
name:
    description:
    - Name of the VLAN.

purge:
    default: false
    description:
    - Purge VLANs not defined in the I(aggregate) parameter.
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the VLAN configuration.

vlan_id:
    description:
    - ID of the VLAN.

aggregate:
    description: List of VLANs definitions.

Outputs

commands:
  description: The list of configuration mode commands to send to the device
  returned: always.
  sample:
  - vlan 20
  - name test-vlan
  - exit
  type: list