Layer-2 Routing Information Base (L2RIB) DMEization

The following is a list of commands that support DME for L2RIB feature:

L2Route EVPN Startup-route All Detail

L2Route EVPN Startup-route All Detail 

POST http://<mgmt0_IP>/api/mo/sys/pltfm.json

{
  "l2ribEs": {
    "attributes": {
      "dn": "sys/l2rib/inst/topology/topo-10/es",
      "modTs": "2024-06-28T11:03:17.791+00:00"
    },
    "children": [
      {
        "l2ribEsEntry": {
          "attributes": {
            "dfElection": "Per Flow",
            "dn": "sys/l2rib/inst/topology/topo-10/es/es-0312.1211.1112.1200.001c-prod-VXLAN-origin-[192.168.22.22]",
            "esi": "0312.1211.1112.1200.001c",
            "ifHandle": "Ifindex 1234",
            "modTs": "2024-06-28T11:03:28.083+00:00",
            "originIp": "192.168.22.22",
            "prodName": "VXLAN",
            "sentTo": ""
          }
        }
      }
    ]
  }
}

{
    imdata:[]
}

Note: This example was added in Release 10.5(2)F.


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.

show l2route evpn startup-route all detail


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.

MODN
startup sys/l2rib/inst/topology/topo-/startup


Properties

The following table contains information about the 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 NameData Type
topoIdscalar:Uint32
srcIpaddress:Ip
grpIpaddress:Ip
fabricDelivSrcIpaddress:Ip
fabricDelivGrpIpaddress:Ip
dciDelivSrcIpaddress:Ip
dciDelivGrpIpaddress:Ip
flagsStartupRtFlagsT


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

1. L2RIB Producers

Show Command

show l2rib producers

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.

MODN
producersys/l2rib/inst/producers

Properties

DN: sys/l2rib/inst/producers/prod-[name]-id-[id]-client-[clientId]-obj-[objType]

PropertyDefault ValueDME-Type
clientId0scalar:ubyte
flags0scalar:uUint32
id0scalar:uUint32
name""string:Basic
objType""string:Basic
purgeTime0scalar:uUint32
state""ProducerStT

CLI Output

Producer IDClient IDObject TypeAdmin DistPurge TimeState
VXLAN (011)4Topology00Initial
Static (002)1MAC5600000Converged
Local (003)1MAC5600000Converged
VXLAN (011)4MAC00Initial
VXLAN (011)4EAD00Initial
UFDM (015)2EVPN_PL00Initial
VXLAN (011)4IMET_ROUTE00Initial
VXLAN (011)4VXLAN_FL00Initial
VXLAN (011)4PEERID00Initial
VXLAN (011)4STARTUP-RT00Initial
VXLAN (011)4ES_ENTRY00Initial

2. L2RIB Registrations

Show Command

show l2rib registrations

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.

MODN
registrationssys/l2rib/inst/registrations

Properties

DN: sys/l2rib/inst/registrations/client-[name]

PropertyDefault ValueDME-Type
id0scalar:UByte
name""string:Basic

DN: sys/l2rib/inst/registrations/client[name]/topo-[id]-obj-[objType]

PropertyDME-Type
idstring:Basic
objTypestring:Basic
prodNamestring:Basic

CLI Output

Client IDTopology IDObject TypeProducer
0ALLMACMultiple
0ALLTopology(1)VXLAN
0ALLEVPN_PLUFDM
1ALLCMCAST_ROUTENGMVPN
2ALLTopo-child-attrVXLAN
3ALLEVPN_PLNone
4ALLTopology(1)VXLAN

3. L2Route MAC All Detail

Show Command

show l2route mac all detail

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.

MODN
Macsys/l2rib/inst/topology/topo-[topo id]/mac

Properties

DN: sys/l2rib/inst/topology/topo-[topoId]/mac/mac_entry-[macAddr]

PropertyDME-Type
macAddraddress:Mac

