Cisco Nexus 3000 and 9000 Series NX-API REST SDK API, Release 9.3(x)
NX-OS 9.3(x)
Querying RMON Dot3 Ethernet Statistics
DME
Copy
GET http://<IP_Address>/api/node/mo/sys/intf/phys-[eth3/2]/dbgDot3Stats.json

{
    "rmonDot3Stats": {
        "attributes": {
            "alignmentErrors": "0",
            "babble": "0",
            "carrierSenseErrors": "0",
            "childAction": "",
            "clearTs": "never",
            "controlInUnknownOpcodes": "0",
            "deferredTransmissions": "0",
            "dn": "sys/intf/phys-[eth3/2]/dbgDot3Stats",
            "excessiveCollisions": "0",
            "fCSErrors": "0",
            "frameTooLongs": "0",
            "inPauseFrames": "0",
            "inputdribble": "0",
            "internalMacReceiveErrors": "0",
            "internalMacTransmitErrors": "0",
            "lateCollisions": "0",
            "lostCarrierErrors": "0",
            "modTs": "never",
            "multipleCollisionFrames": "0",
            "noCarrierErrors": "0",
            "outPauseFrames": "0",
            "runts": "0",
            "sQETTestErrors": "0",
            "singleCollisionFrames": "0",
            "status": "",
            "symbolErrors": "0"
        }
    }
}

Querying Interface and VLAN Counters and Statistics

The NX-API REST provides HTTP GET requests that query interface statistics and VLAN statistics. The information returned from these queries is useful in monitoring the performance of the switch.

Querying RMON Dot3 Ethernet Statistics

Querying RMON Dot3 Ethernet Statistics

The HTTP request shown in this section shows how to query RMON Dot3 Ethernet Statistics for a specified Ethernet interface. For detailed information on Dot3 Ethernet Statistics, see RFC 3635, " Definitions of Managed Objects for the Ethernet-like Interface Types" at the following URL.

https://tools.ietf.org/html/rfc3635

Note: The property information for this example was added in Release 9.3(3).


rmonDot3Stats Properties

