Querying ARP, Adjacency Statistics, and Tables

Controller Statistics

Controller Statistics

POST http://<IP_Address>/api/node/mo/sys/arp/inst/globalstats/controllerstats.json?rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=20000

{
  "totalCount": "1",
  "imdata": [
    {
      "arpControllerStats": {
        "attributes": {
          "adjAddCount": "0",
          "adjAddErrorCount": "0",
          "adjDelCount": "0",
          "adjDelErrorCount": "0",
          "childAction": "",
          "dn": "sys/arp/inst/globalstats/controllerstats",
          "modTs": "never",
          "persistentOnReload": "false",
          "status": ""
        }
      }
    }
  ]
}

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
arpControllerStats sys/arp/inst/globalstats/controllerstats


arpControllerStats Properties

The following table contains information about the arpControllerStats 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 NameData TypeDescriptionValues
adjAddCountscalar:Uint64
ARP Controller Adjacency Add CountRANGE: [0, 18446744073709551615]
adjAddErrorCountscalar:Uint64
ARP Controller Adjacency Add Error CountRANGE: [0, 18446744073709551615]
adjDelCountscalar:Uint64
ARP Controller Adjacency Delete CountRANGE: [0, 18446744073709551615]
adjDelErrorCountscalar:Uint64
ARP Controller Adjacency Delete Error CountRANGE: [0, 18446744073709551615]
childAction
mo:ModificationChildAction
scalar:Bitmask32		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • statusmo:ModificationStatus
    (scalar:Bitmask32)    		The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced


    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

    Querying Controller Statistics

    Querying Controller Statistics

    GET http://<IP_Address>/api/node/mo/sys/arp/inst/globalstats/controllerstats.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=20000

    Querying VPC Statistics

    Querying VPC Statistics

    GET http://<IP_Address>/api/node/mo/sys/arp/inst/globalstats/vpcstats.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=20000

    Querying Tunnel Statistics

    Querying Tunnel Statistics

    GET http://<IP_Address>/api/node/mo/sys/arp/inst/globalstats/tunnelstats.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=20000

    Querying Suppression Cache Information

    Querying Suppression Cache Information

    GET http://<IP_Address>/api/node/mo/sys/arp/inst/globalstats/supcachestats.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=20000

GET http://<IP_Address>/api/node/mo/sys/arp/inst/db-supcache/vlan-{id}.json

GET http://<IP_Address>/api/node/mo/sys/arp/inst/db-supcache/vlan-{id}/ip-{ip}.json

    Querying OpenFlow Statistics

    Querying OpenFlow Statistics

    
GET http://<IP_Address>/api/node/mo/sys/arp/inst/globalstats/ofastats.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=20000

    Querying Interface Statistics

    Querying Interface Statistics

    GET http://<IP_Address>/api/mo/sys/arp/inst/dom-{name}/if-[{id}].json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=20000

    Querying Adjacency Information

    Adjacency Information

    Query for IPv4 adjacency information dynamically learned through ARP:

GET http://<IP_Address>/api/node/mo/sys/arp/inst/dom-{name}/db-ip/if-[{id}]/ip-[{ip}].json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=20000

    
Query for complete adjacency table learned in the system:

GET http://<IP_Address>/api/node/mo/sys/adjacency/inst/dom-{name}/db-{ip | ipv6}/if-[{id}]/ip-[{ip}]].json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=20000

    Requesting IPv6 Adjacency Subnet Prefix Information

     Requesting IPv6 Adjacency Subnet Prefix Information

    GET   http://<mgmt0_IP>/api/mo/sys/adjacency/inst/dom-default/db-ipv6/subnetprefix.json?rsp-foreign-subtree=ephemeral&rsp-keep-prop-type=yes&batch-size=10&batch-id=1&rsp-subtree=full

    Note: This example was added in Release 9.3(1).


    CLI Commands

    The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the opt-left corner of the pane on the right to view the JSON payload. Click the YANG tab to view the XML payload.

    show ipv6 adjacency subnet-prefix


    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

    For detailed information about classes and attributes in the payloads, see the NX-API DME Model Reference: 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

    Requesting IPv6 Adjacency Aggregate Prefix Information

     Requesting IPv6 Adjacency Aggregate Prefix Information

    GET   http://<mgmt0_IP>/api/mo/sys/adjacency/inst/dom-default/db-ipv6/aggrprefix.json?rsp-foreign-subtree=ephemeral&rsp-keep-prop-type=yes&batch-size=10000&batch-id=1&rsp-subtree=full

    Note: This example was added in Release 9.3(1).


    CLI Commands

    The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the opt-left corner of the pane on the right to view the JSON payload. Click the YANG tab to view the XML payload.

    show ipv6 adjacency aggregate-prefix


    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

    For detailed information about classes and attributes in the payloads, see the NX-API DME Model Reference: 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