Querying Ephemeral Data

Ephemeral data must be queried with an ephemeral qualifier. With this query, a batch-id (usually 1) and a batch-size must be specified. In the example below, batch-size is specified as 20000. See the list below for more information about the query fields.

• rsp-foreign-subtree=ephemeral—Specifies that this is an ephemeral request, retrieving high-volume data.
• rsp-subtree=full—Should be specified to retrieve all children under the dn query.
• batch-id—An integer with a range of 1 to N. You can specify in increments (1, 2, 3, …) to retrieve data in iteration.
• batch-size—An integer with a range of 1 to 100,000. You can specify the maximum number of managed objects to be retrieved in each batch iteration.

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

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"
}}}]}}]}}]}}]}}]}

Querying the Routes Advertised to a Peer

This section contains the 4 steps for querying the routes advertised to a peer:

1. Attempt to retrieve a batch size.
2. Send a request using a batch size that matches the route size (13) in the step 1 response.
3. Increment the batch-id for each additional request.
4. Repeat Step 3 until a 400 bad request error is received. This occurs after the last batch is reached.

Step 1

Attempt to retrieve a batch size.

Step 1

GET http://<IP_Address>/api/mo/sys/bgp/inst/dom-[vpn3]/peer-[21.0.101.1]/af-[ipv4-ucast]/advtdrt.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-**size=1**&batch-id=1

{
    "totalCount": "0",
    "imdata": [
        {
            "warning": {
                "attributes": {
                    "text": "backend rv=0, Batch size [1] is less than Route size [13]. Increase the batch-size and try again"
}}}]}

Step 2

Send a request using a batch size that matches the route size (13) in the step 1 response.

Step 2

GET http://<IP_Address>/api/mo/sys/bgp/inst/dom-[vpn3]/peer-[21.0.101.1]/af-[ipv4-ucast]/advtdrt.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-size=13&batch-id=1

{
"totalCount": "1",
"imdata": [
{
    "bgpAdvtdRoutes": {
        "attributes": {
            "dn": "sys/bgp/inst/dom-vpn3/peer-[21.0.101.1]/af-ipv4-ucast/advtdrt"
},
"children": [
    {
        "bgpRoute": {
            "attributes": {
                "bestPathId": "2",
                "numPaths": "1",
                "pfx": "1.1.1.0/24",
                "rd": "unknown:unknown:0:0",
                "rn": "rt-[1.1.1.0/24]",
                "rtFlags": "best,rib,xmit",
                "ver": "147"
},
"children": [
    {
        "bgpPath": {
            "attributes": {
                "aggr": "0.0.0.0",
                "aggrAs": "0",
                "asPath": "{62112 33492 4872 41787 13166 50081 21461 58376 29755 1135}",
                "clusterLst": "21.0.102.1,21.0.102.1",
                "extComm": "",
                "flags": "advertise,best-path",
                "id": "0",
                "importedRd": "unknown:unknown:0:0",
                "localPref": "100",
                "metric": "0",
                "nh": "21.0.102.1",
                "nhMetric": "0",
                "operSt": "valid",
                "origImportedRd": "unknown:unknown:0:0",
                "origin": "igp",
                "originatorId": "5.5.5.102",
                "peer": "21.0.102.1",
                "peerRtrId": "21.0.102.1",
                "rcvdLbl": "",
                "regComm": "",
                "rn": "path-[21.0.102.1]-id-0-nh-[21.0.102.1]-imprd-unknown:unknown:0:0-origimprd-unknown:unknown:0:0",
                "type": "internal",
                "unknownAttrData": "",
                "unknownAttrLen": "0",
                "weight": "0"
},
"children": [
    {
        "bgpAsSeg": {
            "attributes": {
                "order": "1",
                "rn": "seg-1"
},
"children": [
    {
"bgpAsItem": {
    "attributes": {
        "asn": "13166",
        "order": "5",
        "rn": "asn-5"
}}},{
"bgpAsItem": {
    "attributes": {
        "asn": "62112",
        "order": "1",
        "rn": "asn-1"
}}},{
"bgpAsItem": {
    "attributes": {
        "asn": "21461",
        "order": "7",
        "rn": "asn-7"
}}},{
"bgpAsItem": {
    "attributes": {
        "asn": "50081",
        "order": "6",
        "rn": "asn-6"
}}},{
"bgpAsItem": {
    "attributes": {
        "asn": "41787",
        "order": "4",
        "rn": "asn-4"
}}},{
"bgpAsItem": {
    "attributes": {
        "asn": "58376",
        "order": "8",
        "rn": "asn-8"
}}},{
"bgpAsItem": {
    "attributes": {
        "asn": "1135",
        "order": "10",
        "rn": "asn-10"
}}},{
"bgpAsItem": {
    "attributes": {
        "asn": "4872",
        "order": "3",
        "rn": "asn-3"
}}},{
"bgpAsItem": {
    "attributes": {
        "asn": "29755",
        "order": "9",
        "rn": "asn-9"
}}},{
"bgpAsItem": {
    "attributes": {
        "asn": "33492",
        "order": "2",
        "rn": "asn-2"
}}}]}}]}}]}}]}}]}

Step 3

Increment the batch-id for each additional request.

Step 3

GET http://<IP_Address>/api/mo/sys/bgp/inst/dom-[vpn3]/peer-[21.0.101.1]/af-[ipv4-ucast]/advtdrt.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-size=13&batch-id=2

