• AnsibleFest
  • Products
  • Community
  • Webinars & Training
  • Blog
Ansible Logo
Documentation
Ansible
3

Installation, Upgrade & Configuration

  • Installation Guide
  • Ansible Porting Guides

Using Ansible

  • User Guide

Contributing to Ansible

  • Ansible Community Guide

Extending Ansible

  • Developer Guide

Common Ansible Scenarios

  • Public Cloud Guides
  • Network Technology Guides
  • Virtualization and Containerization Guides

Network Automation

  • Network Getting Started
  • Network Advanced Topics
  • Network Developer Guide

Ansible Galaxy

  • Galaxy User Guide
  • Galaxy Developer Guide

Reference & Appendices

  • Collection Index
  • Indexes of all modules and plugins
  • Playbook Keywords
  • Return Values
  • Ansible Configuration Settings
  • Controlling how Ansible behaves: precedence rules
  • YAML Syntax
  • Python 3 Support
  • Interpreter Discovery
  • Release and maintenance
  • Testing Strategies
  • Sanity Tests
  • Frequently Asked Questions
  • Glossary
  • Ansible Reference: Module Utilities
  • Special Variables
  • Red Hat Ansible Tower
  • Ansible Automation Hub
  • Logging Ansible output

Roadmaps

  • Ansible Roadmap




Ansible
  • Docs »
  • mellanox.onyx.onyx_mlag_ipl – Manage IPL (inter-peer link) on Mellanox ONYX network devices


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).

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)


© Copyright 2021 Red Hat, Inc. Last updated on Apr 23, 2021.