mellanox.onyx.onyx_magp module – Manage MAGP protocol on Mellanox ONYX network devices

Note

This module 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_magp.

Synopsis

  • This module provides declarative management of MAGP protocol on vlan interface of Mellanox ONYX network devices.

Parameters

Parameter

Comments

interface

string / required

VLAN Interface name.

magp_id

string / required

MAGP instance number 1-255

router_ip

string

MAGP router IP address.

router_mac

string

MAGP router MAC address.

state

string

MAGP state.

Choices:

  • "present" ← (default)

  • "absent"

  • "enabled"

  • "disabled"

Notes

Note

  • Tested on ONYX 3.6.4000

Examples

- name: Run add vlan interface with magp
  onyx_magp:
    magp_id: 103
    router_ip: 192.168.8.2
    router_mac: AA:1B:2C:3D:4E:5F
    interface: Vlan 1002

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

commands

list / elements=string

The list of configuration mode commands to send to the device.

Returned: always

Sample: ["interface vlan 234 magp 103", "exit", "interface vlan 234 magp 103 ip virtual-router address 1.2.3.4"]

Authors

  • Samer Deeb (@samerd)