W3cubDocs

/Ansible

community.network.ce_mlag_interface – Manages MLAG interfaces on HUAWEI CloudEngine switches.

Note

This plugin is part of the community.network collection (version 3.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 community.network.

To use it in a playbook, specify: community.network.ce_mlag_interface.

Synopsis

  • Manages MLAG interface attributes on HUAWEI CloudEngine switches.

Parameters

Parameter Choices/Defaults Comments
dfs_group_id
string
Default:
"present"
ID of a DFS group.The value is 1.
eth_trunk_id
string
Name of the local M-LAG interface. The value is ranging from 0 to 511.
interface
string
Name of the interface that enters the Error-Down state when the peer-link fails. The value is a string of 1 to 63 characters.
mlag_error_down
string
    Choices:
  • enable
  • disable
Configure the interface on the slave device to enter the Error-Down state.
mlag_id
string
ID of the M-LAG. The value is an integer that ranges from 1 to 2048.
mlag_priority_id
string
M-LAG global LACP system priority. The value is an integer ranging from 0 to 65535. The default value is 32768.
mlag_system_id
string
M-LAG global LACP system MAC address. The value is a string of 0 to 255 characters. The default value is the MAC address of the Ethernet port of MPU.
state
string
    Choices:
  • present ←
  • absent
Specify desired state of the resource.

Notes

Note

  • This module requires the netconf system service be enabled on the remote device being managed.
  • Recommended connection is netconf.
  • This module also works with local connections for legacy playbooks.

Examples

- name: Mlag interface module test
  hosts: cloudengine
  connection: local
  gather_facts: no
  vars:
    cli:
      host: "{{ inventory_hostname }}"
      port: "{{ ansible_ssh_port }}"
      username: "{{ username }}"
      password: "{{ password }}"
      transport: cli

  tasks:

  - name: Set interface mlag error down
    community.network.ce_mlag_interface:
      interface: 10GE2/0/1
      mlag_error_down: enable
      provider: "{{ cli }}"
  - name: Create mlag
    community.network.ce_mlag_interface:
      eth_trunk_id: 1
      dfs_group_id: 1
      mlag_id: 4
      provider: "{{ cli }}"
  - name: Set mlag global attribute
    community.network.ce_mlag_interface:
      mlag_system_id: 0020-1409-0407
      mlag_priority_id: 5
      provider: "{{ cli }}"
  - name: Set mlag interface attribute
    community.network.ce_mlag_interface:
      eth_trunk_id: 1
      mlag_system_id: 0020-1409-0400
      mlag_priority_id: 3
      provider: "{{ cli }}"

Return Values

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

Key Returned Description
changed
boolean
always
check to see if a change was made on the device

Sample:
True
end_state
dictionary
always
k/v pairs of aaa params after module execution
existing
dictionary
always
k/v pairs of existing aaa server

Sample:
{'mlagErrorDownInfos': [{'dfsgroupId': '1', 'portName': 'Eth-Trunk1'}]}
proposed
dictionary
always
k/v pairs of parameters passed into module

Sample:
{'interface': 'eth-trunk1', 'mlag_error_down': 'disable', 'state': 'present'}
updates
list / elements=string
always
command sent to the device

Sample:
{'interface eth-trunk1': None, 'undo m-lag unpaired-port suspend': None}


Authors

  • Li Yanfeng (@QijunPan)

© 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/community/network/ce_mlag_interface_module.html