dellemc.enterprise_sonic.sonic_mac module – Manage MAC configuration on SONiC
Note
This module is part of the dellemc.enterprise_sonic collection (version 2.4.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 dellemc.enterprise_sonic.
To use it in a playbook, specify: dellemc.enterprise_sonic.sonic_mac.
New in dellemc.enterprise_sonic 2.1.0
Synopsis
This module provides configuration management of MAC for devices running SONiC
Parameters
Parameter |
Comments |
|---|---|
A list of MAC configurations. |
|
Configuration attributes for MAC. |
|
Time in seconds of inactivity before the MAC entry is timed out. Default: |
|
Interval for which mac movements are observed before disabling MAC learning on a port. Default: |
|
Number of MAC movements allowed per second before disabling MAC learning on a port. Default: |
|
Configuration attributes for MAC table entries. |
|
Specifies the interface for the MAC table entry. |
|
MAC address for the dynamic or static MAC table entry. |
|
ID number of VLAN on which the MAC address is present. |
|
Specifies the VRF name. Default: |
|
The state of the configuration after module completion Choices:
|
Examples
# Using merged
#
# Before state:
# -------------
#
# sonic# show mac dampening
# MAC Move Dampening Threshold : 5
# MAC Move Dampening Interval : 5
# sonic# show running-configuration | grep mac
# (No mac configuration pressent)
- name: Merge MAC configurations
dellemc.enterprise_sonic.sonic_mac:
config:
- vrf_name: 'default'
mac:
aging_time: 50
dampening_interval: 20
dampening_threshold: 30
mac_table_entries:
- mac_address: '00:00:5e:00:53:af'
vlan_id: 1
interface: 'Ethernet20'
- mac_address: '00:33:33:33:33:33'
vlan_id: 2
interface: 'Ethernet24'
- mac_address: '00:00:4e:00:24:af'
vlan_id: 3
interface: 'Ethernet28'
state: merged
# After state:
# ------------
#
# sonic# show mac dampening
# MAC Move Dampening Threshold : 30
# MAC Move Dampening Interval : 20
# sonic# show running-configuration | grep mac
# mac address-table 00:00:5e:00:53:af Vlan1 Ethernet20
# mac address-table 00:33:33:33:33:33 Vlan2 Ethernet24
# mac address-table 00:00:4e:00:24:af Vlan3 Ethernet28
# mac address-table aging-time 50
#
#
# Using replaced
#
# Before state:
# -------------
#
# sonic# show mac dampening
# MAC Move Dampening Threshold : 30
# MAC Move Dampening Interval : 20
# sonic# show running-configuration | grep mac
# mac address-table 00:00:5e:00:53:af Vlan1 Ethernet20
# mac address-table 00:33:33:33:33:33 Vlan2 Ethernet24
# mac address-table 00:00:4e:00:24:af Vlan3 Ethernet28
# mac address-table aging-time 50
- name: Replace MAC configurations
dellemc.enterprise_sonic.sonic_mac:
config:
- vrf_name: 'default'
mac:
aging_time: 45
dampening_interval: 30
dampening_threshold: 60
mac_table_entries:
- mac_address: '00:00:5e:00:53:af'
vlan_id: 3
interface: 'Ethernet24'
- mac_address: '00:44:44:44:44:44'
vlan_id: 2
interface: 'Ethernet20'
state: replaced
# sonic# show mac dampening
# MAC Move Dampening Threshold : 60
# MAC Move Dampening Interval : 30
# sonic# show running-configuration | grep mac
# mac address-table 00:00:5e:00:53:af Vlan3 Ethernet24
# mac address-table 00:33:33:33:33:33 Vlan2 Ethernet24
# mac address-table 00:00:4e:00:24:af Vlan3 Ethernet28
# mac address-table 00:44:44:44:44:44 Vlan2 Ethernet20
# mac address-table aging-time 45
#
#
# Using overridden
#
# Before state:
# -------------
#
# sonic# show mac dampening
# MAC Move Dampening Threshold : 60
# MAC Move Dampening Interval : 30
# sonic# show running-configuration | grep mac
# mac address-table 00:00:5e:00:53:af Vlan3 Ethernet24
# mac address-table 00:33:33:33:33:33 Vlan2 Ethernet24
# mac address-table 00:00:4e:00:24:af Vlan3 Ethernet28
# mac address-table 00:44:44:44:44:44 Vlan2 Ethernet20
# mac address-table aging-time 45
- name: Override MAC cofigurations
dellemc.enterprise_sonic.sonic_mac:
config:
- vrf_name: 'default'
mac:
aging_time: 10
dampening_interval: 20
dampening_threshold: 30
mac_table_entries:
- mac_address: '00:11:11:11:11:11'
vlan_id: 1
interface: 'Ethernet20'
- mac_address: '00:22:22:22:22:22'
vlan_id: 2
interface: 'Ethernet24'
state: overridden
# After state:
# ------------
#
# sonic# show mac dampening
# MAC Move Dampening Threshold : 30
# MAC Move Dampening Interval : 20
# sonic# show running-configuration | grep mac
# mac address-table 00:11:11:11:11:11 Vlan1 Ethernet20
# mac address-table 00:22:22:22:22:22 Vlan2 Ethernet24
# mac address-table aging-time 10
#
#
# Using deleted
#
# Before state:
# -------------
#
# sonic# show mac dampening
# MAC Move Dampening Threshold : 30
# MAC Move Dampening Interval : 20
# sonic# show running-configuration | grep mac
# mac address-table 00:11:11:11:11:11 Vlan1 Ethernet20
# mac address-table 00:22:22:22:22:22 Vlan2 Ethernet24
# mac address-table aging-time 10
- name: Delete MAC cofigurations
dellemc.enterprise_sonic.sonic_mac:
config:
- vrf_name: 'default'
mac:
aging_time: 10
dampening_interval: 20
dampening_threshold: 30
mac_table_entries:
- mac_address: '00:11:11:11:11:11'
vlan_id: 1
interface: 'Ethernet20'
- mac_address: '00:22:22:22:22:22'
vlan_id: 2
interface: 'Ethernet24'
state: deleted
# After state:
# ------------
#
# sonic# show mac dampening
# MAC Move Dampening Threshold : 5
# MAC Move Dampening Interval : 5
# sonic# show running-configuration | grep mac
# (No mac configuration pressent)
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The resulting configuration model invocation. Returned: when changed Sample: |
|
The configuration prior to the model invocation. Returned: always Sample: |
|
The set of commands pushed to the remote device. Returned: always Sample: |