The following table contains information about the rmonDot3Stats 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 TypeDescriptionValues
alignmentErrorsscalar:Uint64
The alignment errors.RANGE: [0, 18446744073709551615]
babblescalar:Uint64
babble countRANGE: [0, 18446744073709551615]
carrierSenseErrorsscalar:Uint64
The carrier sense errors.RANGE: [0, 18446744073709551615]
childAction
mo:ModificationChildAction
scalar:Bitmask32		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • clearTsscalar:Date
    		Clear timestampDATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
    DEFAULT: never
    controlInUnknownOpcodesscalar:Uint64
    		The control input unknown opcodes.RANGE: [0, 18446744073709551615]
    deferredTransmissionsscalar:Uint64
    		The deferred transmissions.RANGE: [0, 18446744073709551615]
    dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    excessiveCollisionsscalar:Uint64
    		The excessive collisions.RANGE: [0, 18446744073709551615]
    fCSErrorsscalar:Uint64
    		The frame check sequence errors.RANGE: [0, 18446744073709551615]
    frameTooLongsscalar:Uint64
    		The frame too longs.RANGE: [0, 18446744073709551615]
    inPauseFramesscalar:Uint64
    		The input pause frames.RANGE: [0, 18446744073709551615]
    inputdribblescalar:Uint64
    		Input DribbleRANGE: [0, 18446744073709551615]
    internalMacReceiveErrorsscalar:Uint64
    		The internal MAC receive errors.RANGE: [0, 18446744073709551615]
    internalMacTransmitErrorsscalar:Uint64
    		The internal MAC transmit errors.RANGE: [0, 18446744073709551615]
    lateCollisionsscalar:Uint64
    		The late collisions.RANGE: [0, 18446744073709551615]
    lostCarrierErrorsscalar:Uint64
    		Lost Carrier ErrorsRANGE: [0, 18446744073709551615]
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    multipleCollisionFramesscalar:Uint64
    		The multiple collision frames.RANGE: [0, 18446744073709551615]
    noCarrierErrorsscalar:Uint64
    		No Carrier ErrorsRANGE: [0, 18446744073709551615]
    outPauseFramesscalar:Uint64
    		The output pause frames.RANGE: [0, 18446744073709551615]
    runtsscalar:Uint64
    		runts countRANGE: [0, 18446744073709551615]
    sQETTestErrorsscalar:Uint64
    		The SQET test errors.RANGE: [0, 18446744073709551615]
    singleCollisionFramesscalar:Uint64
    		The single collision frames.RANGE: [0, 18446744073709551615]
    statusmo:ModificationStatus
    (scalar:Bitmask32)    		The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced
    symbolErrorsscalar:Uint64
    		The symbol errors.RANGE: [0, 18446744073709551615]


    Related Documentation

    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

    Querying Ethernet Statistics

    Querying Ethernet Statistics

    The example in this section queries Ethernet statistics for interrace eth1/1. For a description of the Ethernet statistics, see RFC 2819 at the following URL:

    https://tools.ietf.org/html/rfc2819

    Note: The property information for this example was added in Release 9.3(3).


    rmonEtherStats Properties

    The following table contains information about the rmonEtherStats 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 TypeDescriptionValues
    broadcastPktsscalar:Uint64
    		Broadcast PacketsRANGE: [0, 18446744073709551615]
    cRCAlignErrorsscalar:Uint64
    		The cyclic redundancy check align errors.RANGE: [0, 18446744073709551615]
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • clearTsscalar:Date
    		Clear timestampDATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
    DEFAULT: never
    collisionsscalar:Uint64
    		The collisions.RANGE: [0, 18446744073709551615]
    dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    dropEventsscalar:Uint64
    		The drop event packets.RANGE: [0, 18446744073709551615]
    fragmentsscalar:Uint64
    		The fragmented packets.RANGE: [0, 18446744073709551615]
    ifdowndropscalar:Uint64
    		If Down DropRANGE: [0, 18446744073709551615]
    ignoredscalar:Uint64
    		Ignored PacketsRANGE: [0, 18446744073709551615]
    jabbersscalar:Uint64
    		The jabber frames.RANGE: [0, 18446744073709551615]
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    multicastPktsscalar:Uint64
    		Multicast PacketsRANGE: [0, 18446744073709551615]
    octetsscalar:Uint64
    		OctetsRANGE: [0, 18446744073709551615]
    overrunscalar:Uint64
    		Overrun PacketsRANGE: [0, 18446744073709551615]
    oversizePktsscalar:Uint64
    		The oversize packets.RANGE: [0, 18446744073709551615]
    pktsscalar:Uint64
    		The packets.RANGE: [0, 18446744073709551615]
    pkts1024to1518Octetsscalar:Uint64
    		The packets with 1024 to 1518 octets.RANGE: [0, 18446744073709551615]
    pkts128to255Octetsscalar:Uint64
    		The packets with 128 to 255 octets.RANGE: [0, 18446744073709551615]
    pkts256to511Octetsscalar:Uint64
    		The packets with 256 to 511 octets.RANGE: [0, 18446744073709551615]
    pkts512to1023Octetsscalar:Uint64
    		The packets with 2512 to 1023 octets.RANGE: [0, 18446744073709551615]
    pkts64Octetsscalar:Uint64
    		The packets with 64 octets.RANGE: [0, 18446744073709551615]
    pkts65to127Octetsscalar:Uint64
    		The packets with 65 to 127 octets.RANGE: [0, 18446744073709551615]
    rXNoErrorsscalar:Uint64
    		The received packets with no errors.RANGE: [0, 18446744073709551615]
    rxOversizePktsscalar:Uint64
    		The oversized received packets.RANGE: [0, 18446744073709551615]
    statusmo:ModificationStatus
    (scalar:Bitmask32)    		The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced
    tXNoErrorsscalar:Uint64
    		The transmitted packets with no errors.RANGE: [0, 18446744073709551615]
    txOversizePktsscalar:Uint64
    		The oversized transmitted packets.RANGE: [0, 18446744073709551615]
    underrunscalar:Uint64
    		Underrun PacketsRANGE: [0, 18446744073709551615]
    undersizePktsscalar:Uint64
    		The undersize packets.RANGE: [0, 18446744073709551615]
    watchdogscalar:Uint64
    		WatchdogRANGE: [0, 18446744073709551615]


    Related Documentation

    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

    Querying RMON High Capacity Interface Input Statistics

    Querying RMON High Capacity Interface Input Statistics

    The example in this section queries high capacity interface input statistics for interface eth1/1.

    Note: The property information for this example was added in Release 9.3(3).


    rmonIfHCIn Properties

    The following table contains information about the rmonIfHCIn 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 TypeDescriptionValues
    broadcastPktsscalar:Uint64
    		Broadcast PacketsRANGE: [0, 18446744073709551615]
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • clearTsscalar:Date
    		Clear timestampDATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
    DEFAULT: never
    dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    multicastPktsscalar:Uint64
    		Multicast PacketsRANGE: [0, 18446744073709551615]
    octetsscalar:Uint64
    		OctetsRANGE: [0, 18446744073709551615]
    statusmo:ModificationStatus
    (scalar:Bitmask32)    		The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced
    ucastPktsscalar:Uint64
    		Unicast PacketsRANGE: [0, 18446744073709551615]


    Related Documentation

    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

    Querying RMON High Capacity Interface Output Statistics

    Querying RMON High Capacity Interface Output Statistics

    The example in this section queries high capacity interface output statistics for interface eht1/1.

    Note: The property information for this example was added in Release 9.3(3).


    rmonIfHCOut Properties

    The following table contains information about the rmonIfHCOut 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 TypeDescriptionValues
    broadcastPcktsscalar:Uint64
    		The broadcast packets.RANGE: [0, 18446744073709551615]
    broadcastPktsscalar:Uint64
    		Broadcast PacketsRANGE: [0, 18446744073709551615]
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • clearTsscalar:Date
    		Clear timestampDATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
    DEFAULT: never
    dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    multicastPktsscalar:Uint64
    		Multicast PacketsRANGE: [0, 18446744073709551615]
    octetsscalar:Uint64
    		OctetsRANGE: [0, 18446744073709551615]
    statusmo:ModificationStatus
    (scalar:Bitmask32)    		The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced
    ucastPktsscalar:Uint64
    		Unicast PacketsRANGE: [0, 18446744073709551615]


    Related Documentation

    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

    Querying Interface Input Counters

    Querying Interface Input Counters

    The example in this section queries interface input counters for interface eth1/1.

    Note: The property information for this example was added in Release 9.3(3).


    rmonIfIn Properties

    The following table contains information about the rmonIfIn 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 TypeDescriptionValues
    broadcastPktsscalar:Uint64
    		Broadcast PacketsRANGE: [0, 18446744073709551615]
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • clearTsscalar:Date
    		Clear timestampDATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
    DEFAULT: never
    discardsscalar:Uint64
    		Discard PacketsRANGE: [0, 18446744073709551615]
    dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    errorsscalar:Uint64
    		Error PacketsRANGE: [0, 18446744073709551615]
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    multicastPktsscalar:Uint64
    		Multicast PacketsRANGE: [0, 18446744073709551615]
    nUcastPktsscalar:Uint64
    		Non Unicast PacketsRANGE: [0, 18446744073709551615]
    noBufferscalar:Uint64
    		No BufferRANGE: [0, 18446744073709551615]
    octetRatescalar:Uint64
    		Octet RateRANGE: [0, 18446744073709551615]
    octetsscalar:Uint64
    		OctetsRANGE: [0, 18446744073709551615]
    packetRatescalar:Uint64
    		Packet RateRANGE: [0, 18446744073709551615]
    rateIntervalscalar:Uint32
    		Rate IntervalRANGE: [0, 4294967295]
    statusmo:ModificationStatus
    (scalar:Bitmask32)    		The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced
    ucastPktsscalar:Uint64
    		Unicast PacketsRANGE: [0, 18446744073709551615]
    unknownEtypescalar:Uint64
    		Unknown Ether Type PacketsRANGE: [0, 18446744073709551615]
    unknownProtosscalar:Uint64
    		The unknown protocol packets.RANGE: [0, 18446744073709551615]


    Related Documentation

    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

    Querying Interface Output Counters

    Querying Interface Output Counters

    Note: The property information for this example was added in Release 9.3(3).


    rmonIfOut Properties

    The following table contains information about the rmonIfOut 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 TypeDescriptionValues
    broadcastPktsscalar:Uint64
    		Broadcast PacketsRANGE: [0, 18446744073709551615]
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • clearTsscalar:Date
    		Clear timestampDATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
    DEFAULT: never
    discardsscalar:Uint64
    		Discard PacketsRANGE: [0, 18446744073709551615]
    dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    errorsscalar:Uint64
    		Error PacketsRANGE: [0, 18446744073709551615]
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    multicastPktsscalar:Uint64
    		Multicast PacketsRANGE: [0, 18446744073709551615]
    nUcastPktsscalar:Uint64
    		Non Unicast PacketsRANGE: [0, 18446744073709551615]
    octetRatescalar:Uint64
    		Octet RateRANGE: [0, 18446744073709551615]
    octetsscalar:Uint64
    		OctetsRANGE: [0, 18446744073709551615]
    packetRatescalar:Uint64
    		Packet RateRANGE: [0, 18446744073709551615]
    qLenscalar:Uint64
    		The queue length packets.RANGE: [0, 18446744073709551615]
    rateIntervalscalar:Uint32
    		Rate IntervalRANGE: [0, 4294967295]
    statusmo:ModificationStatus
    (scalar:Bitmask32)    		The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced
    ucastPktsscalar:Uint64
    		Unicast PacketsRANGE: [0, 18446744073709551615]


    Related Documentation

    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

    Querying VLAN Statistics

    Querying VLAN Statistics

    You can also query VLAN statistics objects for a specified VLAN. The example in this section queries the VLAN statistics objects for VLAN-1.

    Note: The property information for this example was added in Release 9.3(3).


    l2EpRetPol Properties

    The following table contains information about the l2EpRetPol 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 TypeDescriptionValues
    bounceAgeIntvl
    l2:BounceEpAgeIntvl
    scalar:Uint16    		Represents aging interval for bounce entry @@@ Used when the Ep (VM) is moving from one TOR @@@ to another TOR. Ep is marked as bouncing for the @@@ specified age interval and is deleted afterwards RANGE: Min: 0 Max: 0 RANGE: Min: 150 Max: 0xffff
  • DEFAULT: 630
    • bounceTrig
    l2:BounceTrig
    scalar:Bitmask8    		Bounce triggerSELECTION:
  • 1 - rarp-flood
  • 2 - protocol
  • DEFAULT: protocol(2)
    • childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • descr
    naming:Descr
    string:Basic    		Specifies a control instrumentation description. RANGE: Min: "0" Max: "128"
    dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    holdIntvl
    l2:HoldIntvl
    scalar:Uint16    		If the EP move frequency is exceeded RANGE: Min: 5 Max: 0xffff
  • DEFAULT: 300
    • lcOwnNANANA
    localEpAgeIntvl
    l2:LocalEpAgeIntvl
    scalar:Uint16    		This represents aging interval for all local endpoints learned in this BD. Once we reach 75% of this interval is reached RANGE: Min: 0 Max: 0 RANGE: Min: 120 Max: 0xffff
  • DEFAULT: 900
    • modTs
    mo:TStamp
    scalar:Date    		The time when this object was last modified.SELECTION:
  • 0ull - never
  • DEFAULT: never(0ull)
    • moveFreq
    l2:MoveFreq
    scalar:Uint16    		EP move frequency RANGE: Min: 0 Max: 0xffff
  • DEFAULT: 256
    • name
    pol:ObjName
    string:Basic    		null RANGE: Min: "0" Max: "64"
    remoteEpAgeIntvl
    l2:RemoteEpAgeIntvl
    scalar:Uint16    		This represents aging interval for all remote endpoints learned in this BD. The remote endpoints are learned through conversational learning RANGE: Min: 0 Max: 0 RANGE: Min: 120 Max: 0xffff
  • DEFAULT: 300
    • status
    mo:ModificationStatus
    scalar:Bitmask32    		The upgrade status. This property is for internal use only.SELECTION:
  • 16u - replaced
  • 2u - created
  • 4u - modified
  • 8u - deleted
  • DEFAULT: 0


    • l2VlanStats Properties

    The following table contains information about the l2VlanStats 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 TypeDescriptionValues
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • clearTsscalar:Date
    		Clear timestampDATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
    DEFAULT: never
    dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    inBcastOctetsscalar:Uint64
    		Broadcast OctetsRANGE: [0, 18446744073709551615]
    inBcastPktsscalar:Uint64
    		Broadcast packetsRANGE: [0, 18446744073709551615]
    inL3UcastOctetsscalar:Uint64
    		ingress L3 SVI Unicast OctetsRANGE: [0, 18446744073709551615]
    inL3UcastPktsscalar:Uint64
    		ingress L3 SVI Unicast PacketsRANGE: [0, 18446744073709551615]
    inMcastOctetsscalar:Uint64
    		Multicast OctetsRANGE: [0, 18446744073709551615]
    inMcastPktsscalar:Uint64
    		Multicast packetsRANGE: [0, 18446744073709551615]
    inUcastOctetsscalar:Uint64
    		ucastOctetsRANGE: [0, 18446744073709551615]
    inUcastPktsscalar:Uint64
    		Unicast packetsRANGE: [0, 18446744073709551615]
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    outUcastOctetsscalar:Uint64
    		ucastOctetsRANGE: [0, 18446744073709551615]
    outUcastPktsscalar:Uint64
    		Unicast packetsRANGE: [0, 18446744073709551615]
    statusmo:ModificationStatus
    (scalar:Bitmask32)    		The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced


    l2BD Properties

    The following table contains information about the l2BD 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 TypeDescriptionValues
    accEncapbase:Encap
    		The Layer 2 access encapsulation (VLAN or VNID).SELECTION: unknown, vlan-%d or vxlan-%d
    adminStl2:DomAdminSt
    (scalar:Enum8)    		admin stateSELECTION:
    1 - suspend
    2 - active
    DEFAULT: active
    bdDefDnreference:BinRef
    		The bridge domain name.
    bridgeModel2:BridgeMode
    (scalar:Enum8)    		The Layer 2 bridge-domain parameter mode used by the node for enabling classical bridging or bridging with the IP address.SELECTION:
    1 - ip
    2 - mac
    DEFAULT: mac
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • createTsscalar:Date
    		creation timeDATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
    ctrll2:DomCtrl
    (scalar:Bitmask32)    		The control state.SELECTION:
    0 - none
    1 - untagged
    2 - policy-enforced
    DEFAULT: none
    dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    epOperSt
    epm:BdOperSt
    scalar:Bitmask8    		 SELECTION:
  • 0 - unspecified
  • 1 - learn-disabled
  • DEFAULT: 0
    • fabEncapbase:Encap
    		The Layer 2 bridge-domain Fabric encapsulation (VNID).SELECTION: unknown, vlan-%d or vxlan-%d
    fwdCtrll2:FwdCtrl
    (scalar:Bitmask32)    		The Layer 2 bridge-domain forwarding controls.SELECTION:
    1 - mdst-flood
    2 - arp-flood
    DEFAULT: mdst-flood
    fwdModel2:FwdMode
    (scalar:Bitmask8)    		The Layer 2 bridge-domain parameter mode used by the node for enabling forwarding modes.SELECTION:
    1 - route
    2 - bridge
    DEFAULT: route,bridge
    hwIdl2:DomId
    (scalar:Uint32)    		Internal domain id
    RANGE: [1 , 4096]
    idl2:DomId
    (scalar:Uint32)    		domain id
    RANGE: [1 , 4096]
    lcOwnNANANA
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    model2:DomMode
    (scalar:Enum8)    		Vlan modeSELECTION:
    1 - CE
    2 - FabricPath
    DEFAULT: CE
    monPolDn
    reference:BinRef    		The monitoring policy for the Layer 2 bridge-domain object.
    namenaming:Name256
    (string:Basic)    		The name of the object.
    MAX SIZE: 128
    operStl2:DomOperSt
    (scalar:Enum8)    		oper stateSELECTION:
    1 - up
    2 - down
    3 - unknown
    DEFAULT: down
    pcTag
    actrl:PcTag
    scalar:Uint32    		The default classId for the unknown Unicast traffic terminating on the L2 bridge-domain.SELECTION:
  • 0u - any
  • DEFAULT: 0
    • statusmo:ModificationStatus
    (scalar:Bitmask32)    		The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced
    type
    l2:DomType
    scalar:Enum8    		domain typeSELECTION:
  • 1 - bd-regular
  • 2 - bd-reserved
  • 3 - bd-control
  • 4 - bd-external
  • 5 - ckt-vlan
  • 6 - ckt-vxlan
  • DEFAULT: bd-regular(1)
    • unkMacUcastAct
    l2:UnkMacUcastAct
    scalar:Enum8    		The classical bridge-domain parameter used by the node for forwarding data for an unknown mac Unicast destination.SELECTION:
  • 0 - flood
  • 1 - proxy
  • DEFAULT: proxy(1)
    • unkMcastAct
    l2:UnkMcastAct
    scalar:Enum8    		 SELECTION:
  • 0 - flood
  • 1 - opt-flood
  • DEFAULT: flood(0)
    • vlanmgrCfgFailedBmp
    scalar:Bitmask64    		null SELECTION:
  • -9223372036854775808ull - l2:BDmodTs_failed_flag
  • 1024ull - l2:BDfabEncap_failed_flag
  • 1048576ull - l2:BDxConnect_failed_flag
  • 128ull - l2:BDbdDefDn_failed_flag
  • 131072ull - l2:BDpcTag_failed_flag
  • 16384ull - l2:BDmacPacketClassify_failed_flag
  • 16ull - l2:BDmode_failed_flag
  • 1ull - l2:BDBdState_failed_flag
  • 2048ull - l2:BDfwdCtrl_failed_flag
  • 2305843009213693952ull - l2:BDuid_failed_flag
  • 256ull - l2:BDbridgeMode_failed_flag
  • 262144ull - l2:BDunkMacUcastAct_failed_flag
  • 2ull - l2:BDadminSt_failed_flag
  • 32768ull - l2:BDmonPolDn_failed_flag
  • 32ull - l2:BDtype_failed_flag
  • 4096ull - l2:BDfwdMode_failed_flag
  • 4611686018427387904ull - l2:BDpersistentOnReload_failed_flag
  • 4ull - l2:BDctrl_failed_flag
  • 512ull - l2:BDcontrollerId_failed_flag
  • 524288ull - l2:BDunkMcastAct_failed_flag
  • 64ull - l2:BDaccEncap_failed_flag
  • 65536ull - l2:BDname_failed_flag
  • 8192ull - l2:BDlongName_failed_flag
  • 8ull - l2:BDid_failed_flag
  • DEFAULT: 0
    • vlanmgrCfgFailedTs
    scalar:Uint64
    vlanmgrCfgState
    scalar:UByte    		null


    Related Documentation

    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

    Next