Cisco Nexus 3000 and 9000 Series NX-API REST SDK and API, Release 7.x
NX-OS 7(x)
Querying Feature Status
DME
YANG
Copy
GET http://<IP_Address>/api/mo/sys/fm.json?rsp-subtree=full&rsp-prop-include=config-only

Response
{
"totalCount": "1",
"imdata": [
{
    "fmEntity": {
        "attributes": {
            "dn": "sys/fm",
            "persistentOnReload": "true"
},
"children": [
    {
        "fmPim": {
            "attributes": {
                "adminSt": "enabled",
                "persistentOnReload": "true",
                "rn": "pim"
}}},{
"fmDhcp": {
    "attributes": {
        "adminSt": "enabled",
        "persistentOnReload": "true",
        "rn": "dhcp"
}}},{
"fmNtpd": {
    "attributes": {
        "adminSt": "enabled",
        "persistentOnReload": "true",
        "rn": "ntpd"
}}},{
"fmTelemetry": {
    "attributes": {
        "adminSt": "enabled",
        "persistentOnReload": "true",
        "rn": "telemetry"
}}},{
"fmBashShell": {
    "attributes": {
        "adminSt": "enabled",
        "persistentOnReload": "true",
        "rn": "bashshell"
}}},{
"fmOspf": {
    "attributes": {
        "adminSt": "enabled",
        "persistentOnReload": "true",
        "rn": "ospf"
}}},{
"fmLacp": {
    "attributes": {
        "adminSt": "enabled",
        "persistentOnReload": "true",
        "rn": "lacp"
}}},{
"fmNxapi": {
    "attributes": {
        "adminSt": "enabled",
        "persistentOnReload": "true",
        "rn": "nxapi"
}}},{
"fmTelnet": {
    "attributes": {
        "adminSt": "enabled",
        "persistentOnReload": "true",
        "rn": "telnet"
}}},{
"fmTacacsplus": {
    "attributes": {
        "adminSt": "enabled",
        "persistentOnReload": "true",
        "rn": "tacacsplus"
}}},{
"fmUdld": {
    "attributes": {
        "adminSt": "enabled",
        "persistentOnReload": "true",
        "rn": "udld"
}}},{
"fmVrrp": {
    "attributes": {
        "adminSt": "enabled",
        "persistentOnReload": "true",
        "rn": "vrrp"
}}},{
"fmMplsSgmntRtg": {
    "attributes": {
        "adminSt": "disabled",
        "persistentOnReload": "true",
        "rn": "mplssgmntrtg"
}}},{
"fmNgmvpn": {
    "attributes": {
        "adminSt": "enabled",
        "persistentOnReload": "true",
        "rn": "ngmvpn"
}}},{
"fmBfd": {
    "attributes": {
        "adminSt": "enabled",
        "persistentOnReload": "true",
        "rn": "bfd"
}}},{
"fmBgp": {
    "attributes": {
        "adminSt": "enabled",
        "persistentOnReload": "true",
        "rn": "bgp"
}}}]}}]}

Copy
GET http://<IP_Address>/restconf/data/Cisco-NX-OS-device:System/fm-items

