dellemc.enterprise_sonic.sonic_mclag module – Manage multi chassis link aggregation groups domain (MCLAG) and its parameters
Note
This module is part of the dellemc.enterprise_sonic collection (version 2.5.1).
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 dellemc.enterprise_sonic.
To use it in a playbook, specify: dellemc.enterprise_sonic.sonic_mclag.
New in dellemc.enterprise_sonic 1.0.0
Synopsis
- Manage multi chassis link aggregation groups domain (MCLAG) and its parameters.
Note
This module has a corresponding action plugin.
Parameters
Parameter | Comments |
|---|---|
config dictionary | Dict of mclag domain configurations. |
|
delay_restore integer |
MCLAG delay restore time in secs. |
|
domain_id integer / required |
ID of the mclag domain (MCLAG domain). |
|
gateway_mac string |
Gateway MAC address for router ports over MCLAG. Configured gateway MAC address can be modified only when state=replaced or state=overridden. |
|
keepalive integer |
MCLAG session keepalive-interval in secs. |
|
members dictionary |
Holds portchannels dictionary for an MCLAG domain. |
|
portchannels list / elements=dictionary |
Holds a list of portchannels for configuring as an MCLAG interface. |
|
lag string |
Holds a PortChannel ID. |
|
peer_address string |
The IPV4 peer-ip for corresponding MCLAG. |
|
peer_gateway dictionary |
Holds Vlan dictionary for MCLAG peer gateway. |
|
vlans list / elements=dictionary |
Holds a list of VLANs and VLAN ranges for which MCLAG peer gateway functionality is enabled. |
|
vlan string |
Holds a VLAN name or VLAN range. Specify a single VLAN eg. Vlan10. Specify a range of VLANs eg. Vlan10-20. |
|
peer_link string |
Peer-link for corresponding MCLAG. |
|
session_timeout integer |
MCLAG session timeout value in secs. |
|
session_vrf string added in dellemc.enterprise_sonic 2.5.0 |
MCLAG session VRF. Session VRF value can be either mgmt or a non-default VRF. |
|
source_address string |
The IPV4 source-ip for corresponding MCLAG. |
|
system_mac string |
MAC address of MCLAG. |
|
unique_ip dictionary |
Holds Vlan dictionary for MCLAG unique IP. |
|
vlans list / elements=dictionary |
Holds a list of VLANs and VLAN ranges for which a separate IP address is enabled for Layer 3 protocol support over MCLAG. |
|
vlan string |
Holds a VLAN name or VLAN range. Specify a single VLAN eg. Vlan10. Specify a range of VLANs eg. Vlan10-20. |
state string | The state that the configuration should be left in. Choices:
|
Notes
Note
- Tested against Enterprise SONiC Distribution by Dell Technologies.
- Supports
check_mode.
Examples
# Using merged
#
# Before state:
# -------------
#
# sonic# show mclag brief
# MCLAG Not Configured
- name: Merge provided configuration with device configuration
dellemc.enterprise_sonic.sonic_mclag:
config:
domain_id: 1
peer_address: 1.1.1.1
source_address: 2.2.2.2
peer_link: 'Portchannel1'
session_vrf: 'mgmt'
keepalive: 1
session_timeout: 3
delay_restore: 240
system_mac: '00:00:00:11:11:11'
gateway_mac: '00:00:00:12:12:12'
unique_ip:
vlans:
- vlan: Vlan4
- vlan: Vlan21-25
peer_gateway:
vlans:
- vlan: Vlan4
- vlan: Vlan21-25
members:
portchannels:
- lag: PortChannel10
state: merged
# After state:
# ------------
#
# sonic# show mclag brief
#
# Domain ID : 1
# Role : standby
# Session Status : down
# Peer Link Status : down
# Source Address : 2.2.2.2
# Peer Address : 1.1.1.1
# Session Vrf : mgmt
# Peer Link : PortChannel1
# Keepalive Interval : 1 secs
# Session Timeout : 3 secs
# Delay Restore : 240 secs
# System Mac : 20:04:0f:37:bd:c9
# Mclag System Mac : 00:00:00:11:11:11
# Gateway Mac : 00:00:00:12:12:12
#
#
# Number of MLAG Interfaces:1
#-----------------------------------------------------------
# MLAG Interface Local/Remote Status
#-----------------------------------------------------------
# PortChannel10 down/down
#
# sonic# show mclag separate-ip-interfaces
# Interface Name
# ==============
# Vlan4
# Vlan21
# Vlan22
# Vlan23
# Vlan24
# Vlan25
# ==============
# Total count : 6
# ==============
# sonic#
# sonic# show mclag peer-gateway-interfaces
# Interface Name
# ==============
# Vlan4
# Vlan21
# Vlan22
# Vlan23
# Vlan24
# Vlan25
# ==============
# Total count : 6
# ==============
# sonic#
# Using merged
#
# Before state:
# ------------
#
# sonic# show mclag brief
#
# Domain ID : 1
# Role : standby
# Session Status : down
# Peer Link Status : down
# Source Address : 2.2.2.2
# Peer Address : 1.1.1.1
# Session Vrf : mgmt
# Peer Link : PortChannel1
# Keepalive Interval : 1 secs
# Session Timeout : 3 secs
# Delay Restore : 240 secs
# System Mac : 20:04:0f:37:bd:c9
# Mclag System Mac : 00:00:00:11:11:11
# Gateway Mac : 00:00:00:12:12:12
#
#
# Number of MLAG Interfaces:1
#-----------------------------------------------------------
# MLAG Interface Local/Remote Status
#-----------------------------------------------------------
# PortChannel10 down/down
#
# sonic# show mclag separate-ip-interfaces
# Interface Name
# ==============
# Vlan4
# Vlan21
# Vlan22
# Vlan23
# Vlan24
# Vlan25
# ==============
# Total count : 6
# ==============
# sonic#
# sonic# show mclag peer-gateway-interfaces
# Interface Name
# ==============
# Vlan4
# Vlan21
# Vlan22
# Vlan23
# Vlan24
# Vlan25
# ==============
# Total count : 6
# ==============
# sonic#
- name: Merge device configuration with the provided configuration
dellemc.enterprise_sonic.sonic_mclag:
config:
domain_id: 1
source_address: 3.3.3.3
keepalive: 10
session_timeout: 30
session_vrf: VrfRed
delay_restore: 360
unique_ip:
vlans:
- vlan: Vlan5
- vlan: Vlan26-28
peer_gateway:
vlans:
- vlan: Vlan5
- vlan: Vlan26-28
members:
portchannels:
- lag: PortChannel12
state: merged
# After state:
# ------------
#
# sonic# show mclag brief
#
# Domain ID : 1
# Role : standby
# Session Status : down
# Peer Link Status : down
# Source Address : 3.3.3.3
# Peer Address : 1.1.1.1
# Session Vrf : VrfRed
# Peer Link : PortChannel1
# Keepalive Interval : 10 secs
# Session Timeout : 30 secs
# Delay Restore : 360 secs
# System Mac : 20:04:0f:37:bd:c9
# Mclag System Mac : 00:00:00:11:11:11
# Gateway Mac : 00:00:00:12:12:12
#
#
# Number of MLAG Interfaces:2
#-----------------------------------------------------------
# MLAG Interface Local/Remote Status
#-----------------------------------------------------------
# PortChannel10 down/down
# PortChannel12 down/down
#
# sonic# show mclag separate-ip-interfaces
# Interface Name
# ==============
# Vlan4
# Vlan5
# Vlan21
# Vlan22
# Vlan23
# Vlan24
# Vlan25
# Vlan26
# Vlan27
# Vlan28
# ==============
# Total count : 10
# ==============
# sonic# show mclag peer-gateway-interfaces
# Interface Name
# ==============
# Vlan4
# Vlan5
# Vlan21
# Vlan22
# Vlan23
# Vlan24
# Vlan25
# Vlan26
# Vlan27
# Vlan28
# ==============
# Total count : 10
# ==============
# sonic#
# Using deleted
#
# Before state:
# ------------
#
# sonic# show mclag brief
#
# Domain ID : 1
# Role : standby
# Session Status : down
# Peer Link Status : down
# Source Address : 3.3.3.3
# Peer Address : 1.1.1.1
# Session Vrf : VrfRed
# Peer Link : PortChannel1
# Keepalive Interval : 10 secs
# Session Timeout : 30 secs
# Delay Restore : 360 secs
# System Mac : 20:04:0f:37:bd:c9
# Mclag System Mac : 00:00:00:11:11:11
# Gateway Mac : 00:00:00:12:12:12
#
#
# Number of MLAG Interfaces:1
#-----------------------------------------------------------
# MLAG Interface Local/Remote Status
#-----------------------------------------------------------
# PortChannel10 down/down
#
# sonic# show mclag separate-ip-interfaces
# Interface Name
# ==============
# Vlan4
# Vlan21
# Vlan22
# Vlan23
# Vlan24
# Vlan25
# ==============
# Total count : 6
# ==============
# sonic#
# sonic# show mclag peer-gateway-interfaces
# Interface Name
# ==============
# Vlan4
# Vlan21
# Vlan22
# Vlan23
# Vlan24
# Vlan25
# ==============
# Total count : 6
# ==============
# sonic#
- name: Delete device configuration based on the provided configuration
dellemc.enterprise_sonic.sonic_mclag:
config:
domain_id: 1
source_address: 3.3.3.3
keepalive: 10
session_vrf: VrfRed
unique_ip:
vlans:
- vlan: Vlan22
- vlan: Vlan24-25
peer_gateway:
vlans:
- vlan: Vlan22
- vlan: Vlan24-25
members:
portchannels:
- lag: PortChannel10
state: deleted
# After state:
# ------------
#
# sonic# show mclag brief
#
# Domain ID : 1
# Role : standby
# Session Status : down
# Peer Link Status : down
# Source Address :
# Peer Address : 1.1.1.1
# Session Vrf : default
# Peer Link : PortChannel1
# Keepalive Interval : 1 secs
# Session Timeout : 30 secs
# Delay Restore : 360 secs
# System Mac : 20:04:0f:37:bd:c9
# Mclag System Mac : 00:00:00:11:11:11
# Gateway Mac : 00:00:00:12:12:12
#
#
# Number of MLAG Interfaces:0
#
# sonic# show mclag separate-ip-interfaces
# Interface Name
# ==============
# Vlan4
# Vlan21
# Vlan23
# ==============
# Total count : 3
# ==============
# sonic#
# sonic# show mclag peer-gateway-interfaces
# Interface Name
# ==============
# Vlan4
# Vlan21
# Vlan23
# ==============
# Total count : 3
# ==============
# sonic#
# Using deleted
#
# Before state:
# ------------
#
# sonic# show mclag brief
#
# Domain ID : 1
# Role : standby
# Session Status : down
# Peer Link Status : down
# Source Address : 3.3.3.3
# Peer Address : 1.1.1.1
# Session Vrf : default
# Peer Link : PortChannel1
# Keepalive Interval : 10 secs
# Session Timeout : 30 secs
# Delay Restore : 360 secs
# System Mac : 20:04:0f:37:bd:c9
# Mclag System Mac : 00:00:00:11:11:11
# Gateway Mac : 00:00:00:12:12:12
#
#
# Number of MLAG Interfaces:1
#-----------------------------------------------------------
# MLAG Interface Local/Remote Status
#-----------------------------------------------------------
# PortChannel10 down/down
#
# sonic# show mclag separate-ip-interfaces
# Interface Name
# ==============
# Vlan4
# ==============
# Total count : 1
# ==============
# sonic#
# sonic# show mclag peer-gateway-interfaces
# Interface Name
# ==============
# Vlan4
# ==============
# Total count : 1
# ==============
# sonic#
- name: Delete all device configuration
dellemc.enterprise_sonic.sonic_mclag:
config:
state: deleted
# After state:
# ------------
#
# sonic# show mclag brief
# MCLAG Not Configured
# sonic# show mclag separate-ip-interfaces
# MCLAG separate IP interface not configured
# sonic# show mclag peer-gateway-interfaces
# MCLAG Peer Gateway interface not configured
# sonic#
# Using deleted
#
# Before state:
# ------------
#
# sonic# show mclag brief
#
# Domain ID : 1
# Role : standby
# Session Status : down
# Peer Link Status : down
# Source Address : 3.3.3.3
# Peer Address : 1.1.1.1
# Session Vrf : default
# Peer Link : PortChannel1
# Keepalive Interval : 10 secs
# Session Timeout : 30 secs
# Delay Restore : 360 secs
# System Mac : 20:04:0f:37:bd:c9
# Mclag System Mac : 00:00:00:11:11:11
# Gateway Mac : 00:00:00:12:12:12
#
#
# Number of MLAG Interfaces:2
#-----------------------------------------------------------
# MLAG Interface Local/Remote Status
#-----------------------------------------------------------
# PortChannel10 down/down
# PortChannel12 down/down
#
# sonic# show mclag separate-ip-interfaces
# Interface Name
# ==============
# Vlan4
# ==============
# Total count : 1
# ==============
# sonic#
# sonic# show mclag peer-gateway-interfaces
# Interface Name
# ==============
# Vlan4
# ==============
# Total count : 1
# ==============
# sonic#
- name: Delete device configuration based on the provided configuration
dellemc.enterprise_sonic.sonic_mclag:
config:
domain_id: 1
source_address: 3.3.3.3
keepalive: 10
peer_gateway:
vlans:
members:
portchannels:
state: deleted
# After state:
# ------------
#
# sonic# show mclag brief
#
# Domain ID : 1
# Role : standby
# Session Status : down
# Peer Link Status : down
# Source Address :
# Peer Address : 1.1.1.1
# Session Vrf : default
# Peer Link : PortChannel1
# Keepalive Interval : 1 secs
# Session Timeout : 30 secs
# Delay Restore : 360 secs
# System Mac : 20:04:0f:37:bd:c9
# Mclag System Mac : 00:00:00:11:11:11
# Gateway Mac : 00:00:00:12:12:12
#
#
# Number of MLAG Interfaces:0
#
# sonic# show mclag separate-ip-interfaces
# Interface Name
# ==============
# Vlan4
# ==============
# Total count : 1
# ==============
# sonic#
# sonic# show mclag peer-gateway-interfaces
# MCLAG Peer Gateway interface not configured
# sonic#
# Using replaced
#
# Before state:
# ------------
#
# sonic# show mclag brief
#
# Domain ID : 1
# Role : standby
# Session Status : down
# Peer Link Status : down
# Source Address : 2.2.2.2
# Peer Address : 1.1.1.1
# Session Vrf : VrfRed
# Peer Link : PortChannel1
# Keepalive Interval : 1 secs
# Session Timeout : 3 secs
# Delay Restore : 240 secs
# System Mac : 20:04:0f:37:bd:c9
# Mclag System Mac : 00:00:00:11:11:11
# Gateway Mac : 00:00:00:12:12:12
#
#
# Number of MLAG Interfaces:2
#-----------------------------------------------------------
# MLAG Interface Local/Remote Status
#-----------------------------------------------------------
# PortChannel10 down/down
# PortChannel11 down/down
#
# sonic# show mclag separate-ip-interfaces
# Interface Name
# ==============
# Vlan4
# Vlan21
# Vlan22
# Vlan23
# Vlan24
# Vlan25
# ==============
# Total count : 6
# ==============
# sonic#
# sonic# show mclag peer-gateway-interfaces
# Interface Name
# ==============
# Vlan4
# Vlan21
# Vlan22
# Vlan23
# Vlan24
# Vlan25
# ==============
# Total count : 6
# ==============
# sonic#
- name: Replace device configuration with the provided configuration
dellemc.enterprise_sonic.sonic_mclag:
config:
domain_id: 1
unique_ip:
vlans:
- vlan: Vlan5
- vlan: Vlan24-28
session_vrf: VrfBlue
peer_gateway:
vlans:
- vlan: Vlan5
- vlan: Vlan24-28
members:
portchannels:
- lag: PortChannel10
- lag: PortChannel12
state: replaced
# After state:
# ------------
#
# sonic# show mclag brief
#
# Domain ID : 1
# Role : standby
# Session Status : down
# Peer Link Status : down
# Source Address : 2.2.2.2
# Peer Address : 1.1.1.1
# Session Vrf : VrfBlue
# Peer Link : PortChannel1
# Keepalive Interval : 1 secs
# Session Timeout : 3 secs
# Delay Restore : 240 secs
# System Mac : 20:04:0f:37:bd:c9
# Mclag System Mac : 00:00:00:11:11:11
# Gateway Mac : 00:00:00:12:12:12
#
#
# Number of MLAG Interfaces:2
#-----------------------------------------------------------
# MLAG Interface Local/Remote Status
#-----------------------------------------------------------
# PortChannel10 down/down
# PortChannel12 down/down
#
# sonic# show mclag separate-ip-interfaces
# Interface Name
# ==============
# Vlan5
# Vlan24
# Vlan25
# Vlan26
# Vlan27
# Vlan28
# ==============
# Total count : 6
# ==============
# sonic# show mclag peer-gateway-interfaces
# Interface Name
# ==============
# Vlan5
# Vlan24
# Vlan25
# Vlan26
# Vlan27
# Vlan28
# ==============
# Total count : 6
# ==============
# sonic#
# Using overridden
#
# Before state:
# ------------
#
# sonic# show mclag brief
#
# Domain ID : 1
# Role : standby
# Session Status : down
# Peer Link Status : down
# Source Address : 2.2.2.2
# Peer Address : 1.1.1.1
# Session Vrf : VrfBlue
# Peer Link : PortChannel1
# Keepalive Interval : 1 secs
# Session Timeout : 3 secs
# Delay Restore : 240 secs
# System Mac : 20:04:0f:37:bd:c9
# Mclag System Mac : 00:00:00:11:11:11
# Gateway Mac : 00:00:00:12:12:12
#
#
# Number of MLAG Interfaces:2
#-----------------------------------------------------------
# MLAG Interface Local/Remote Status
#-----------------------------------------------------------
# PortChannel10 down/down
# PortChannel11 down/down
#
# sonic# show mclag separate-ip-interfaces
# Interface Name
# ==============
# Vlan4
# Vlan21
# Vlan22
# Vlan23
# Vlan24
# Vlan25
# ==============
# Total count : 6
# ==============
# sonic#
# sonic# show mclag peer-gateway-interfaces
# Interface Name
# ==============
# Vlan4
# Vlan21
# Vlan22
# Vlan23
# Vlan24
# Vlan25
# ==============
# Total count : 6
# ==============
# sonic#
- name: Override device configuration with the provided configuration
dellemc.enterprise_sonic.sonic_mclag:
config:
domain_id: 1
peer_address: 1.1.1.1
source_address: 3.3.3.3
peer_link: 'Portchannel1'
session_vrf: VrfRed
system_mac: '00:00:00:11:11:11'
gateway_mac: '00:00:00:12:12:12'
unique_ip:
vlans:
- vlan: Vlan24-28
peer_gateway:
vlans:
- vlan: Vlan24-28
members:
portchannels:
- lag: PortChannel10
- lag: PortChannel12
state: overridden
# After state:
# ------------
#
# sonic# show mclag brief
#
# Domain ID : 1
# Role : standby
# Session Status : down
# Peer Link Status : down
# Source Address : 3.3.3.3
# Peer Address : 1.1.1.1
# Session Vrf : VrfRed
# Peer Link : PortChannel1
# Keepalive Interval : 1 secs
# Session Timeout : 30 secs
# Delay Restore : 300 secs
# System Mac : 20:04:0f:37:bd:c9
# Mclag System Mac : 00:00:00:11:11:11
# Gateway Mac : 00:00:00:12:12:12
#
#
# Number of MLAG Interfaces:2
#-----------------------------------------------------------
# MLAG Interface Local/Remote Status
#-----------------------------------------------------------
# PortChannel10 down/down
# PortChannel12 down/down
#
# sonic# show mclag separate-ip-interfaces
# Interface Name
# ==============
# Vlan24
# Vlan25
# Vlan26
# Vlan27
# Vlan28
# ==============
# Total count : 5
# ==============
# sonic# show mclag peer-gateway-interfaces
# Interface Name
# ==============
# Vlan24
# Vlan25
# Vlan26
# Vlan27
# Vlan28
# ==============
# Total count : 5
# ==============
# sonic#
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Description |
|---|---|
after list / elements=string | The resulting configuration module invocation. Returned: when changed Sample: |
before list / elements=string | The configuration prior to the module invocation. Returned: always Sample: |
commands list / elements=string | The set of commands pushed to the remote device. Returned: always Sample: |
Collection links
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/enterprise_sonic/sonic_mclag_module.html