mellanox.onyx.onyx_mlag_vip module – Configures MLAG VIP 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_mlag_vip.

Synopsis

  • This module provides declarative management of MLAG virtual IPs on Mellanox ONYX network devices.

Parameters

Parameter

Comments

delay

string

Delay interval, in seconds, waiting for the changes on mlag VIP to take effect.

Default: 12

group_name

string

MLAG group name. Required if state=present.

ipaddress

string

Virtual IP address of the MLAG. Required if state=present.

mac_address

string

MLAG system MAC address. Required if state=present.

state

string

MLAG VIP state.

Choices:

  • present

  • absent

Notes

Note

  • Tested on ONYX 3.6.4000

Examples

- name: Configure mlag-vip
  onyx_mlag_vip:
    ipaddress: 50.3.3.1/24
    group_name: ansible-test-group
    mac_address: 00:11:12:23:34:45

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: [“mlag-vip ansible_test_group ip 50.3.3.1 /24 force”, “no mlag shutdown”]

Authors

  • Samer Deeb (@samerd)