Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Loading...
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 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

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


fmEntity Properties

The following table contains information about the fmEntity 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
dn
reference:BinRef		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
persistentOnReload
mo:Persistent
scalar:Enum8		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)


    • fmPim Properties

    The following table contains information about the fmPim 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
    adminStfm:AdminState
    (scalar:Enum8)    		Admin statusSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


    fmDhcp Properties

    The following table contains information about the fmDhcp 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
    adminStfm:AdminState
    (scalar:Enum8)    		Admin statusSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


    fmNtpd Properties

    The following table contains information about the fmNtpd 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
    adminStfm:AdminState
    (scalar:Enum8)    		Admin statusSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


    fmTelemetry Properties

    The following table contains information about the fmTelemetry 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
    adminStfm:AdminState
    (scalar:Enum8)    		Admin statusSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


    fmBashShell Properties

    The following table contains information about the fmBashShell 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
    adminStfm:AdminState
    (scalar:Enum8)    		Admin statusSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


    fmOspf Properties

    The following table contains information about the fmOspf 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
    adminStfm:AdminState
    (scalar:Enum8)    		Admin statusSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


    fmLacp Properties

    The following table contains information about the fmLacp 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
    adminStfm:AdminState
    (scalar:Enum8)    		Admin statusSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


    fmNxapi Properties

    The following table contains information about the fmNxapi 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
    adminStfm:AdminState
    (scalar:Enum8)    		Admin statusSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


    fmTelnet Properties

    The following table contains information about the fmTelnet 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
    adminStfm:AdminState
    (scalar:Enum8)    		Admin statusSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


    fmTacacsplus Properties

    The following table contains information about the fmTacacsplus 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
    adminStfm:AdminState
    (scalar:Enum8)    		Admin statusSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


    fmUdld Properties

    The following table contains information about the fmUdld 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
    adminStfm:AdminState
    (scalar:Enum8)    		Admin statusSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


    fmVrrp Properties

    The following table contains information about the fmVrrp 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
    adminStfm:AdminState
    (scalar:Enum8)    		Admin statusSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


    fmMplsSgmntRtg Properties

    The following table contains information about the fmMplsSgmntRtg 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
    adminStfm:AdminState
    (scalar:Enum8)    		Admin statusSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


    fmNgmvpn Properties

    The following table contains information about the fmNgmvpn 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
    adminStfm:AdminState
    (scalar:Enum8)    		Admin statusSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


    fmBfd Properties

    The following table contains information about the fmBfd 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
    adminStfm:AdminState
    (scalar:Enum8)    		Admin statusSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


    fmBgp Properties

    The following table contains information about the fmBgp 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
    adminStfm:AdminState
    (scalar:Enum8)    		Admin statusSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


    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