DN: sys/l2rib/inst/topology/topo-[topoId]/mac/mac_entry-[macAddr]/prod-[producer]

PropertyDME-Type
esiString:basic
flagsMacRtFlagsT
fwdStString:basic
genericFlagsGenericFlagsT
macAddradress:MAC
pcInfoString:basic
producerString:basic
rtResolutionMacRtResolutionT
sentToString:basic
seqNoscalar:unit32
siteOriginString:basic
topoIdscalar:unit32

DN: sys/l2rib/inst/topology/topo-[topoId]/mac/mac-[macAddr]/producer-[producer]/nexthops

DN: sys/l2rib/inst/topology/topo-[topoId]/mac/mac-[macAddr]/producer-[producer]/nexthops/nh-[nh]-type-[type]

PropertyDME-TypeDefault Value
nhString:basic""
typel2rib:MacRtNhTypeT""
labelscalar:Uint32"0"
weightscalar:Uint32"0"

CLI Output

TopologyMac AddressProdFlagsSeq NoNext-Hops
1000000.0022.2221BGPRcv55.5.5.5 (Label: 20000) 55.55.55.55 (Label:20000)
Route Resolution Type: ESI
Forwarding State: Resolved (PL)
Resultant PL: 5.5.5.5
Sent To: L2FM
ESI : aaaa.aaaa.aaaa.aaaa.99aa
SOO: 775237173
Port-Channel Info: Ifindex 6789

4. L2Route MAC-IP All Detail

Show Command

show l2route mac-ip all detail

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.

MODN
MacIpsys/l2rib/inst/topology/topo-[topo id]/mac-ip

Properties

DN: sys/l2rib/inst/topology/topo-[topo-id]/macip/macip_entry-[macAddr]

PropertyDefault ValueDME-Type
macAddr""address:MAC
ip""address:Ip

DN: sys/l2rib/inst/topology/topo-[topoId]/macip/macip_entry-[macAddr]/prod-[producer]

PropertyDefault ValueDME-Type
esi""string:Basic
flags""MacIpRtFlagsT
genericFlags""genericFlagsT
hostIp0address:ip
l3TopoId0scalar:unit32
macAddr0address:MAC
nh""string:Basic
pcInfo""string:Basic
peerId0scalar:unit32
peerIfIdx0scalar:unit64
producer""string:Basic
sentTo""string:Basic
seqNo0scalar:unit32
siteOrigin""string:Basic
topoId0scalar:unit32

CLI Output

TopologyMac AddressHost IPProdFlagSeq NoNext-Hops
1000000.0002.22225.5.5.5BGPL25.5.5.5(Label:20000)
L3-Info: 42
ESI : aaaa.aaaa.aaaa.aaaa.99aa
SOO: 774909488
Port-Channel Info: Ifindex 6789

5. L2Route FL All Detail

Show Command

show l2route fl all detail

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.

MODN
FloodListsys/l2rib/inst/topology/topo-[topo id]/floodlist

Properties

DN: sys/l2rib/inst/topology/topo-[topoId]/floodlist/fl-ip

PropertyDefault ValueDME-Type
peerId0scalar:Unit32
ip0scalar:Unit32
sentTo""string:Basic
serviceNodenoscalar:Bool
topoId0scalar:Unit32

CLI Output

TopologyIDPeer-idFlood ListLabel(VNI)Service NodeNFN Bitmap
1001005.5.5.50no96
1002006.6.6.60no96
10050055.55.55.550no96

6. L2Route PeerID

Show Command

show l2route peerid

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.

MODN
Peerssys/l2rib/inst/peers

Properties

DN: sys/l2rib/inst/peers/peer-[ifName]-[ip]

PropertyDefault ValueDME-Type
id0scalar:Unit32
ifHdl0scalar:Unit64
ifName""string:Basic
ip0address:ip
numMac0scalar:Unit32
numNh0scalar:Unit32
peerIfIdx0scalar:Unit64

CLI Output

