Configuring a MAC Address Table
Configuring a Static MAC Entry
Configuring a Static MAC Entry
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"l2Macs": {
"children": [
{
"l2Static": {
"children": [
{
"l2StaticEntry": {
"attributes": {
"dropAction": "no",
"interface": "eth1/2",
"staticMacAddress": "00:01:00:02:00:03",
"vlan": "vlan-123"
}
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<mac-items>
<static-items>
<vlan-items>
<StaticEntry-list>
<vlan>vlan-123</vlan>
<staticMacAddress>00:01:00:02:00:03</staticMacAddress>
<dropAction>false</dropAction>
<interface>eth1/2</interface>
</StaticEntry-list>
</vlan-items>
</static-items>
</mac-items>
</System>
Note: This example was added in Release 9.2(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
mac address-table static 1.2.3 vlan 123 interface ethernet 1/2
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
l2Macs | sys/mac |
l2Static | sys/mac/static |
l2StaticEntry | sys/mac/static/vlan-{[vlan]}-mac-{staticMacAddress} |
l2StaticEntry Properties
The following table contains information about the l2StaticEntry properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
dropAction | scalar:Bool | Drop | SELECTION: true or false DEFAULT: FALSE |
interface | nw:IfId (base:IfIndex) | Interface | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
staticMacAddress | address:MAC | MAC | Value must match MM:MM:MM:SS:SS:SS format |
vlan | base:Encap | Vlan | SELECTION: unknown, vlan-%d or vxlan-%d |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting a Static MAC Entry
Deleting a Static MAC Entry
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"l2Macs": {
"children": [
{
"l2Static": {
"children": [
{
"l2StaticEntry": {
"attributes": {
"staticMacAddress": "00:01:00:02:00:03",
"status": "deleted",
"vlan": "vlan-123"
}
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<mac-items>
<static-items>
<vlan-items>
<StaticEntry-list xc:operation="delete">
<vlan>vlan-123</vlan>
<staticMacAddress>00:01:00:02:00:03</staticMacAddress>
</StaticEntry-list>
</vlan-items>
</static-items>
</mac-items>
</System>
Note: This example was added in Release 9.2(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
mac address-table static 1.2.3 vlan 123 interface ethernet 1/2
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
l2Macs | sys/mac |
l2Static | sys/mac/static |
l2StaticEntry | sys/mac/static/vlan-{[vlan]}-mac-{staticMacAddress} |
l2StaticEntry Properties
The following table contains information about the l2StaticEntry properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
staticMacAddress | address:MAC | MAC | Value must match MM:MM:MM:SS:SS:SS format |
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
vlan | base:Encap | Vlan | SELECTION: unknown, vlan-%d or vxlan-%d |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring the MAC Address Table Aging Time
Configuring the MAC Address Table Aging Time
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"l2Macs": {
"attributes": {
"aging": "123"
}
}
}
]
}
}
{
imdata:[]
}
<System>
<mac-items>
<aging>123</aging>
</mac-items>
</System>
Note: This example was added in Release 9.2(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
mac address-table aging-time 123
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
l2Macs | sys/mac |
l2Macs Properties
The following table contains information about the l2Macs properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
aging | scalar:Uint32 | Aging time of Dynamic Mac Entries | RANGE: [0, 4294967295] DEFAULT: 1800 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting the MAC Address Table Aging Time
Deleting the MAC Address Table Aging Time
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"l2Macs": {
"attributes": {
"aging": "1800"
}
}
}
]
}
}
{
imdata:[]
}
<System>
<mac-items>
<aging>1800</aging>
</mac-items>
</System>
Note: This example was added in Release 9.2(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
no mac address-table aging-time 123
Note: The property information for this example was added in Release 9.3(3).
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
l2Macs | sys/mac |
l2Macs Properties
The following table contains information about the l2Macs properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
aging | scalar:Uint32 | Aging time of Dynamic Mac Entries | RANGE: [0, 4294967295] DEFAULT: 1800 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring Port-Down Action for MAC Loop Detection
Configuring Port-Down Action for MAC Loop Detection
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"l2fmEntity": {
"attributes": {
"macLoopDetect": "enable"
}}}]}}
{
imdata:[]
}
<System>
<l2fm-items>
<macLoopDetect>enable</macLoopDetect>
</l2fm-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
mac address-table loop-detect port-down
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
l2fmEntity | sys/l2fm |
l2fmEntity Properties
The following table contains information about the l2fmEntity properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
macLoopDetect | l2fm:LoopDetect (scalar:Enum8) | mac loop-detect port-down enable Disable | SELECTION: 0 - disable 1 - enable DEFAULT: disable |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting Port-Down Action for MAC Loop Detection
Deleting Port-Down Action for MAC Loop Detection
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"l2fmEntity": {
"attributes": {
"macLoopDetect": "disable"
}}}]}}
{
imdata:[]
}
<System>
<l2fm-items>
<macLoopDetect>disable</macLoopDetect>
</l2fm-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
no mac address-table loop-detect port-down
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
l2fmEntity | sys/l2fm |
l2fmEntity Properties
The following table contains information about the l2fmEntity properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
macLoopDetect | l2fm:LoopDetect (scalar:Enum8) | mac loop-detect port-down enable Disable | SELECTION: 0 - disable 1 - enable DEFAULT: disable |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring MAC-Move Notification on Syslog
Configuring MAC-Move Notification on Syslog
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"l2fmEntity": {
"attributes": {
"macMoveNotification": "enable"
}}}]}}
{
imdata:[]
}
<System>
<l2fm-items>
<macMoveNotification>enable</macMoveNotification>
</l2fm-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
mac address-table notification mac-move
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
l2fmEntity | sys/l2fm |
l2fmEntity Properties
The following table contains information about the l2fmEntity properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
macMoveNotification | l2fm:MacMoveNotification (scalar:Enum8) | mac move notification Enable disable | SELECTION: 0 - disable 1 - enable DEFAULT: enable |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting MAC-Move Notification on Syslog
Deleting MAC-Move Notification on Syslog
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"l2fmEntity": {
"attributes": {
"macMoveNotification": "disable"
}}}]}}
{
imdata:[]
}
<System>
<l2fm-items>
<macMoveNotification>disable</macMoveNotification>
</l2fm-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
no mac address-table notification mac-move
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
l2fmEntity | sys/l2fm |
l2fmEntity Properties
The following table contains information about the l2fmEntity properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
macMoveNotification | l2fm:MacMoveNotification (scalar:Enum8) | mac move notification Enable disable | SELECTION: 0 - disable 1 - enable DEFAULT: enable |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide: