W3cubDocs

/Ansible

mellanox.onyx.onyx_protocol – Enables/Disables protocols on Mellanox ONYX network devices

Note

This plugin is part of the mellanox.onyx collection (version 1.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install mellanox.onyx.

To use it in a playbook, specify: mellanox.onyx.onyx_protocol.

Synopsis

  • This module provides a mechanism for enabling and disabling protocols Mellanox on ONYX network devices.

Parameters

Parameter Choices/Defaults Comments
bfd
string
added in 0.2.0 of mellanox.onyx
    Choices:
  • enabled
  • disabled
bfd protocol
bgp
string
    Choices:
  • enabled
  • disabled
BGP protocol
dcb_pfc
string
    Choices:
  • enabled
  • disabled
DCB priority flow control
igmp_snooping
string
    Choices:
  • enabled
  • disabled
IP IGMP snooping
ip_l3
string
    Choices:
  • enabled
  • disabled
IP L3 support
ip_routing
string
    Choices:
  • enabled
  • disabled
IP routing support
lacp
string
    Choices:
  • enabled
  • disabled
LACP protocol
lldp
string
    Choices:
  • enabled
  • disabled
LLDP protocol
magp
string
    Choices:
  • enabled
  • disabled
MAGP protocol
mlag
string
    Choices:
  • enabled
  • disabled
MLAG protocol
nve
string
    Choices:
  • enabled
  • disabled
nve protocol
ospf
string
    Choices:
  • enabled
  • disabled
OSPF protocol
spanning_tree
string
    Choices:
  • enabled
  • disabled
Spanning Tree support

Notes

Note

  • Tested on ONYX 3.6.4000

Examples

- name: Enable protocols for MLAG
  onyx_protocol:
    lacp: enabled
    spanning_tree: disabled
    ip_routing: enabled
    mlag: enabled
    dcb_pfc: enabled

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:
['no spanning-tree', 'protocol mlag']


Authors

  • Samer Deeb (@samerd)

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