Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Loading...
Querying OSPFv3 Instance details
DME
YANG
Copy




Copy
<rpc xmlns="urn:ie􀆞:params:xml:ns:netconf:base:1.0" message-id="101">
<get>
<filter>
<System xmlns="htp://cisco.com/ns/yang/cisco-nx-os-device">
<ospfv3-items>
<inst-items>
<Inst-list>
<name>1</name>
</Inst-list>
</inst-items>
</ospfv3-items>
</System>
</filter>
</get>
</rpc>

Querying OSPFv3

OSPFv3 operational data is a valuable asset for network administrators, offering crucial insights to optimize performance, troubleshoot issues effectively, and maintain a robust and resilient network infrastructure. Querying OSPFv3 is the process of retrieving detailed information about the OSPFv3 routing protocol's operation within a network. Querying OSPFv3 is essential for network troubleshooting, optimization, and capacity planning. It helps in identifying and resolving routing issues before they affect the network's performance or availability. It provides real-time visibility into the network's state, encompassing the status of routers, links, and neighboring devices. Additionally, it aids in optimizing routing tables and ensuring efficient traffic flow.

Querying OSPFv3 Instance details

Querying OSPFv3 Instance details

Note: This example was added in Release 10.4(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.

show ospfv3 1


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
Inst sys/ospfv3/inst-1


Inst Properties

The following table contains information about the Inst 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 TypeDescription
OperErrscalar:BitmaskOperational Errors Qualifier
memAlertscalar:Enum8OSPFv3 operational memory alert level


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

Querying OSPFv3 Dom details

Querying OSPFv3 Dom details

Note: This example was added in Release 10.4(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.

show ospfv3 1 vrf vrf1


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
Dom sys/ospfv3/inst-1/dom-default


Dom Properties

The following table contains information about the Dom 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 TypeDescription
operStscalar:BitmaskOperational state of VRF
operRtrIdip:RtrIdOperational Router identifier for this VRF


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

Querying OSPFv3 Dom Stats

Querying OSPFv3 Dom Stats

Note: This example was added in Release 10.4(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.

show ospfv3 1 vrf vrf1


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
DomStats sys/ospfv3/inst-1/dom-default/domstats


DomStats Properties

The following table contains information about the DomStats 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 TypeDescription
ifCntscalar:Uint32Holds the count of interfaces
areaCntscalar:Uint32Holds the number of area's configured
stubAreaCntscalar:Uint32Holds the count of stub areas
nssaAreaCntscalar:Uint32Count of not-so-stubby area(NSSA) area
extAreaCntscalar:Uint32Holds the count of external areas
activeStubAreaCntscalar:Uint32Holds the count of active stub areas
activeNssaAreaCntscalar:Uint32Active not-so-stubby area(NSSA) area count
activeExtAreaCntscalar:Uint32Holds the active external area count
activeAreaCntscalar:Uint32Holds the count of active areas
lastStatsClearTsscalar:DateHolds the last statistics clear timestamp
peerCntscalar:Uint32Holds the neighbor/peer count
extLsaCntscalar:Uint32Holds the external linkstate advertisement(LSA) count
opaqueAsLsaCntscalar:Uint32Holds the count of opaque AS LSAs
totalAsLsaCntscalar:Uint32Holds the total AS linkstate advertisement(LSA) count
newLsaRxCntscalar:Uint32Holds the Rx count ofnew link-state advertisement(LSA)
newLsaTxCntscalar:Uint32Holds the Tx count of new link-state advertisement(LSA)
areaBdrRtrscalar:UByteStatus of Area Border Router(ABR)
asBdrRtrscalar:UByteHolds the status of Autonomous System Boundary Router(ASBR)


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

Querying OSPFv3 interface details

Querying OSPFv3 interface details

Note: This example was added in Release 10.4(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.

show ospfv3 interface vrf all


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
If sys/ospfv3/if-[eth1/1]


DomStats Properties

The following table contains information about the If 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 TypeDescription
Idip:RtrIdInterface Identifier of this endpoint
operStscalar:Enum8Interface operational state, can be p2p,loopback, etc.
typescalar:Enum8Type of interface, p2p or broadcast etc.
flagsscalar:Bitmask32Interface flags to indicate state of interface
Ipv6Addraddress:IpIPv6 address of interface
draddress:IpDesignated router IPv6 Address
bdraddress:IpBackup designated router IPv6 Address
drIdip:RtrIdDesignated router identifier
bdrIdip:RtrIdBackup designated router identifier
lsaCksumSumscalar:Uint32link-state advertisement checksum Sum
operCostscalar:Uint16Operational cost of interface
operDeadIntvlscalar:Uint32Interface operational dead interval


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

Querying OSPFv3 interface stats

Querying OSPFv3 interface stats

Note: This example was added in Release 10.4(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.

show ospfv3 interface vrf all


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
IfStats sys/ospfv3/if-[eth1/1]/ifstats


DomStats Properties

The following table contains information about the If 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 TypeDescription
evCntscalar:Uint32Interface events count
lsaCntscalar:Uint322Link-state advertisement(LSA) count
peerCntscalar:Uint322Holds the count of peers/neighbors
floodToPeerCntscalar:Uint322Flood to neighbor count
adjCntscalar:Uint322Holds the count of adjacency
grHelperPeerCntscalar:Uint322Number of peers in GR hitless helper mode


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

Querying OSPFv3 Area details

Querying OSPFv3 Area details

Note: This example was added in Release 10.4(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.

show ospfv3 vrf all


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
Area sys/ospfv3/inst-1/dom-default/area-0.0.0.0


Area Properties

The following table contains information about the If 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 TypeDescription
brCntscalar:Uint32Area border router count
asbrCntscalar:Uint322Autonomous system boundary router count
lsaCksumSumscalar:Uint322link-state advertisement checksum sum
nssaTransStscalar:Enum8Not-So-Stubby Area translator state
nssaTransStabIntvlscalar:Uint32Not-So-Stubby Area translator stability interval


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

Querying OSPFv3 Area Stats

Querying OSPFv3 Area Stats

Note: This example was added in Release 10.4(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.

show ospfv3 vrf all


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
AreaStats sys/ospfv3/inst-1/dom-default/area-0.0.0.0/areastats


Area Properties

The following table contains information about the If 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 TypeDescription
areaCreatedTsscalar:DateTimestamp of the area created
spfRunsscalar:Uint32Number of Shortest Path First (SPF) runs
lsaCntscalar:Uint32Count of link-state advertisements(LSA)
lastSpfDurationscalar:Uint32Duration of last Shortest Path First (SPF)
ifCntscalar:Uint32Total number of interfaces
activeIfCntscalar:Uint32Number of active interfaces
passiveIfCntscalar:Uint32Number of passive interfaces
lpbkIfCntscalar:Uint32Number of loopback interfaces
adjCntscalar:Uint32Number of adjacencies formed
grHelperPeerCntscalar:Uint32Graceful restart helper peer count


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

Querying OSPFv3 Adjacency details

Querying OSPFv3 Adjacency details

Note: This example was added in Release 10.4(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.

show ospfv3 neighbors vrf all


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
AdjEp sys/ospfv3/if-[eth1/1]/adj-100.1.1.1


AdjEp Properties

The following table contains information about the AdjEp 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 TypeDescription
Idip:RtrIdOSPF adjacency neighbor's router id
operStscalar:Enum8Operational state of OSPF adjacency
bfdStscalar:Enum8Operational Bidirectional Forwarding Detection(BFD) State
areaaddress:IPv4OSPF adjacency operational area ID
prioscalar:UByteOperational neighbor priority
draddress:IpDesignated router address(DR)
Bdraddress:IpBackup designated router address(BDR)
peerIpaddress:IpAdjacency peer IP address
helloOptionsscalar:Uint32Peer options from hello packet
dbdOptionsscalar:Uint32Peer options from database descriptor(DBD) packet
flagsscalar:Bitmask16Adjacency flags can be master-self,all-dbdssent,all-dbds-acked and peer-gr-helper
peerNamestring:BasicOSPf adjacency Neighbor name


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

Querying OSPFv3 Adjacency Stats

Querying OSPFv3 Adjacency Stats

Note: This example was added in Release 10.4(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.

show ospfv3 neighbors vrf all


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
AdjStats sys/ospfv3/if-[eth1/1]/adj-100.1.1.1/adjstats


AdjStats Properties

The following table contains information about the AdjStats 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 TypeDescription
stChgCntscalar:Uint32Number of states changed during OSPF adjacency
lastStChgTsscalar:DateTimestamp of the latest state change
lastNonHelloPktTsscalar:DateTimestamp of the last non hello packet received
dbdSeqNumscalar:Uint32Database descriptor(DBD) sequence number
reqLsaCntscalar:Uint32Number of outstanding LSAs from last request
outstandingLsaCntscalar:Uint32Number of outstanding LSAs from last request
lsaReqRexmitCntscalar:Uint32Number of retransmissions of LSA request
deadTimerExpTsscalar:DateTimestamp of the dead timer expiry


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

Querying OSPFv3 Traffic

Querying OSPFv3 Traffic

Note: This example was added in Release 10.4(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.

show ospfv3 traffic vrf all


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
TrafficStats sys/ospfv3/if-[eth1/1]/trstats


TrafficStats Properties

The following table contains information about the TrafficStats 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 TypeDescription
totalPktsRcvdscalar:Uint32Total number of packets received
helloPktsRcvdscalar:Uint32Total number of hello packets received
dbdPktsRcvdscalar:Uint32Database description packets received
lsReqPktsRcvdscalar:Uint32Link-state request packets received
lsUpdPktsRcvdscalar:Uint32Link-state update packets received
lsAckPktsRcvdscalar:Uint32Link-state ACK packets received
rcvdPktsDroppedscalar:Uint32Count of received packets dropped
errPktsRcvdscalar:Uint32Count of Error packets received
errHelloPktsRcvdscalar:Uint32Number of Error hello packets received
errDbdPktsRcvdscalar:Uint32Error database description packets received
errLsReqPktsRcvdscalar:Uint32Error link-state request packets received
errLsUpdPktsRcvdscalar:Uint32Error link-state update packets received
errLsAckPktsRcvdscalar:Uint32Error LSACK Packets Received
unknownPktsRcvdscalar:Uint32Count of unknown packets received
dupRtrIdPktsRcvdscalar:Uint32Duplicate router-id packets received
dupSrcAddrPktsRcvdscalar:Uint32Duplicate source address packets received
wrongAreaPktsRcvdscalar:Uint32Wrong Area Packets Received
invalidSrcAddrPktsRcvdscalar:Uint32Invalid Source Addr Packets Received
invalidDestAddrPktsRcvdscalar:Uint32Invalid Destination Addr Packets Received
badCRCPktsRcvdscalar:Uint32Bad CRC Packets Received
badVersionPktsRcvdscalar:Uint32Bad Version Packets Received
badResvFieldPktsRcvdscalar:Uint32Bad Reserved Field Packets Received
peerRtrIdChgdPktsRcvdscalar:Uint32Peer RouterId Changed Packets Received
peerNotFoundPktsRcvdscalar:Uint32Peer Not Found Packets Received
badAuthPktsRcvdscalar:Uint32Bad Authentication Packets Received
badLenPktsRcvdscalar:Uint32Bad Length Packets Received
passiveIntfPktsRcvdscalar:Uint32Passive Interface Packets Received
noOspfIntfPktsRcvdscalar:Uint32No OSPF Interface Packets Received
rcvdLsaPktsIgnoredscalar:Uint32Received LSA Packets Ignored
droppedLsaPktsWhileSPFscalar:Uint32LSA Packets Dropped During SPF
droppedLsaPktsWhileGRscalar:Uint32LSA Packets Dropped During GR
totalPktsSentscalar:Uint32Total number of packets sent
helloPktsSentscalar:Uint32Total number of hello packets sent
dbdPktsSentscalar:Uint32Database description packets sent
lsReqPktsSentscalar:Uint32Link-state request packets sent
lsUpdPktsSentscalar:Uint32Link-state update packets sent
lsAckPktsSentscalar:Uint32Link-state ACK packets sent
droppedSendPktsscalar:Uint32Total number of dropped send packets
errSendPktsscalar:Uint32Total number of error send packets
unknownSendPktsscalar:Uint32Count of unknown send packets
lsuFirstTxPktsscalar:Uint32Number of first transmission of LSU packets
lsuRexmitPktsscalar:Uint32Number of retransmissions of LSU packets
lsuForLsreqPktsscalar:Uint32Number of retransmissions of LSU packets
lsuPeerTxPktsscalar:Uint32Number of LSU packets sent to a neighbor specifically
floodPktSendIpThrottlescalar:Uint32Number of times flooding packets dropped due to IP queue throttling
floodPktSendTokenThrottlescalar:Uint32Number of times flooding packets dropped due to token throttling
lastStatsClearTsscalar:Uint32Last traffic statistics clear timestamp


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

Next