mellanox.onyx.onyx_mlag_ipl – Manage IPL (inter-peer link) 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_mlag_ipl.

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

This module provides declarative management of IPL (inter-peer link) management on Mellanox ONYX network devices.

Parameters

Parameter	Choices/Defaults	Comments
name string / required		Name of the interface (port-channel) IPL should be configured on.
peer_address string		IPL peer IP address.
state string	Choices: present ← absent	IPL state.
vlan_interface string		Name of the IPL vlan interface.

Notes

Note

Tested on ONYX 3.6.4000

Examples

- name: Run configure ipl
  onyx_mlag_ipl:
    name: Po1
    vlan_interface: Vlan 322
    state: present
    peer_address: 192.168.7.1

- name: Run remove ipl
  onyx_mlag_ipl:
    name: Po1
    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 port-channel 1 ipl 1', 'interface vlan 1024 ipl 1 peer-address 10.10.10.10']

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_mlag_ipl_module.html