{
"totalCount": "1",
"imdata": [
{
"bgpAdvtdRoutes": {
    "attributes": {
        "dn": "sys/bgp/inst/dom-vpn3/peer-[21.0.101.1]/af-ipv4-ucast/advtdrt"
},
"children": [
{
"bgpRoute": {
    "attributes": {
        "bestPathId": "2",
        "numPaths": "1",
        "pfx": "1.1.2.0/24",
        "rd": "unknown:unknown:0:0",
        "rn": "rt-[1.1.2.0/24]",
        "rtFlags": "best,rib,xmit",
        "ver": "148"
},
"children": [
{
"bgpPath": {
    "attributes": {
        "aggr": "0.0.0.0",
        "aggrAs": "0",
        "asPath": "{62112 33492 4872 41787 13166 50081 21461 58376 29755 1135}",
        "clusterLst": "21.0.102.1,21.0.102.1",
        "extComm": "",
        "flags": "advertise,best-path",
        "id": "0",
        "importedRd": "unknown:unknown:0:0",
        "localPref": "100",
        "metric": "0",
        "nh": "21.0.102.1",
        "nhMetric": "0",
        "operSt": "valid",
        "origImportedRd": "unknown:unknown:0:0",
        "origin": "igp",
        "originatorId": "5.5.5.102",
        "peer": "21.0.102.1",
        "peerRtrId": "21.0.102.1",
        "rcvdLbl": "",
        "regComm": "",
        "rn": "path-[21.0.102.1]-id-0-nh-[21.0.102.1]-imprd-unknown:unknown:0:0-origimprd-unknown:unknown:0:0",
        "type": "internal",
        "unknownAttrData": "",
        "unknownAttrLen": "0",
        "weight": "0"
},
"children": [
{
"bgpAsSeg": {
    "attributes": {
        "order": "1",
        "rn": "seg-1"
},
"children": [
{
"bgpAsItem": {
    "attributes": {
        "asn": "13166",
        "order": "5",
        "rn": "asn-5"
}}},{
"bgpAsItem": {
    "attributes": {
        "asn": "62112",
        "order": "1",
        "rn": "asn-1"
}}},{
"bgpAsItem": {
    "attributes": {
        "asn": "21461",
        "order": "7",
        "rn": "asn-7"
}}},{
"bgpAsItem": {
    "attributes": {
        "asn": "50081",
        "order": "6",
        "rn": "asn-6"
}}},{
"bgpAsItem": {
    "attributes": {
        "asn": "41787",
        "order": "4",
        "rn": "asn-4"
}}},{
"bgpAsItem": {
    "attributes": {
        "asn": "58376",
        "order": "8",
        "rn": "asn-8"
}}},{
"bgpAsItem": {
    "attributes": {
        "asn": "1135",
        "order": "10",
        "rn": "asn-10"
}}},{
"bgpAsItem": {
    "attributes": {
        "asn": "4872",
        "order": "3",
        "rn": "asn-3"
}}},{
"bgpAsItem": {
    "attributes": {
        "asn": "29755",
        "order": "9",
        "rn": "asn-9"
}}},{
"bgpAsItem": {
    "attributes": {
        "asn": "33492",
        "order": "2",
        "rn": "asn-2"
}}}]}}]}}]}}]}}]}

Step 4

A 400 bad request error is received after the last batch is reached.

Step 4

GET http://<IP_Address>/api/mo/sys/bgp/inst/dom-[vpn3]/peer-[21.0.101.1]/af-[ipv4-ucast]/advtdrt.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-size=13&batch-id=11

{
    "imdata": [
{
"error": {
    "attributes": {
        "code": "123",
        "text": "Foreign Ephemeral lookup failed: Invalid user input: batch-id argument must be 1 for the first batch of this DN, specified 11"
}}}]}

switch# show bgp ipv4 unicast neighbors 21.0.101.1 advertised-routes vrf vpn3

Peer 21.0.101.1 routes for address family IPv4 Unicast:
BGP table version is 156, Local Router ID is 21.0.0.2
Status: s-suppressed, x-deleted, S-stale, d-dampened, h-history, -valid , >-best
Path type: i-internal, e-external, c-confed, l-local, a-aggregate, r-redist, I-i
njected
Origin codes: i - IGP, e - EGP, ?- incomplete, |- multipath, - backup
  Network            Next Hop            Metric     LocPrf     Weight Path
>i1.1.1.0/24         21.0.102.1                        100          0 {62112 33
492 4872 41787 13166 50081 21461 58376 29755 1135} i
>i1.1.2.0/24         21.0.102.1                        100          0 {62112 33
492 4872 41787 13166 50081 21461 58376 29755 1135} i  
>i1.1.3.0/24         21.0.102.1                        100          0 {62112 33
492 4872 41787 13166 50081 21461 58376 29755 1135} i
>i1.1.4.0/24         21.0.102.1                        100          0 {62112 33
492 4872 41787 13166 50081 21461 58376 29755 1135} i   
>i1.1.5.0/24         21.0.102.1                        100          0 {62112 33
492 4872 41787 13166 50081 21461 58376 29755 1135} i
>i2.2.2.0/24         21.0.102.1                        100          0 {38050 94
30 46344 17724 54639 26019 62933 34313 5693 42608} i    
>i2.2.3.0/24         21.0.102.1                        100          0 {38050 94
30 46344 17724 54639 26019 62933 34313 5693 42608} i
>i2.2.4.0/24         21.0.102.1                        100          0 {38050 94
30 46344 17724 54639 26019 62933 34313 5693 42608} i  
>i2.2.5.0/24         21.0.102.1                        100          0 {38050 94
30 46344 17724 54639 26019 62933 34313 5693 42608} i
*>i2.2.6.0/24         21.0.102.1                        100          0 {38050 94
30 46344 17724 54639 26019 62933 34313 5693 42608} i