community.network.ce_mlag_config – Manages MLAG configuration 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_config
.
Synopsis
- Manages MLAG configuration 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 peer-link interface. The value is in the range from 0 to 511. | |
ip_address string | IP address bound to the DFS group. The value is in dotted decimal notation. | |
nickname string | The nickname bound to a DFS group. The value is an integer that ranges from 1 to 65471. | |
peer_link_id string | Number of the peer-link interface. The value is 1. | |
priority_id string | Priority of a DFS group. The value is an integer that ranges from 1 to 254. The default value is 100. | |
pseudo_nickname string | A pseudo nickname of a DFS group. The value is an integer that ranges from 1 to 65471. | |
pseudo_priority string | The priority of a pseudo nickname. The value is an integer that ranges from 128 to 255. The default value is 192. A larger value indicates a higher priority. | |
state string |
| Specify desired state of the resource. |
vpn_instance_name string | Name of the VPN instance bound to the DFS group. The value is a string of 1 to 31 case-sensitive characters without spaces. If the character string is quoted by double quotation marks, the character string can contain spaces. The value _public_ is reserved and cannot be used as the VPN instance name. |
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 config 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: Create DFS Group id community.network.ce_mlag_config: dfs_group_id: 1 provider: "{{ cli }}" - name: Set dfs-group priority community.network.ce_mlag_config: dfs_group_id: 1 priority_id: 3 state: present provider: "{{ cli }}" - name: Set pseudo nickname community.network.ce_mlag_config: dfs_group_id: 1 pseudo_nickname: 3 pseudo_priority: 130 state: present provider: "{{ cli }}" - name: Set ip community.network.ce_mlag_config: dfs_group_id: 1 ip_address: 11.1.1.2 vpn_instance_name: 6 provider: "{{ cli }}" - name: Set peer link community.network.ce_mlag_config: eth_trunk_id: 3 peer_link_id: 2 state: present 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 Sample: {'eth_trunk_id': 'Eth-Trunk3', 'peer_link_id': '1'} |
existing dictionary | always | k/v pairs of existing aaa server |
proposed dictionary | always | k/v pairs of parameters passed into module Sample: {'eth_trunk_id': '3', 'peer_link_id': '1', 'state': 'present'} |
updates list / elements=string | always | command sent to the device Sample: {'peer-link 1': 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_config_module.html