Response
<fm-items>
    <bashshell-items>
        <adminSt>enabled</adminSt>
        <maxInstance>1</maxInstance>
        <operSt>enabled</operSt>
    </bashshell-items>
    <bgp-items>
        <adminSt>enabled</adminSt>
        <maxInstance>1</maxInstance>
        <operSt>enabled</operSt>
    </bgp-items>
    <dhcp-items>
        <adminSt>enabled</adminSt>
        <maxInstance>1</maxInstance>
        <operSt>enabled</operSt>
    </dhcp-items>
    <evpn-items>
        <adminSt>enabled</adminSt>
        <maxInstance>1</maxInstance>
        <operSt>enabled</operSt>
    </evpn-items>
    <hmm-items>
        <adminSt>enabled</adminSt>
        <maxInstance>1</maxInstance>
        <operSt>enabled</operSt>
    </hmm-items>
    <mplssgmntrtg-items>
        <adminSt>disabled</adminSt>
        <conflictingFeature/>
        <maxInstance>1</maxInstance>
        <operSt>disabled</operSt>
    </mplssgmntrtg-items>
    <ngmvpn-items>
        <adminSt>enabled</adminSt>
        <maxInstance>1</maxInstance>
        <operSt>disabled</operSt>
    </ngmvpn-items>
    <ntpd-items>
        <adminSt>disabled</adminSt>
        <maxInstance>1</maxInstance>
        <operSt>disabled</operSt>
    </ntpd-items>
    <nvo-items>
        <adminSt>enabled</adminSt>
        <maxInstance>1</maxInstance>
        <operSt>enabled</operSt>
    </nvo-items>
    <nxapi-items>
        <adminSt>enabled</adminSt>
        <maxInstance>1</maxInstance>
        <operSt>enabled</operSt>
    </nxapi-items>
    <ospf-items>
        <adminSt>enabled</adminSt>
        <maxInstance>16</maxInstance>
        <operSt>enabled</operSt>
    </ospf-items>
    <pim-items>
        <adminSt>enabled</adminSt>
        <maxInstance>1</maxInstance>
        <operSt>enabled</operSt>
    </pim-items>
    <tacacsplus-items>
        <adminSt>enabled</adminSt>
        <maxInstance>1</maxInstance>
        <operSt>enabled</operSt>
    </tacacsplus-items>
    <telemetry-items>
        <adminSt>enabled</adminSt>
        <maxInstance>1</maxInstance>
        <operSt>enabled</operSt>
    </telemetry-items>
    <telnet-items>
        <adminSt>enabled</adminSt>
        <maxInstance>1</maxInstance>
        <operSt>enabled</operSt>
    </telnet-items>
    <udld-items>
        <adminSt>enabled</adminSt>
        <maxInstance>1</maxInstance>
        <operSt>enabled</operSt>
    </udld-items>
    <vnsegment-items>
        <adminSt>enabled</adminSt>
        <maxInstance>1</maxInstance>
        <operSt>enabled</operSt>
    </vnsegment-items>
    <vpc-items>
        <adminSt>enabled</adminSt>
        <maxInstance>1</maxInstance>
        <operSt>enabled</operSt>
    </vpc-items>
    <vrrpv3-items>
        <adminSt>enabled</adminSt>
        <maxInstance>1</maxInstance>
        <operSt>enabled</operSt>
    </vrrpv3-items>
</fm-items>

Querying Configurations (Show Commands)

Querying Feature Status

Querying Feature Status

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

