Cisco Nexus 3000 and 9000 Series NX-API REST SDK API, Release 9.3(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Querying Ephemeral Data Example

DME

Copy
GET http://<IP_Address>/api/node/mo/sys/urib/table4-default.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-context=rt:19.19.19.0_24;detail;uni;multi;backup&batch-id=1&batch-size=100    
Response
{
    "totalCount": "1",
    "imdata": [
        {
            "uribTable4": {
                "attributes": {
                    "dn": "sys/urib/table4-[default]",
                    "routeCount": "15",
                    "vrfName": "default"
                },
                "children": [
                    {
                        "uribRoute4": {
                            "attributes": {
                                "flags": "65",
                                "mBestNextHopCount": "0",
                                "pendingHw": "no",
                                "pendingUfdm": "no",
                                "prefix": "19.19.19.0/24",
                                "rn": "route4-[19.19.19.0/24]",
                                "sortKey": "0",
                                "uBestNextHopCount": "1"
                            },
                            "children": [
                                {
                                    "uribNextHop4": {
                                        "attributes": {
                                            "address": "19.19.19.2",
                                            "bindinglabel": "0",
                                            "clientData": "No",
                                            "encapType": "none",
                                            "flags": "0",
                                            "id": "0",
                                            "interfaceName": "Eth1/19",
                                            "isBest": "yes",
                                            "labelStack": "",
                                            "metric": "0",
                                            "nhlfeFlags": "0",
                                            "nhlfeOwner": "",
                                            "owner": "direct",
                                            "preference": "0",
                                            "recursiveNextHopPrefix": "0.0.0.0",
                                            "rn": "nh4-0",
                                            "routeType": "",
                                            "segidType": "null",
                                            "segmentId": "0",
                                            "tag": "0",
                                            "tlv": "",
                                            "tlvAttachExport": "",
                                            "tlvExtentedCommunity": "",
                                            "tlvType": "0",
                                            "tunnelId": "0",
                                            "uptime": "01:32:45",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0",
                                            "xriBgpOrigin": "",
                                            "xriBgpPeer": ""
                                        }
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        }
    ]
}

Ephemeral (MOTL) MOs for URIB

The following table lists the queries for retrieving route information through ephemeral MOs. These were added in Release 9.3(1).

Show Command	Ephemeral DN Query
`show ip route vrf all`	`http://<mgmt0_IP>/api/node/mo/sys/urib.json?rsp-foreign-subtree=ephemeral`
`show ipv6 route vrf all`	`http://<mgmt0_IP>/api/node/mo/sys/u6rib.json?rsp-foreign-subtree=ephemeral`
`show ip route vrf vrfname`	`http://<mgmt0_IP>/api/node/mo/sys/urib/table4-vrfname.json?rsp-foreign-subtree=ephemeral`
`show ipv6 route vrf vrfname`	`http://<mgmt0_IP>/api/node/mo/sys/u6rib/table6-vrfname.json?rsp-foreign-subtree=ephemeral`
`show routing summary vrf all`	`http://<mgmt0_IP>/api/node/mo/sys/urib.json?rsp-foreign-subtree=ephemeral&batch-context=summary`
`show routing ipv6 summary vrf all`	`http://<mgmt0_IP>/api/node/mo/sys/u6rib.json?rsp-foreign-subtree=ephemeral&batch-context=summary`
`show routing summary vrf vrfname`	`http://<mgmt0_IP>/api/node/mo/sys/urib/table4-vrfname.json?rsp-foreign-subtree=ephemeral&batch-context=summary`
`show routing ipv6 summary vrf vrfname`	`http://<mgmt0_IP>/api/node/mo/sys/u6rib/table6-vrfname.json?rsp-foreign-subtree=ephemeral&batch-context=summary`

Batch Context

Use batch context tags in the table below to filter the queries. The format is a list of single tag or property:values pairs separated by a semi colon. For example: ";;:;;:;…"

Tag	Description
summary	Adds the summary MO to the output
uni	Shows the unicast paths. Note: Uni is always implied if neither uni or multi is specified.
multi	Show the multicast paths. Note: If only multi is specified, unicast paths are not given. To get both unicast and multicast, both uni and multi must be used.
backup	Shows the best and backup paths. Note: By default, only the best paths are given.
no-nh	Do not fill the next-hop MO.
detail	Dump detailed information about the next hops. See notes below.
noroutes	Do not dump the routes, only the summary.

Notes: If no tags are used, the default is to show only the unicast path. Next-hop detailed information includes:

Labels related information
Client data pointer
BGP Origin/Peer
RNH information
Tlv information
Extended community
Attached export information

Property	Value
rt	An address string parse-able by inet_pton. The mask (optional) is specified by adding an ‘_’ after the address: e.g. 30.4.1.0_24 or 100::_16 If no mask is specified, the default is 32 for urib and 128 for u6rib. Note: You can use the rt property to see only one route. Also, you can specify the property only once in the batch-context. If the property is not used, the full table is given.
client	A list of clients separated by coma. For example: “static,broadcast,local”. This will show only the routes where at least one of these clients has paths.

Querying Ephemeral Data Example

Note: This example was added in Cisco NX-OS Release 9.3(1).

For more information about applying query filters, see Filtering API Query Results

uribTable4 Properties

The following table contains information about the uribTable4 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
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
routeCount	urib:Counter32 (scalar:Uint32)	Total number of route in this table	RANGE: [0, 4294967295]
vrfName	l3:VrfName (string:Basic)	VRF name	A sequence of characters

uribRoute4 Properties

The following table contains information about the uribRoute4 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
flags	scalar:Uint32	Route flags.	RANGE: [0, 4294967295]
mBestNextHopCount	scalar:Uint32	Number of multicast best next hop	RANGE: [0, 4294967295]
pendingHw	scalar:Bool	UFDM sent, waiting for ack from HW.	SELECTION: true or false
pendingUfdm	scalar:Bool	Waiting to be send to UFDM.	SELECTION: true or false
prefix	address:Ip	Route address with mask	Value must match ipv4 or ipv6 known format
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
sortKey	scalar:Uint32	Eibgp mixed-path sort key.	RANGE: [0, 4294967295]
uBestNextHopCount	scalar:Uint32	Number of unicast best next hop	RANGE: [0, 4294967295]

uribNextHop4 Properties

The following table contains information about the uribNextHop4 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
address	address:Ip	Next-hop address.	Value must match ipv4 or ipv6 known format
bindinglabel	scalar:Uint32	SRTE binding label	RANGE: [0, 4294967295]
clientData	urib:YesNo (scalar:Enum8)	Yes if client put data in the next-hop.	SELECTION: 0 - No 1 - Yes
encapType	urib:NextHopEncapType (scalar:Enum8)	Either VXLAN or none.	SELECTION: 0 - none 1 - vxlan 2 - invalid
flags	scalar:Uint32	Flags, each bit has a different meaning.	RANGE: [0, 4294967295]
id	scalar:Uint32	Unique id among all nh of the route. Only used internally.	RANGE: [0, 4294967295]
interfaceName	string:Basic	Interface name.	A sequence of characters
isBest	scalar:Bool	Is the next-hop in the best list	SELECTION: true or false
labelStack	string:Basic	MPLS label stack.	A sequence of characters
metric	scalar:Uint32	Metric.	RANGE: [0, 4294967295]
nhlfeFlags	scalar:Uint32	Next-hop Label Forwarding flags.	RANGE: [0, 4294967295]
nhlfeOwner	string:Basic	nhlfe owner name.	A sequence of characters
owner	string:Basic	local, attached-export, static or unknown.	A sequence of characters
preference	scalar:Uint32	Preference.	RANGE: [0, 4294967295]
recursiveNextHopPrefix	address:Ip	Recursive nexthop.	Value must match ipv4 or ipv6 known format
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
routeType	string:Basic	Type.	A sequence of characters
segidType	string:Basic	Client provided segment type. 0 means not set.	A sequence of characters
segmentId	scalar:Uint32	Client provided segment ID. 0 means not set.	RANGE: [0, 4294967295]
tag	scalar:Uint32	Client defined tag.	RANGE: [0, 4294967295]
tlv	string:Basic	Type-Length-Value; client provided opaque data.	A sequence of characters
tlvAttachExport	string:Basic	Type-Length-Value.	A sequence of characters
tlvExtentedCommunity	string:Basic	Type-Length-Value.	A sequence of characters
tlvType	scalar:Uint32	Type-Length-Value type.	RANGE: [0, 4294967295]
tunnelId	scalar:Uint32	Client provided tunnel ID. 0 means not set.	RANGE: [0, 4294967295]
uptime	urib:TimeStr (string:Basic)	Elapsed time since this next hop has been added/modified.	A sequence of characters
vrf	l3:VrfName (string:Basic)	VRF name.	A sequence of characters
vtepIpAddress	address:Ip	VxLAN VTEP IP address.	Value must match ipv4 or ipv6 known format
vtepUnderlayVrfId	scalar:Uint32	VxLAN VTEP underlay VRF ID.	RANGE: [0, 4294967295]
xriBgpOrigin	string:Basic	Extended route information comming from BGP.	A sequence of characters
xriBgpPeer	string:Basic	Extended route information comming from BGP.	A sequence of characters

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