Ephemeral REST Output
Ephemeral REST Output
GET 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
{
"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"
}}}]}}]}}]}}]}}]}
For CLI info, 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
Note: The property information for this example was added in Release 9.3(3).
bgpDomAf Properties
The following table contains information about the bgpDomAf 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 |
|---|---|---|---|
| advSysMac | bgp:AdminSt (scalar:Enum8) | Advertise extra EVPN RT-2 with system MAC | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
| advertL2vpnEvpn | bgp:AdvertL2vpnEvpn (scalar:Enum8) | Advertise L2vpn Evpn | SELECTION: 0 - disabled 1 - enabled DEFAULT: disabled |
| allocLblAll | bgp:AdminSt (scalar:Enum8) | Allocate labels for all routes | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
| allocLblRtMap | string:Basic | Allocate labels for selective routes | A sequence of characters |
| bestPathCmpltTs | scalar:Date | The first best path completed timestamp. | DATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z |
| bestPathSigTs | scalar:Date | The first best path signalled timestamp. | DATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z |
| childAction | mo:ModificationChildAction scalar:Bitmask32 | Delete or ignore. For internal use only. | SELECTION:
|
| clReflection | bgp:AdminSt (scalar:Enum8) | client-to-client Reflection of routes | SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled |
| critNhTimeout | bgp:NhTimeout (scalar:Uint32) | The next-hop address tracking delay timer for critical next-hop reachability routes. | RANGE: [1 , 4294967295] DEFAULT: crit |
| defInfOrigRd | base:Community | Default-information Originate always Route Distinguisher | |
| defInfOrigRtt | base:Community | Default-information Originate always Route Target | |
| defInfOriginate | bgp:AdminSt (scalar:Enum8) | default-information originate | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
| defMetric | string:Basic | Default Metric | A sequence of characters |
| dn | reference:BinRef | A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module. | |
| igpMetric | bgp:igpMetric (scalar:Uint16) | Dampen IGP metric-related changes | RANGE: [0 , 3600] DEFAULT: 600 |
| lblAllocMod | bgp:AdminSt (scalar:Enum8) | per VRF label allocation mode | SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled |
| maxEcmp | bgp:MaxEcmp (scalar:UByte) | The maximum number of equal-cost paths for BGP load sharing. | RANGE: [1 , 64] DEFAULT: 1 |
| maxExtEcmp | bgp:MaxEcmp (scalar:UByte) | Max External ECMP | RANGE: [1 , 64] DEFAULT: 1 |
| modTs | mo:TStamp (scalar:Date) | The time when this object was last modified. | SELECTION: 0 - never DEFAULT: never |
| name | naming:Name256 string:Basic | The name of the object. | RANGE:
Min: "1"
Max: "128" |
| nhRtMap | string:Basic | Next hop route map name | A sequence of characters |
| nonCritNhTimeout | bgp:NhTimeout (scalar:Uint32) | The next-hop address tracking delay timer for non-critical next-hop reachability routes. | RANGE: [1 , 4294967295] DEFAULT: noncrit |
| numAggregates | scalar:Uint32 | Number of Aggregates | RANGE: [0, 4294967295] |
| numNetworks | scalar:Uint32 | Number of Networks | RANGE: [0, 4294967295] |
| numPaths | bgp:NumPaths (scalar:Uint32) | Number of Paths | RANGE: [0, 4294967295] |
| numPeers | bgp:NumPeers (scalar:Uint32) | Number of Peers | RANGE: [0, 4294967295] |
| numPeersActive | bgp:NumPeers (scalar:Uint32) | Number of Active Peers | RANGE: [0, 4294967295] |
| numRoutes | bgp:NumPaths (scalar:Uint32) | Number of Routes | RANGE: [0, 4294967295] |
| persistentOnReload | mo:Persistent scalar:Enum8 | NO COMMENTS | SELECTION:
|
| retainRttAll | bgp:AdminSt (scalar:Enum8) | Retain Route Target All | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
| retainRttRtMap | string:Basic | Retain Route Target Route Map | A sequence of characters |
| status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
| supprInactive | bgp:AdminSt (scalar:Enum8) | Advertise only active routes to peers | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
| tblId | bgp:TblVer (scalar:Uint32) | Table Id in hex display | RANGE: [0, 4294967295] |
| tblMap | string:Basic | Route-map name | A sequence of characters |
| tblMapFltr | bgp:AdminSt (scalar:Enum8) | Selective route download | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
| tblSt | bgp:DomOperSt (scalar:Enum8) | Local BGP table state | SELECTION: 0 - unknown 1 - up 2 - down DEFAULT: unknown |
| tblVer | bgp:TblVer (scalar:Uint32) | Table Version | RANGE: [0, 4294967295] |
| tmrBstpthDfr | scalar:Uint32 | Configure bgp related timers | RANGE: [0 , 3000] |
| tmrMax | scalar:Uint32 | Configure bestpath defer timer | RANGE: [0 , 300000] |
| type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 2 - ipv4-mcast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 11 - ipv6-lucast 12 - lnkstate 13 - ipv4-mvpn 14 - ipv6-mvpn 15 - l2vpn-vpls 16 - ipv4-mdt DEFAULT: ipv4-ucast |
| uid | scalar:Uint16 | A unique identifier for this object. | |
| vniEthTag | bgp:AdminSt (scalar:Enum8) | Allow VNI in Ethernet Tag field in EVPN route | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
bgpRoute Properties
The following table contains information about the bgpRoute 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 |
|---|---|---|---|
| bestPathId | bgp:PathId (scalar:Uint32) | Bestpath Id | RANGE: [0, 4294967295] |
| numPaths | scalar:Uint32 | Number of paths available | RANGE: [0, 4294967295] |
| pfx | address:Ip | Prefix | Value must match ipv4 or ipv6 known format |
| rd | base:Community | A unique value that extends the formal network address for all routes in a particular VRF, making the route unique within the entire BGP table. | |
| 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. | |
| rtFlags | bgp:RtFlags (scalar:Bitmask32) | Flags | SELECTION: 1 - new 2 - xmit 4 - rib 8 - best 16 - suppressed 32 - exported 64 - locked 128 - vpn 256 - label 512 - l2rib-evpn 1024 - hw 2048 - table-map-filtered |
| ver | bgp:RtVer (scalar:Uint32) | Version of the route | RANGE: [0, 4294967295] |
bgpPath Properties
The following table contains information about the bgpPath 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 |
|---|---|---|---|
| aggr | address:Ip | Aggregator | Value must match ipv4 or ipv6 known format |
| aggrAs | bgp:AsnNum (string:Basic) | Aggregator AS | A sequence of characters |
| asPath | string:Basic | AS-Path | A sequence of characters |
| clusterLst | string:Basic | Cluster-List | A sequence of characters |
| extComm | string:Basic | Extcommunity | A sequence of characters |
| flags | bgp:PathFlags (scalar:Bitmask32) | Path flags | SELECTION: 1 - max-as-limit 2 - best-path 4 - rcvd-only 8 - modified 16 - multipath 32 - imported 64 - metric 128 - atomic-aggr 256 - unk-attr 512 - advertise 1024 - discarded-attr |
| id | bgp:PathId (scalar:Uint32) | Path id | RANGE: [0, 4294967295] |
| importedRd | base:Community | Imported route distinguisher | |
| localPref | rtmap:LocalPref (scalar:Uint32) | Local preference | RANGE: [0, 4294967295] |
| metric | rtmap:Metric (scalar:Uint32) | Metric | RANGE: [0, 4294967295] |
| nh | address:Ip | Next hop | Value must match ipv4 or ipv6 known format |
| nhMetric | bgp:Metric (scalar:Uint32) | Nexthop metric | RANGE: [0, 4294967295] |
| operSt | bgp:PathSt (scalar:Enum8) | The path status. | SELECTION: 0 - deleted 1 - staled 2 - valid 3 - invalid 4 - history 5 - suppressed 6 - dampened |
| origin | bgp:Origin (scalar:Enum8) | Origin | SELECTION: 1 - igp 2 - egp 3 - incomplete DEFAULT: igp |
| originatorId | address:Ip | Originator Id | Value must match ipv4 or ipv6 known format |
| peer | address:Ip | Peer source of route path | Value must match ipv4 or ipv6 known format |
| peerRtrId | string:Basic | Peer router id ipaddress | A sequence of characters |
| rcvdLbl | string:Basic | Received label | A sequence of characters |
| regComm | string:Basic | The regular community. | A sequence of characters |
| 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. | |
| type | bgp:PathT (scalar:Enum8) | Path type | SELECTION: 1 - internal 2 - external 3 - confederation 4 - local 5 - aggregate 6 - redistribute 7 - injected DEFAULT: internal |
| unknownAttrData | string:Basic | Unknown Attribute Data | A sequence of characters |
| unknownAttrLen | bgp:UnknownAttrLen (scalar:Uint32) | Unknown Attribute Length | RANGE: [0 , 0xffffffff] |
| weight | rtmap:Weight (scalar:Uint16) | Weight | RANGE: [0, 65535] |
bgpAsSeg Properties
The following table contains information about the bgpAsSeg 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 |
|---|---|---|---|
| order | bgp:Order (scalar:Uint16) | Order | RANGE: [0, 65535] |
| 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. |
bgpAsItem Properties
The following table contains information about the bgpAsItem 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 |
|---|---|---|---|
| asn | bgp:AsnNum (string:Basic) | AS number | A sequence of characters |
| order | bgp:Order (scalar:Uint16) | Order | RANGE: [0, 65535] |
| 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. |
bgpRegComm Properties
The following table contains information about the bgpRegComm 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 |
|---|---|---|---|
| community | base:Community | Community value | |
| 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. |
bgpExtComm Properties
The following table contains information about the bgpExtComm 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 |
|---|---|---|---|
| encap | base:Encap | Encapsulation | SELECTION: unknown, vlan-%d or vxlan-%d |
| 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. | |
| rtrMac | address:MAC | Router Mac address from nve | Value must match MM:MM:MM:SS:SS:SS format |
bgpExtCommRt Properties
The following table contains information about the bgpExtCommRt 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 |
|---|---|---|---|
| community | base:Community | Community value | |
| 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. |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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: