You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

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

Synopsis

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

Parameters

Parameter	Comments
name string / required	Name of the interface (port-channel) IPL should be configured on.
peer_address string	IPL peer IP address.
state string	IPL state. Choices: "present" ← (default) "absent"
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	Description
commands list / elements=string	The list of configuration mode commands to send to the device. Returned: always Sample: ["interface port-channel 1 ipl 1", "interface vlan 1024 ipl 1 peer-address 10.10.10.10"]

Authors

• Samer Deeb (@samerd)

Collection links

Issue Tracker Repository (Sources)