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

Ephemeral REST Output

DME

Copy
http://{{ip}}/api/mo/sys/arp/inst/dom-management/db-ip.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=20000
{
  "totalCount": "1",
  "imdata": [
    {
      "arpDb": {
        "attributes": {
          "childAction": "",
          "dn": "sys/arp/inst/dom-management/db-ip",
          "modTs": "never",
          "persistentOnReload": "false",
          "status": "",
          "type": "ip"
        },
        "children": [
          {
            "arpAdjEp": {
              "attributes": {
                "childAction": "",
                "ifId": "mgmt0",
                "ip": "10.77.143.2",
                "mac": "50:87:89:4C:EE:41",
                "modTs": "never",
                "operSt": "normal",
                "persistentOnReload": "false",
                "physIfId": "mgmt0",
                "rn": "adj-[mgmt0]-[10.77.143.2]",
                "status": "",
                "upTS": "2016-11-03T09:14:14.191+00:00"
}}},{
            "arpAdjEp": {
              "attributes": {
                "childAction": "",
                "ifId": "mgmt0",
                "ip": "10.77.143.3",
                "mac": "50:87:89:4C:AB:C1",
                    "modTs": "never",
                "operSt": "normal",
                "persistentOnReload": "false",
                "physIfId": "mgmt0",
                "rn": "adj-[mgmt0]-[10.77.143.3]",
                "status": "",
                "upTS": "2016-11-03T09:22:26.536+00:00"
}}},{
            "arpAdjEp": {
              "attributes": {
                "childAction": "",
                "ifId": "mgmt0",
                "ip": "10.77.143.118",
                "mac": "42:50:3A:18:34:20",
                "modTs": "never",
                "operSt": "normal",
                "persistentOnReload": "false",
                "physIfId": "mgmt0",
                "rn": "adj-[mgmt0]-[10.77.143.118]",
                "status": "",
                "upTS": "2016-11-03T09:10:25.188+00:00"
}}},{
            "arpAdjEp": {
              "attributes": {
                "childAction": "",
                "ifId": "mgmt0",
                "ip": "10.77.143.1",
                "mac": "00:00:0C:9F:F0:D3",
                "modTs": "never",
                "operSt": "normal",
                "persistentOnReload": "false",
                "physIfId": "mgmt0",
                "rn": "adj-[mgmt0]-[10.77.143.1]",
                "status": "",
                "upTS": "2016-11-03T09:10:29.211+00:00"
}}},{
            "arpAdjEp": {
              "attributes": {
                "childAction": "",
                "ifId": "mgmt0",
                "ip": "10.77.143.116",
                     "mac": "00:06:F6:E6:40:3A",
                "modTs": "never",
                "operSt": "normal",
                "persistentOnReload": "false",
                "physIfId": "mgmt0",
                "rn": "adj-[mgmt0]-[10.77.143.116]",
                "status": "",
                "upTS": "2016-11-03T09:10:25.188+00:00"
}}},{
            "arpAdjEp": {
              "attributes": {
                "childAction": "",
                "ifId": "mgmt0",
                "ip": "10.77.143.27",
                "mac": "00:50:56:AA:1F:41",
                "modTs": "never",
                "operSt": "normal",
                "persistentOnReload": "false",
                "physIfId": "mgmt0",
                "rn": "adj-[mgmt0]-[10.77.143.27]",
                "status": "",
                "upTS": "2016-11-03T09:10:35.001+00:00"
}}}]}}]}

Querying Ephemeral Operational 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.

Note: This was added in Release Cisco NX-OS Release 7.0(3)I7(2).

Command	Ephemeral DN Query	Description
`show ip arp suppression topo-info` `show ip arp suppression topo-info [topo-id]`	For all VLANs `http://{{ip}}/mo/sys/arp/inst/db-supcache.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000` For one VLAN `http://{{ip}}/mo/sys/arp/inst/db-supcache/vlan-1.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000`	Displays ARP L2RIB topology information
`show ip arp suppression-cache { detail [vlan <vlan_id>] \| vlan <vlan_id> \| local [vlan <vlan_id>] \| remote [vlan <vlan_id>] }`	For all ARP suppression entries `http://{{ip}}/mo/sys/arp/inst/db-supcache.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000` For all suppression entries under one VLAN `http://{{ip}}/mo/sys/arp/inst/db-supcache/vlan-1.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000` For one suppression entry `http://{{ip}}/mo/sys/arp/inst/db-supcache/vlan-[id]/ip-[[ip]].json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000`	Displays ARP suppression information information
`show ip arp { <ip-address> \| vrf <vrf-name> \| <vrf-known-name>}`	For all entries under one VRF `http://{{ip}}/mo/sys/arp/inst/dom- [name]/db-[type].json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000` For one ARP entry `mo/sys/arp/inst/dom- [name]/db-[type]/adj-[[ifId]]-[[ip]].json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000`	Displays IP ARP table
`show ip adjacency [<interface> \| <ip-addr> [vrf {<vrf-name> \| <vrf-known-name> \| all}]`	For all adjacency `http://{{ip}}/mo/sys/adjacency/inst.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000` For all IPv4 adjacencies under one VRF `http://{{ip}}/mo/sys/adjacency/inst/dom-[name]/db-ip.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000` For one IPv4 adjacency `http://{{ip}}/mo/sys/adjacency/inst/dom-[name] /db-ip/if-[[ifId]]/ip-[[ip]].json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000`	Displays IP adjacency table
`show ipv6 adjacency [<interface> \| <ip-addr> [vrf {<vrf-name> \| <vrf-known-name> \| all}]`	For all adjacency `http://{{ip}}/mo/sys/adjacency/inst.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000` For all IPv6 adjacencies under one VRF `http://{{ip}}/mo/sys/adjacency/inst/dom-[name]/db-ipv6.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000` For one IPv6 adjacency `http://{{ip}}/mo/sys/adjacency/inst/dom-[name]/db-ipv6/if-[[ifId]]/ip-[[ip]].json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000`	Displays IPv6 adjacency table
`show ip arp statistics [<interface>] [interface-all] [vrf {<vrf-name> \| <vrf-known-name> \| all}]`	ARP statistics for all interfaces `http://{{ip}}/mo/sys/arp/inst.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000` ARP statistics for all interfaces under one VRF `http://{{ip}}/mo/sys/arp/inst/dom-[name]/.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000` ARP statistics for one interface `http://{{ip}}/mo/sys/arp/inst/dom-[name]/if-[[ifId]].json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000`	Displays ARP packet statistics
`show ip arp open-flow error-statistics`	`http://{{ip}}/mo/sys/arp/inst/globalstats/ofastats.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000`	Displays open-flow error statistics
`show ip arp suppression-cache {statistics}`	`http://{{ip}}/mo/sys/arp/inst/globalstats/supcachestats.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000`	Displays suppression cache statistics
`show ip arp vpc-statistics`	`http://{{ip}}/mo/sys/arp/inst/globalstats/vpcstats.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000`	Displays IP ARP vPC statistics
`show ip arp tunnel-statistics`	`http://{{ip}}/mo/sys/arp/inst/globalstats/tunnelstats.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000`	Displays IP ARP tunnel statistics
`show ip arp controller-statistics`	`http://{{ip}}/mo/sys/arp/inst/globalstats/controllerstats.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000`	Displays IP ARP controller statistics
`show ip arp multihoming-statistics`	`http://{{ip}}/mo/sys/arp/inst/dom-management/if-[mgmt0]/ifstatsmh.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=1000`	Displays IP ARP multihoming statistics