CLI Output
 switch# show feature
 Feature   Name            Instance    State
 --------------------    --------    --------
 bash-shell               1            enabled
 bfd                      1            disabled
 bgp                      1            enabled
 bulkstat                 1            disabled
 cable-management         1            disabled
 catena                   1            disabled
 container-tracker        1            disabled
 macsec                   1            disabled
 dhcp                     1            enabled
 dot1x                    1            disabled
 eigrp                    1            disabled
 eigrp                    2            disabled
 eigrp                    3            disabled
 eigrp                    4            disabled
 eigrp                    5            disabled
 eigrp                    6            disabled
 eigrp                    7            disabled
 eigrp                    8            disabled
 eigrp                    9            disabled
 eigrp                    10           disabled
 eigrp                    11           disabled
 eigrp                    12           disabled
 eigrp                    13           disabled
 eigrp                    14           disabled
 eigrp                    15           disabled
 eigrp                    16           disabled
 eth-port-sec             1            disabled
 evb                      1            disabled
 evc                      1            disabled
 evmed                    1            disabled
 fabric-access            1            disabled
 fabric_mcast             1            disabled
 hmm                      1            enabled
 hsrp_engine              1            disabled
 icam                     1            disabled
 imp                      1            disabled
 interface-vlan           1            disabled
 isis                     1            disabled
 isis                     2            disabled
 isis                     3            disabled
 isis                     4            disabled
 isis                     5            disabled
 isis                     6            disabled
 isis                     7            disabled
 isis                     8            disabled
 isis                     9            disabled
 isis                     10           disabled
 isis                     11           disabled
 isis                     12           disabled
 isis                     13           disabled
 isis                     14           disabled
 isis                     15           disabled
 isis                     16           disabled
 itd                      1            disabled
 l2vpn                    1            disabled
 lacp                     1            disabled
 ldap                     1            disabled
 ldp                      1            disabled
 lldp                     1            disabled
 mpls-evpn                1            disabled
 mpls_oam                 1            disabled
 mpls_static              1            disabled
 msdp                     1            disabled
 mvrp                     1            disabled
 nat                      1            disabled
 nbm                      1            disabled
 ngmvpn                   1            enabled
 ngoam                    1            disabled
 npiv                     1            disabled
 nve                      1            enabled
 nxapi                    1            enabled
 nxsdk_app1               1            disabled
 nxsdk_app10              1            disabled
 nxsdk_app11              1            disabled
 nxsdk_app12              1            disabled
 nxsdk_app13              1            disabled
 nxsdk_app14              1            disabled
 nxsdk_app15              1            disabled
 nxsdk_app16              1            disabled
 nxsdk_app17              1            disabled
 nxsdk_app18              1            disabled
 nxsdk_app19              1            disabled
 nxsdk_app2               1            disabled
 nxsdk_app20              1            disabled
 nxsdk_app21              1            disabled
 nxsdk_app22              1            disabled
 nxsdk_app23              1            disabled
 nxsdk_app24              1            disabled
 nxsdk_app25              1            disabled
 nxsdk_app26              1            disabled
 nxsdk_app27              1            disabled
 nxsdk_app28              1            disabled
 nxsdk_app29              1            disabled
 nxsdk_app3               1            disabled
 nxsdk_app30              1            disabled
 nxsdk_app31              1            disabled
 nxsdk_app32              1            disabled
 nxsdk_app4               1            disabled
 nxsdk_app5               1            disabled
 nxsdk_app6               1            disabled
 nxsdk_app7               1            disabled
 nxsdk_app8               1            disabled
 nxsdk_app9               1            disabled
 nxsdk_mgr                1            disabled
 onep                     1            disabled
 openflow                 1            disabled
 ospf                     1            enabled(not-running)
 ospf                     2            enabled(not-running)
 ospf                     3            enabled(not-running)
 ospf                     4            enabled(not-running)
 ospf                     5            enabled(not-running)
 ospf                     6            enabled(not-running)
 ospf                     7            enabled(not-running)
 ospf                     8            enabled(not-running)
 ospf                     9            enabled(not-running)
 ospf                     10           enabled(not-running)
 ospf                     11           enabled(not-running)
 ospf                     12           enabled(not-running)
 ospf                     13           enabled(not-running)
 ospf                     14           enabled(not-running)
 ospf                     15           enabled(not-running)
 ospf                     16           enabled(not-running)
 ospfv3                   1            disabled
 ospfv3                   2            disabled
 ospfv3                   3            disabled
 ospfv3                   4            disabled
 ospfv3                   5            disabled
 ospfv3                   6            disabled
 ospfv3                   7            disabled
 ospfv3                   8            disabled
 ospfv3                   9            disabled
 ospfv3                   10           disabled
 ospfv3                   11           disabled
 ospfv3                   12           disabled
 ospfv3                   13           disabled
 ospfv3                   14           disabled
 ospfv3                   15           disabled
 ospfv3                   16           disabled
 pbr                      1            disabled
 pim                      1            enabled
 pim6                     1            disabled
 plb                      1            disabled
 poe                      1            disabled
 private-vlan             1            disabled
 privilege                1            disabled
 ptp                      1            disabled
 rip                      1            disabled
 rip                      2            disabled
 rip                      3            disabled
 rip                      4            disabled
 rise                     1            disabled
 scheduler                1            disabled
 scpServer                1            disabled
 segment-routing          1            disabled
 sflow                    1            disabled
 sftpServer               1            disabled
 sla_responder            1            disabled
 sla_sender               1            disabled
 smart-channel            1            disabled
 sshServer                1            enabled
 tacacs                   1            enabled
 telemetry                1            enabled
 telnetServer             1            disabled
 tunnel                   1            disabled
 udld                     1            enabled
 vmtracker                1            disabled
 vni                      1            disabled
 vnseg_vlan               1            enabled
 vpc                      1            enabled
 vrrp                     1            disabled
 vrrpv3                   1            enabled
 vtp                      1            disabled

