community.network.ce_lacp – Manages Eth-Trunk 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_lacp.

New in version 0.2.0: of community.network

Synopsis

Manages Eth-Trunk specific configuration parameters on HUAWEI CloudEngine switches.

Parameters

Parameter	Choices/Defaults	Comments
collector_delay integer		Value of delay time in units of 10 microseconds.
fast_timeout integer		When lacp timeout type is 'Fast', user-defined time can be a number(3~90).
global_priority integer		Configure lacp priority on system-view.
max_active_linknumber integer		Max active linknumber in link aggregation group.
mixed_rate_link_enable boolean	Choices: no yes	Value of max active linknumber.
mode string	Choices: Manual Dynamic Static	Specifies the working mode of an Eth-Trunk interface.
port_id_extension_enable boolean	Choices: no yes	Enable the function of extending the LACP negotiation port number.
preempt_delay integer		Value of preemption delay time.
preempt_enable boolean	Choices: no yes	Specifies lacp preempt enable of Eth-Trunk lacp. The value is an boolean 'true' or 'false'.
priority integer		The priority of eth-trunk member interface.
select string	Choices: Speed Prority	Select priority or speed to preempt.
state string	Choices: present ← absent	Manage the state of the resource.
state_flapping boolean	Choices: no yes	Lacp dampening state-flapping.
system_id string		Link Aggregation Control Protocol System ID,interface Eth-Trunk View. Formate 'X-X-X',X is hex(a,aa,aaa, or aaaa)
timeout_type string	Choices: Slow Fast	Lacp timeout type,that may be 'Fast' or 'Slow'.
trunk_id integer		Eth-Trunk interface number. The value is an integer. The value range depends on the assign forward eth-trunk mode command. When 256 is specified, the value ranges from 0 to 255. When 512 is specified, the value ranges from 0 to 511. When 1024 is specified, the value ranges from 0 to 1023.
unexpected_mac_disable boolean	Choices: no yes	Lacp dampening unexpected-mac disable.

Notes

Note

state=absent removes the Eth-Trunk config and interface if it already exists. If members to be removed are not explicitly passed, all existing members (if any), are removed, and Eth-Trunk removed.
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: Ensure Eth-Trunk100 is created, and set to mode lacp-static
  community.network.ce_lacp:
    trunk_id: 100
    mode: 'lacp-static'
    state: present
- name: Ensure Eth-Trunk100 is created, add two members, and set global priority to 1231
  community.network.ce_lacp:
    trunk_id: 100
    global_priority: 1231
    state: present
- name: Ensure Eth-Trunk100 is created, and set mode to Dynamic and configure other options
  community.network.ce_lacp:
    trunk_id: 100
    mode: Dynamic
    preempt_enable: True,
    state_flapping: True,
    port_id_extension_enable: True,
    unexpected_mac_disable: True,
    timeout_type: Fast,
    fast_timeout: 123,
    mixed_rate_link_enable: True,
    preempt_delay: 23,
    collector_delay: 33,
    state: present

Return Values

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

Key	Returned	Description
end_state dictionary	always	k/v pairs of Eth-Trunk info after module execution Sample: {'hash_type': 'mac', 'members_detail': [{'memberIfName': '10GE1/0/24', 'memberIfState': 'Down'}, {'memberIfName': '10GE1/0/25', 'memberIfState': 'Down'}], 'min_links': '1', 'mode': 'lacp-static', 'trunk_id': '100'}
existing dictionary	always	k/v pairs of existing Eth-Trunk Sample: {'hash_type': 'mac', 'members_detail': [{'memberIfName': '10GE1/0/25', 'memberIfState': 'Down'}], 'min_links': '1', 'mode': 'manual', 'trunk_id': '100'}
proposed dictionary	always	k/v pairs of parameters passed into module Sample: {'members': ['10GE1/0/24', '10GE1/0/25'], 'mode': 'lacp-static', 'trunk_id': '100'}
updates list / elements=string	always	command sent to the device Sample: ['interface Eth-Trunk 100', 'mode lacp-static', 'interface 10GE1/0/25', 'eth-trunk 100']

Authors

xuxiaowei0512 (@CloudEngine-Ansible)

© 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_lacp_module.html

Docs

Docs4dev

Title here