NVE IFhdlIP AddressPeerIDIfindexNum of MAC's
12345.5.5.510010050

7. L2Route Summary

Show Command

show l2route summary

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.

MODN
Summarysys/l2rib/inst/summary

Properties

DN: sys/l2rib/inst/summary

PropertyDefault ValueDME-Type
totalSize0scalar:Unit32
cnvrgdTblCnt0scalar:Unit32

DN: sys/l2rib/inst/summary/obj-[objName]

PropertyDefault ValueDME-Type
numObj0scalar:Unit32
ObjName""string:Basic
size0scalar:Unit32

DN: sys/l2rib/inst/summary/obj-[objName]/prod-[prodName]

PropertyDefault ValueDME-Type
id0scalar:Unit32
numObj0scalar:Unit32
prodName""string:Basic
size0scalar:Unit32

CLI Output

L2ROUTE Summary Total Memory: 872 Number of Converged Tables: 49

Table Name: Topology

Producer(ID)ObjectsMemory(Bytes)
VXLAN(11)1376
Total1376

Table Name: PEERID

Producer(ID)ObjectsMemory(Bytes)
VXLAN(11)2496
Total2496

8. L2Route EVPN EAD All Detail

Show Command

show l2route evpn ead all detail

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.

MODN
Eadsys/l2rib/inst/topology/topo-[topo-id]/ead

Properties

DN: sys/l2rib/inst/topology/topo-[topoId]/ead/ead_entry-[esi]

PropertyDME-Type
esistring:Basic

DN: sys/l2rib/inst/topology/topo-[topoId]/ead/ead_entry-[esi]/prod-[prodname]

PropertyDefault ValueDME-Type
numHops0scalar:Unit32
numPls0scalar:Unit32
prodName""string:Basic
sentTo""string:Basic
topoId0scalar:Unit32

DN: sys/l2rib/inst/topology/topo-[topoId]/ead/ead_entry-[esi]/prod-[prodName]/nexthops

DN: sys/l2rib/inst/topology/topo-[topoId]/ead/ead_entry-[esi]/prod-[prodName]/nexthops/nh-[nh]

PropertyDME-TypeDefault Value
nhstring:Basic""
labelscalar:Uint32"0"
weightscalar:Uint32"0"

CLI Output

Topology IDProdESINFN BitmapNum PLsFlags
4294967294 VXLAN 0301.0101.0101.0100.0001 0 0 -

9. L2Route EVPN EAD Ethernet-segment All Detail

Show Command

show l2route evpn ethernet-segment all detail

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.

MODN
Essys/l2rib/inst/topology/topo-[topo-id]/es

Properties

DN: sys/l2rib/inst/topology/topo-[topoId]/es/es-[esi]-prod-[prodName]-origin-[originIp]

Property
esi
ifHandle
prodName
originIp
sentTo

CLI Output

ESIOrig RtrIP AddrProdIfindexNFN Bitmap
0301.0101.0101.0100.00011.2.3.4VXLANIfindex 12340
aaaa.aaaa.aaaa.aaaa.99aa1.2.3.4VXLANIfindex 12340
0301.0101.0101.0100.00011.2.3.4VXLANIfindex 12340

10. L2Route EVPN Path-list All Detail

Show Command

show l2route evpn path-list all detail

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.

MODN
Plsys/l2rib/inst/topology/topo-[topo-id]/pl

Properties

DN: sys/l2rib/inst/topology/topo-[topoId]/pl/pl-[esi]-prod-[prodName]-type-[rtType]-cpnh-[cpNh]

PropertyDefault ValueDME-Type
clientCtx0scalar:Unit32
cpNh""string:Basic
ecmpLabel0scalar:Unit32
esi""string:Basic
flags0scalar:Unit32
prodName""string:Basic
rtType""l2rib:MacRtResolutionT
sentTo""string:Basic
topoId0scalar:Unit32
numMac0scalar:Uint32

