Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Latest
Querying a Summary of Interface Status and Configuration Information
DME
Copy
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

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

Querying a Summary of IP Interface Status and Configuration Information

Querying a Summary of Interface Status and Configuration Information

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

CLI Output
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.

Property NameData TypeDescriptionValues
aclInstring:Basic
Acl InA sequence of characters
aclOutstring:Basic
Acl OutA sequence of characters
adminStatestring:Basic
Admin StateA sequence of characters
bcastAddraddress:IPv4
Broadcast AddressValue must match ipv4 format
directBcastnw:AdminSt
(scalar:Enum8)		Directed BroadcastSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
dn
reference:BinRef		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
firstIodscalar:Uint64
First iodRANGE: [0, 18446744073709551615]
icmpRedirectnw:AdminSt
(scalar:Enum8)		Icmp RedirectSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
iodValuescalar:Uint64
Iod ValueRANGE: [0, 18446744073709551615]
ipDisabledstring:Basic
IP DisabledA sequence of characters
ipLoadSharingstring:Basic
IP Load Sharing TypeA sequence of characters
ipUnreachnw:AdminSt
(scalar:Enum8)		IP UnreachableSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
linkStatestring:Basic
Link StateA sequence of characters
localProxyArpnw:AdminSt
(scalar:Enum8)		Local Proxy ArpSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
mAddrstring:Basic
IP Multicast Groups AddressA sequence of characters
mRoutingnw:AdminSt
(scalar:Enum8)		Multicast RoutingSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
mtuscalar:Uint16
MTURANGE: [0, 65535]
numAddrscalar:Uint32
Number of addressesRANGE: [0, 4294967295]
numMaddrscalar:Uint32
Number of multicast addressesRANGE: [0, 4294967295]
numVaddrscalar:Uint64
Number of virtual addressesRANGE: [0, 18446744073709551615]
portUnreachnw:AdminSt
(scalar:Enum8)		Port UnreachableSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
prefscalar:UByte
PreferenceRANGE: [0, 255]
priAddraddress:IPv4
Primary AddressValue must match ipv4 format
priMasklenscalar:UByte
Primary Address MasklenRANGE: [0, 255]
priRoutePrefscalar:UByte
Primary address route preferenceRANGE: [0, 255]
priSubnetaddress:Subnet
Primary Address Subnet
priTagscalar:Uint32
Primary Address TagRANGE: [0, 4294967295]
protoStatestring:Basic
Protocol stateA sequence of characters
proxyArpnw:AdminSt
(scalar:Enum8)		Proxy ArpSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
secAddrstring:Basic
Secondary IP AddressA sequence of characters
secAddrMasklenstring:Basic
Secondary Address MasklenA sequence of characters
secAddrRoutePrefstring:Basic
Secondary address route preferenceA sequence of characters
secAddrSubnetstring:Basic
Secondary Address SubnetA sequence of characters
secAddrTagstring:Basic
Secondary Address TagA sequence of characters
statsLastResetstring:Basic
Stats Last ResetA sequence of characters
tagscalar:Uint32
TagRANGE: [0, 4294967295]
unnumChildIntfstring:Basic
Un-numbered child interfaceA sequence of characters
unnumIntfstring:Basic
Unnumbered IP InterfaceA sequence of characters
urpfModestring:Basic
Unicast reverse path forwarding modeA sequence of characters
vaddrClientstring:Basic
Virtual address clientA sequence of characters
vaddrMasklenstring:Basic
Virtual address masklenA sequence of characters
vaddrPrefixstring:Basic
Virtual address prefixA sequence of characters
vaddrSubnetstring:Basic
Virtual address subnetA sequence of characters
vrfNameOutstring:Basic
Vrf Name OutA sequence of characters


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

Next