onyx_linkagg – Manage link aggregation groups on Mellanox ONYX network devices

From Get docs
Ansible/docs/2.7/modules/onyx linkagg module


onyx_linkagg – Manage link aggregation groups on Mellanox ONYX network devices

Synopsis

  • This module provides declarative management of link aggregation groups on Mellanox ONYX network devices.

Parameters

Parameter Choices/Defaults Comments

aggregate

-

List of link aggregation definitions.

members

- / required

List of members interfaces of the link aggregation group. The value can be single interface or list of interfaces.

mode

-

  • on
  • active
  • passive

Default:

"yes"

Mode of the link aggregation group. A value of on will enable LACP. active configures the link to actively information about the state of the link, or it can be configured in passive mode ie. send link state information only when received them from another link.

name

- / required

Name of the link aggregation group.

purge

boolean

  • no

  • yes

Purge link aggregation groups not defined in the aggregate parameter.

state

-

  • present

  • absent
  • up
  • down

State of the link aggregation group.



Examples

- name: configure link aggregation group
  onyx_linkagg:
    name: Po1
    members:
      - Eth1/1
      - Eth1/2

- name: remove configuration
  onyx_linkagg:
    name: Po1
    state: absent

- name: Create aggregate of linkagg definitions
  onyx_linkagg:
    aggregate:
        - { name: Po1, members: [Eth1/1] }
        - { name: Po2, members: [Eth1/2] }

- name: Remove aggregate of linkagg definitions
  onyx_linkagg:
    aggregate:
      - name: Po1
      - name: Po2
    state: absent

Return Values

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

Key Returned Description

commands

list

always.

The list of configuration mode commands to send to the device


Sample:

['interface port-channel 1', 'exit', 'interface ethernet 1/1 channel-group 1 mode on', 'interface ethernet 1/2 channel-group 1 mode on']




Status

Authors

  • Samer Deeb (@samerd)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/onyx_linkagg_module.html