mellanox.onyx.onyx_l2_interface – Manage Layer-2 interface on Mellanox ONYX network devices

From Get docs
Ansible/docs/2.10/collections/mellanox/onyx/onyx l2 interface module


mellanox.onyx.onyx_l2_interface – Manage Layer-2 interface 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_l2_interface.


Synopsis

  • This module provides declarative management of Layer-2 interface on Mellanox ONYX network devices.

Parameters

Parameter Choices/Defaults Comments

access_vlan

string

Configure given VLAN in access port.

aggregate

string

List of Layer-2 interface definitions.

mode

string

  • access

  • trunk
  • hybrid

Mode in which interface needs to be configured.

name

string

Name of the interface.

state

string

  • present

  • absent

State of the Layer-2 Interface configuration.

trunk_allowed_vlans

string

List of allowed VLANs in a given trunk port.



Examples

- name: Configure Layer-2 interface
  onyx_l2_interface:
    name: Eth1/1
    mode: access
    access_vlan: 30
- name: Remove Layer-2 interface configuration
  onyx_l2_interface:
    name: Eth1/1
    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:

['interface ethernet 1/1', 'switchport mode access', 'switchport access vlan 30']




Authors

  • Samer Deeb (@samerd)

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