Querying a Summary of IP Interface Status and Configuration Information

Querying a Summary of Interface Status and Configuration Information

GET http://<IP_Address>/api/mo/sys/ipv4/inst/dom-management/if-[mgmt0]/stat.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=10

{
    "totalCount": "1",
    "imdata": [
        {
            "ipv4IfStat": {
                "attributes": {
                    "aclIn": "",
                    "aclOut": "",
                    "adminState": "up",
                    "bcastAddr": "255.255.255.255",
                    "directBcast": "disabled",
                    "dn": "sys/ipv4/inst/dom-management/if-[mgmt0]/stat",
                    "firstIod": "0",
                    "icmpRedirect": "enabled",
                    "iodValue": "2",
                    "ipDisabled": "TRUE",
                    "ipLoadSharing": "none",
                    "ipUnreach": "disabled",
                    "linkState": "up",
                    "localProxyArp": "disabled",
                    "mAddr": "",
                    "mRouting": "disabled",
                    "mtu": "1500",
                    "numAddr": "0",
                    "numMaddr": "0",
                    "numVaddr": "0",
                    "portUnreach": "enabled",
                    "pref": "0",
                    "priAddr": "10.77.143.134",
                    "priMasklen": "24",
                    "priRoutePref": "0",
                    "priSubnet": "10.77.143.0",
                    "priTag": "0",
                    "protoState": "up",
                    "proxyArp": "disabled",
                    "secAddr": "",
                    "secAddrMasklen": "",
                    "secAddrRoutePref": "",
                    "secAddrSubnet": "",
                    "secAddrTag": "",
                    "statsLastReset": "never",
                    "tag": "0",
                    "unnumChildIntf": "",
                    "unnumIntf": "",
                    "urpfMode": "none",
                    "vaddrClient": "",
                    "vaddrMasklen": "",
                    "vaddrPrefix": "",
                    "vaddrSubnet": "",
                    "vrfNameOut": "management"
                }
            }
        },
        {
            "warning": {
                "attributes": {
                    "text": "backend rv=43700005, Fetch complete"
                }
            }
        }
    ]
} 

Note: This example was added in Cisco NX-OS Release 9.2(1).

Switch# show ip interface brief vrf management 

IP Interface Status for VRF "management"(2)
Interface            IP Address      Interface Status
mgmt0                10.77.143.134   protocol-up/link-up/admin-up       


switch(config)# show ip interface mgmt0

IP Interface Status for VRF "management"(2)
mgmt0, Interface status: protocol-up/link-up/admin-up, iod: 2,
  IP address: 10.77.143.134, IP subnet: 10.77.143.0/24 route-preference: 0, tag:
 0 
  IP broadcast address: 255.255.255.255
  IP multicast groups locally joined: none
  IP MTU: 1500 bytes (using link MTU)
  IP primary address route-preference: 0, tag: 0
  IP proxy ARP : disabled
  IP Local Proxy ARP : disabled
  IP multicast routing: disabled
  IP icmp redirects: enabled
  IP directed-broadcast: disabled 
  IP Forwarding: disabled 
  IP icmp unreachables (except port): disabled
  IP icmp port-unreachable: enabled
  IP unicast reverse path forwarding: none
  IP load sharing: none 
  IP interface statistics last reset: never
  IP interface software stats: (sent/received/forwarded/originated/consumed)
    Unicast packets    : 3244/5598/0/3244/11196
    Unicast bytes      : 491021/506181/0/491021/1012188
    Multicast packets  : 0/79282/0/0/0
    Multicast bytes    : 0/7948514/0/0/0
    Broadcast packets  : 0/5159/0/0/0
    Broadcast bytes    : 0/710173/0/0/0
    Labeled packets    : 0/0/0/0/0
    Labeled bytes      : 0/0/0/0/0
  WCCP Redirect outbound: disabled
  WCCP Redirect inbound: disabled
  WCCP Redirect exclude: disabled

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

ipv4IfStat Properties

The following table contains information about the ipv4IfStat 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.

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