Querying IP IGMP Groups

Querying the Current MOTD Banner Message

Querying the Current MOTD Banner Message

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

CLI Output
switch(config)# show banner motd
Testing Banner 123

Querying an OSPFv2 Instance

Querying an OSPFv2 Instance

Displays OSPF information.


CLI Command

The CLI command below is the equivalent to the payload example displayed in the pane on the right.

show ip ospf my_ospf

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 OSPF Neighbors

Querying OSPF Neighbors

Displays OSPF information.


CLI Command

The CLI command below is the equivalent to the payload example displayed in the pane on the right.

show ip ospf my_ospf

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 VRF Information

Querying VRF Information

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

CLI Output
switch(config)# show ip ospf neighbor vrf all
OSPF Process ID 100 VRF default
Total number of neighbors: 2
Neighbor IDPri StateUp TimeAddressInterface
7.7.7.71 FULL/DR20:37:56 17.17.17.7Eth1/49
8.8.8.81 FULL/DR20:37:56 60.60.60.2Eth1/50

Querying IP OSPF Neighbor Details

You need to make two DME requests to view the same information found in the show ip ospf neighbors output. One request for the neighbor-related statistics (ospfAdjStats) and the other for dynamically learned endpoints (ospfAdjEp).

Querying IP OSPF Neighbor Details (DME Request 1)

Querying IP OSPF Neighbor Details (DME Request 1)

This DME request displays the dynamically learned endpoints for a neighbor.

Querying IP OSPF Neighbor Details (DME Request 2)

Querying IP OSPF Neighbor Details (DME Request 2)

This DME request displays the neighbor-related statistics (ospfAdjStats).

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

CLI Output
switch# show ip ospf neighbors
OSPF Process ID 1 VRF default
Total number of neighbors: 1
Neighbor IDPri StateUp TimeAddressInterface
2.2.2.21 FULL/BDR00:00:16    12.2.1.2Eth1/38
CLI Output
switch# show ip ospf neighbors 2.2.2.2 detail
Neighbor 2.2.2.2, interface address 12.2.1.2
Process ID 1 VRF default in area 0.0.0.0 via interface Ethernet1/38
State is FULL, 5 state changes, last change 00:58:08
Neighbor priority is 1
DR is 12.2.1.1 BDR is 12.2.1.2
Hello options 0x2,dbd options 0x42
Last non-hello packet received 00:27:48
Dead timer due in 00:00:40

Querying a Pattern to Match (AAA|TACACS|RADIUS)

Querying a Pattern to Match (AAA|TACACS|RADIUS)

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

CLI Output
switch# show running | section aaa|tacacs|radius

feature tacacs+
aaa authentication login console group radius

Querying a Pattern to Match ("name-server|domain-lookup|host")

Querying a Pattern to Match ("name-server|domain-lookup|host")

The DME URL lists all the DNS related configurations. There is no single URL to retrieve only "name-server|domain-lookup|host."

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

CLI Output
switch# show running | incl name-server|domain-lookup|host
ip domain-lookup
ip name-server 1.2.3.4 2.4.6.8
ip host Host_1 1.2.3.4
ipv6 host Host_1 1:2::34

Querying a Pattern to Match (RMON)

Querying a Pattern to Match (RMON)

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

CLI Output
switch# show running | section rmon
rmon event 1 log trap public description FATAL(1) owner PMON@FATAL
rmon event 2 log trap public description CRITICAL(2) owner PMON@CRITICAL
rmon event 3 log trap public description ERROR(3) owner PMON@ERROR
rmon event 4 log trap public description WARNING(4) owner PMON@WARNING
rmon event 5 log trap public description INFORMATION(5) owner PMON@INFO