DN: sys/l2rib/inst/topology/topo-[topoId]/pl/pl-[esi]-prod-[prodName]-type-[rtType]-cpnh-[cpNh]/nexthops

DN: sys/l2rib/inst/topology/topo-[topoId]/pl/pl-[esi]-prod-[prodName]-type-[rtType]-cpnh-[cpNh]/nexthops/nh-[nh]-type-[type]

PropertyDME-TypeDefault Value
nhstring:Basic""
typel2rib:PlNhTypeT""
labelscalar:Uint32"0"
weightscalar:Uint32"0"
peerIdscalar:Uint32"0"
peerIdResStatel2rib:PeerResolutionStateT""

CLI Output

Topology IDProdESIECMPLabel FlagsClientCtxMACsNFN Bitmap
100Noneaaaa.aaaa.aaaa.aaaa.99aa12252610560018
CP Next-Hops: 5.5.5.5, 55.55.55.55
Gbl EAD Next-Hops: 5.5.5.5(100,R)
55.55.55.55(500,R)
Res Next-Hops: 5.5.5.5, 55.55.55.55
Res Next-Hops from UFDM: 5.5.5.5
100UFDMaaaa.aaaa.aaaa.aaaa.99aa12252610560149317222502
CP Next-Hops: 5.5.5.5, 55.55.55.55
Gbl EAD Next-Hops: Res Next-Hops: 5.5.5.5

11. L2Route EVPN Imet All Detail

Show Command

show l2route evpn imet all detail

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.

MODN
Imetsys/l2rib/inst/topology/topo-[topo-id]/imet

Properties

DN: sys/l2rib/inst/topology/topo-[topoId]/imet/pro-[Prodname]

PropertyDME-TypeDefault Value
prodName""string:Basic

DN: sys/l2rib/inst/topology/topo-[topoId]/imet/prod-[prodName]/imet-[ip]-imetlabel-[imetlabel]-tag-[ethTagid]-encap-[encapType]

PropertyDME-TypeDefault Value
encapTypescalar:uint160
ethTagIdscalar:uint320
imetLabelscalar:uint320
ipaddress:ip""
originImetRtOriginunknown
pmsiFlagsscalar:uint320
psmiTypescalar:uint320
prodNamestring:Basic""
sentTostring:Basic""
topoIdscalar:Unit320
tunnelIdstring:Basic""
vniscalar:Unit320
teFlagstring:Basic""
vrfId scalar:Uint320

CLI Output

Topology IDVNIProdIPAddrEth TagPMSI-FlagsFlagsTypeLabel(VNI)TunnelIDNFN Bitmap
10020000BGP5.5.5.503-6200001.13.101.25016

show l2route evpn mac evi 1001 detail

show l2route evpn mac evi 1001 detail

POST http://<mgmt0_IP>/api/mo/sys.json



{
    imdata:[]
}

<model>
<package name="nvo">
<primitives>
<type name="EpIdT"
base="scalar:Uint32">
</type>
……
<type
name="DciAdvertisePipStateT"
base="scalar:Enum16">
<const name="disable"
value="0" label="Disables advertise PIP
towards DCI in BGP for multisite."/>
<const name="enable" value="1"
label="Enables PIP towards DCI in BGP for
multisite."/>
<default value="disable"/>
</type>


CLI Command

The CLI command below is the equivalent of the payload example 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 or the YANG tab to view the XML payload.

show l2route evpn mac evi 1001 detail

Note: The property information for this example was added in Release 10.5(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
EvpnMultisiteBordergw


Properties

The following table contains information about the 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 NameData TypeValueType
state--MultisiteStateT
siteIdscalar:Enum8Supported values are 1 to 281474976710655.scalar:Uint64
dciAdvertisePip--DciAdvertisePipStateT
delayRestoreTime-range min="30" max="1000" default value="180"scalar:Uint16
nvo--type name="EpIdT" base="scalar:Uint32
DciAdvertisePipStateT--scalar:Enum16
disable--value="0"
enable--value="1"


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html