Cisco Nexus 3000 and 9000 Series NX-API REST SDK and API, Release 7.x
NX-OS 7(x)
- Cisco Nexus 3000 and 9000 Series NX-API REST Documentation
- Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 7.x
- Getting Started with the Cisco Nexus 3000 and 9000 Series NX-API REST SDK
- New and Changed
- Manageability
- Configuring System Management
- Configuring VXLAN BGP EVPN
- Configuring Fundamentals
- Configuring Power Modes
- Configuring Interfaces
- Configuring Static MPLS and Segment Routing
- Configuring Netstack
- Configuring Layer 2 Switching
- Configuring Multicast
- Configuring QoS
- Configuring TCAM
- Configuring Security
- Configuring Unicast Routing
- Configuring ARP
- Configuring DNS
- Configuring OSPFv2
- Configuring BGP
- Configuring a BGP Router
- Configuring an IPv4 Labeled Unicast Address Family
- Configuring an IPv4 Multicast Address Family
- Configuring an IPv4 MVPN Address Family
- Configuring an IPv4 Unicast Address Family
- Configuring an IPv6 Labeled Unicast Address Family
- Configuring an IPv6 Multicast Address Family
- Configuring an IPv6 MVPN Address Family
- Configuring an IPv6 Unicast Address Family
- Configuring an L2VPN EVPN Address Family
- Configuring a Link-State Address Family
- Configuring a VPNv4 Unicast Address Family
- Configuring a VPNv6 Unicast Address Family
- Configuring a Peer Template
- Configuring a BGP Neighbor
- Configuring a BMP Server
- Configuring EVPN
- Querying Ephemeral Data
- Querying Ephemeral Operational Data for IPv4 and IPv6 Unicast/Multicast Address Families
- Querying Ephemeral Operational Data for VPNv4 and VPNv6 Unicast Address Families
- Querying Ephemeral Operational Data L2VPN EVPN Address Families
- Querying Ephemeral Operational Data for IPv4 and IPv6 Labeled Unicast Address Families
- Querying Ephemeral Operational Data for the Link State Address Family
- Querying Ephemeral Operational Data for the IPv4 MVPN Address Family
- Ephemeral REST Output
- Querying the Routes Advertised to a Peer
- Configuring VRF
- First-Hop Redundancy Protocols
- Configuring Static Routes
- Configuring Route Policy Manager
- Configuring Telemetry
- Querying Analytic Information
- Querying Configurations (Show Commands)
- Querying Interface and VLAN Counters and Statistics
- Using the Managed Object Browser
- Monitoring the Environment
Ephemeral REST Output
DME
CopyGET http://{{ip}}/api/mo/sys/bgp/inst/dom-default/af-[ipv4-ucast].json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-size=50&batch-id=1
Response
{
"totalCount": "1",
"imdata": [
{
"bgpDomAf": {
"attributes": {
"advSysMac": "disabled",
"advertL2vpnEvpn": "disabled",
"allocLblAll": "disabled",
"allocLblRtMap": "",
"bestPathCmpltTs": "2017-02-16T10:50:01.126+00:00",
"bestPathSigTs": "2017-02-16T10:50:01.119+00:00",
"childAction": "",
"clReflection": "enabled",
"critNhTimeout": "crit",
"defInfOrigRd": "unknown:unknown:0:0",
"defInfOrigRtt": "unknown:unknown:0:0",
"defInfOriginate": "disabled",
"defMetric": "",
"dn": "sys/bgp/inst/dom-default/af-ipv4-ucast",
"igpMetric": "600",
"lblAllocMod": "disabled",
"maxEcmp": "1",
"maxExtEcmp": "1",
"modTs": "2017-02-16T10:50:01.231+00:00",
"name": "bgp-DomAf",
"nhRtMap": "",
"nonCritNhTimeout": "noncrit",
"numAggregates": "0",
"numNetworks": "0",
"numPaths": "15",
"numPeers": "3",
"numPeersActive": "3",
"numRoutes": "11",
"persistentOnReload": "true",
"retainRttAll": "disabled",
"retainRttRtMap": "",
"status": "",
"supprInactive": "disabled",
"tblId": "0x1",
"tblMap": "",
"tblMapFltr": "disabled",
"tblSt": "up",
"tblVer": "98",
"tmrBstpthDfr": "0",
"tmrMax": "0",
"type": "ipv4-ucast",
"uid": "0",
"vniEthTag": "disabled"
},
"children": [
{
"bgpRoute": {
"attributes": {
"bestPathId": "3",
"numPaths": "3",
"pfx": "1.1.1.1/32",
"rd": "unknown:unknown:0:0",
"rn": "rt-[1.1.1.1/32]",
"rtFlags": "best,rib,xmit",
"ver": "93"
},
"children": [
{
"bgpPath": {
"attributes": {
"aggr": "8.8.8.8",
"aggrAs": "100",
"asPath": "20640 57555 28934 314",
"clusterLst": "",
"extComm": "RT:100:1 RT:1.1.1.1:1",
"flags": "atomic-aggr,metric",
"id": "0",
"importedRd": "unknown:unknown:0:0",
"localPref": "100",
"metric": "2326136519",
"nh": "21.0.101.99",
"nhMetric": "4294967295",
"operSt": "invalid",
"origin": "igp",
"originatorId": "0.0.0.0",
"peer": "19.0.101.1",
"peerRtrId": "12.12.12.12",
"rcvdLbl": "",
"regComm": "1:8609 2:45523 3:16903 4:53818",
"rn": "path-[19.0.101.1]-id-0-nh-[21.0.101.99]",
"type": "internal",
"unknownAttrData": "",
"unknownAttrLen": "0",
"weight": "0"
},
"children": [
{
"bgpAsSeg": {
"attributes": {
"order": "1",
"rn": "seg-1"
},
"children": [
{
"bgpAsItem": {
"attributes": {
"asn": "20640",
"order": "1",
"rn": "asn-1"
}}},{
"bgpAsItem": {
"attributes": {
"asn": "314",
"order": "4",
"rn": "asn-4"
}}},{
"bgpAsItem": {
"attributes": {
"asn": "28934",
"order": "3",
"rn": "asn-3"
}}},{
"bgpAsItem": {
"attributes": {
"asn": "57555",
"order": "2",
"rn": "asn-2"
}}}]}},{
"bgpRegComm": {
"attributes": {
"community": "regular:as2-nn2:2:45523",
"rn": "rcomm-regular:as2-nn2:2:45523"
}}},{
"bgpRegComm": {
"attributes": {
"community": "regular:as2-nn2:1:8609",
"rn": "rcomm-regular:as2-nn2:1:8609"
}}},{
"bgpRegComm": {
"attributes": {
"community": "regular:as2-nn2:3:16903",
"rn": "rcomm-regular:as2-nn2:3:16903"
}}},{
"bgpRegComm": {
"attributes": {
"community": "regular:as2-nn2:4:53818",
"rn": "rcomm-regular:as2-nn2:4:53818"
}}},{
"bgpExtComm": {
"attributes": {
"encap": "unknown",
"rn": "ecomm",
"rtrMac": "00:00:00:00:00:00"
},
"children": [
{
"bgpExtCommRt": {
"attributes": {
"community": "extended:ipv4-nn2:1.1.1.1:1",
"rn": "rt-extended:ipv4-nn2:1.1.1.1:1"
}}},{
"bgpExtCommRt": {
"attributes": {
"community": "extended:as2-nn2:100:1",
"rn": "rt-extended:as2-nn2:100:1"
}}}]}}]}},{
"bgpPath": {
"attributes": {
"aggr": "8.8.8.8",
"aggrAs": "100",
"asPath": "62112 33492 4872 41787",
"clusterLst": "",
"extComm": "RT:100:1 RT:1.1.1.1:1",
"flags": "advertise,atomic-aggr,best-path,metric",
"id": "0",
"importedRd": "unknown:unknown:0:0",
"localPref": "100",
"metric": "476387081",
"nh": "19.0.101.2",
"nhMetric": "0",
"operSt": "valid",
"origin": "igp",
"originatorId": "0.0.0.0",
"peer": "19.0.101.2",
"peerRtrId": "19.0.101.2",
"rcvdLbl": "",
"regComm": "1:50081 2:21461 3:58376 4:29755",
"rn": "path-[19.0.101.2]-id-0-nh-[19.0.101.2]",
"type": "internal",
"unknownAttrData": "",
"unknownAttrLen": "0",
"weight": "0"
},
"children": [
{
"bgpAsSeg": {
"attributes": {
"order": "1",
"rn": "seg-1"
},
"children": [
{
"bgpAsItem": {
"attributes": {
"asn": "62112",
"order": "1",
"rn": "asn-1"
}}},{
"bgpAsItem": {
"attributes": {
"asn": "41787",
"order": "4",
"rn": "asn-4"
}}},{
"bgpAsItem": {
"attributes": {
"asn": "4872",
"order": "3",
"rn": "asn-3"
}}},{
"bgpAsItem": {
"attributes": {
"asn": "33492",
"order": "2",
"rn": "asn-2"
}}}]}},{
"bgpRegComm": {
"attributes": {
"community": "regular:as2-nn2:3:58376",
"rn": "rcomm-regular:as2-nn2:3:58376"
}}},{
"bgpRegComm": {
"attributes": {
"community": "regular:as2-nn2:2:21461",
"rn": "rcomm-regular:as2-nn2:2:21461"
}}},{
"bgpRegComm": {
"attributes": {
"community": "regular:as2-nn2:1:50081",
"rn": "rcomm-regular:as2-nn2:1:50081"
}}},{
"bgpRegComm": {
"attributes": {
"community": "regular:as2-nn2:4:29755",
"rn": "rcomm-regular:as2-nn2:4:29755"
}}},{
"bgpExtComm": {
"attributes": {
"encap": "unknown",
"rn": "ecomm",
"rtrMac": "00:00:00:00:00:00"
},
"children": [
{
"bgpExtCommRt": {
"attributes": {
"community": "extended:ipv4-nn2:1.1.1.1:1",
"rn": "rt-extended:ipv4-nn2:1.1.1.1:1"
}}},{
"bgpExtCommRt": {
"attributes": {
"community": "extended:as2-nn2:100:1",
"rn": "rt-extended:as2-nn2:100:1"
}}}]}}]}},{
"bgpPath": {
"attributes": {
"aggr": "8.8.8.8",
"aggrAs": "100",
"asPath": "38050 9430 46344 17724",
"clusterLst": "",
"extComm": "RT:100:1 RT:1.1.1.1:1",
"flags": "atomic-aggr,metric",
"id": "0",
"importedRd": "unknown:unknown:0:0",
"localPref": "100",
"metric": "2921604939",
"nh": "19.0.101.3",
"nhMetric": "0",
"operSt": "valid",
"origin": "igp",
"originatorId": "0.0.0.0",
"peer": "19.0.101.3",
"peerRtrId": "19.0.101.3",
"rcvdLbl": "",
"regComm": "1:26019 2:62933 3:34313 4:5693",
"rn": "path-[19.0.101.3]-id-0-nh-[19.0.101.3]",
"type": "internal",
"unknownAttrData": "",
"unknownAttrLen": "0",
"weight": "0"
},
"children": [
{
"bgpAsSeg": {
"attributes": {
"order": "1",
"rn": "seg-1"
},
"children": [
{
"bgpAsItem": {
"attributes": {
"asn": "38050",
"order": "1",
"rn": "asn-1"
}}},{
"bgpAsItem": {
"attributes": {
"asn": "17724",
"order": "4",
"rn": "asn-4"
}}},{
"bgpAsItem": {
"attributes": {
"asn": "46344",
"order": "3",
"rn": "asn-3"
}}},{
"bgpAsItem": {
"attributes": {
"asn": "9430",
"order": "2",
"rn": "asn-2"
}}}]}},{
"bgpRegComm": {
"attributes": {
"community": "regular:as2-nn2:4:5693",
"rn": "rcomm-regular:as2-nn2:4:5693"
}}},{
"bgpRegComm": {
"attributes": {
"community": "regular:as2-nn2:1:26019",
"rn": "rcomm-regular:as2-nn2:1:26019"
}}},{
"bgpRegComm": {
"attributes": {
"community": "regular:as2-nn2:3:34313",
"rn": "rcomm-regular:as2-nn2:3:34313"
}}},{
"bgpRegComm": {
"attributes": {
"community": "regular:as2-nn2:2:62933",
"rn": "rcomm-regular:as2-nn2:2:62933"
}}},{
"bgpExtComm": {
"attributes": {
"encap": "unknown",
"rn": "ecomm",
"rtrMac": "00:00:00:00:00:00"
},
"children": [
{
"bgpExtCommRt": {
"attributes": {
"community": "extended:ipv4-nn2:1.1.1.1:1",
"rn": "rt-extended:ipv4-nn2:1.1.1.1:1"
}}},{
"bgpExtCommRt": {
"attributes": {
"community": "extended:as2-nn2:100:1",
"rn": "rt-extended:as2-nn2:100:1"
}}}]}}]}}]}}]}}]}