Querying a Pattern to Match (VRF)

Querying a Pattern to Match (VRF)

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

CLI Output
 switch# show running | section vrf
  limit-resource vrf minimum 2 maximum 4096
   use-vrf test_vrf
 vrf context VRF_1
  address-family ipv4 unicast
   route-target import 1:2 mvpn
   route-target export 1:2
   export map map1
   import map map1
   export vrf default map map1
 vrf context VRF_2
  rd 1:2
  address-family ipv4 unicast
   export map map1
   export vrf default map map1 allow-vpn
 vrf context foo
  address-family ipv4 unicast
   export vrf default map map1 allow-vpn
 vrf context management
  ip route 0.0.0.0/0 172.27.122.1
 vrf context switchpool-default
 vrf context test1
  address-family ipv4 unicast
   route-target import 1:2 mvpn
 vrf context v1
  address-family ipv4 unicast
   route-target import 1:2 mvpn
  vrf member management
   vrf VRF_2
   router-id 3.6.9.12

Querying PIM Interface Information

Querying PIM Interface Information

DME Requests

A DME GET request is individually sent for each interface, as shown in the example. To view all PIM information in a single payload, send a DME GET request to http://<IP_Address>/api/mo/sys/pim.json?rsp-subtree=full

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

CLI Output
switch# show ip pim interface brief
PIM Interface Status for VRF "default"
Interface            IP Address      PIM DR Address  Neighbor  Border
                                                     Count     Interface
Ethernet1/49         30.30.30.1      30.30.30.2      1         no
loopback0            2.2.2.100       2.2.2.100       0         no
Querying PIM Neighbor Related Information

DME Requests

A DME GET request is individually sent for each interface, as shown in the example. To view all PIM information in a single payload, send a DME GET request to http://<IP_Address>/api/mo/sys/pim.json?rsp-subtree=full

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

CLI Output
switch# show ip pim neighbor
PIM Neighbor Status for VRF "default"
Neighbor        Interface            Uptime    Expires   DR            Bidir-   BFD    ECMP Redirect
                                                         Priority      Capable  State     Capable
30.30.30.2      Ethernet1/49         1d00h     00:01:36  1             yes      n/a     no

Querying PIM Neighbor Interface Information

Querying PIM Neighbor Interface Information
CLI Output
switch(config)# show ip pim neighbor ethernet 1/49
PIM Neighbor Status for VRF"default"
Neighbor        Interface            Uptime    Expires   DR        Bidir-    BFD    ECMP Redirect
                                                         Priority  Capable   State     Capable
30.30.30.2      Ethernet1/49         1d00h     00:01:36  1      yes      n/a          no

Querying VRF Information

Querying VRF Information

Note: The CLI output only covers a subset of the model output.

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

CLI Output
switch# show vrf all
VRF-Name                           VRF-ID State   Reason
VRF_1                                   3 Up      -- 
VRF_2                                   4 Up      --
default                                 1 Up      --
foo                                     5 Up      --
management                              2 Up      --
switchpool-default                      6 Up      --
test1                                   7 Up      --
v1                                      8 Up      --
CLI Output
switch(config)# show vrf interface

Interface                 VRF-Name                        VRF-ID  Site-of-Origin
loopback0                 default                              1  --
loopback1                 default                              1  --
loopback2                 default                              1  --
Null0                     default                              1  --
Ethernet1/1               default                              1  --
Ethernet1/2               default                              1  --
Ethernet1/6               default                              1  --
Ethernet1/7               default                              1  --
mgmt0                     management                           2  --

Querying VRRP Information

Querying VRRP Information

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

CLI Output
switch# show vrrp

     Interface  VR IpVersion Pri   Time Pre State   VR IP addr
---------------------------------------------------------------
   Ethernet1/7 123   IPV4    100    1 s  Y    Init    123.1.2.3
Next