Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring Shutdown as the Module Action on Failure

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/lcm.json
{
  "lcmEntity": {
    "children": [
      {
        "lcmSysMod": {
          "attributes": {
            "moduleFailureAction": "shutdown"
}}}]}}
```0
```[DME]json-Response
{
    imdata:[]
}

Copy
<System>
  <lcm-items>
    <sysmod-items>
      <moduleFailureAction>shutdown</moduleFailureAction>
    </sysmod-items>
  </lcm-items>
</System>

Configuring a System Module Action

Configuring Shutdown as the Module Action on Failure

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 top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

system module failure-action shutdown

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.

MO	DN
lcmEntity	sys/lcm
lcmSysMod	sys/lcm/sysmod

lcmSysMod Properties

The following table contains information about the lcmSysMod 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 Name	Data Type	Description	Values
moduleFailureAction	lcm:ModuleFailureAction (scalar:Enum8)	Configure module action on failure	SELECTION: 0 - no 1 - shutdown DEFAULT: no

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 payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

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

Deleting Shutdown as the Module Action on Failure

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

CLI Commands

no system module failure-action shutdown

Verifying a DME Configuration

MO	DN
lcmEntity	sys/lcm
lcmSysMod	sys/lcm/sysmod

lcmSysMod Properties

Property Name	Data Type	Description	Values
moduleFailureAction	lcm:ModuleFailureAction (scalar:Enum8)	Configure module action on failure	SELECTION: 0 - no 1 - shutdown DEFAULT: no

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 payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

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

Configuring Emon Enhanced Support

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

CLI Commands

system module emon-enhanced

Verifying a DME Configuration

MO	DN
lcmEntity	sys/lcm
lcmSysMod	sys/lcm/sysmod

lcmSysMod Properties

Property Name	Data Type	Description	Values
moduleEmonEnhanced	lcm:ModuleEmonEnhanced (scalar:Enum8)	Configure module emon enhanced status	SELECTION: 0 - disable 1 - enable DEFAULT: enable

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

Deleting Emon Enhanced Support

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

CLI Commands

no system module emon-enhanced

Verifying a DME Configuration

MO	DN
lcmEntity	sys/lcm
lcmSysMod	sys/lcm/sysmod

lcmSysMod Properties

Property Name	Data Type	Description	Values
moduleEmonEnhanced	lcm:ModuleEmonEnhanced (scalar:Enum8)	Configure module emon enhanced status	SELECTION: 0 - disable 1 - enable DEFAULT: enable

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

Configuring Emon Enhanced Slow Timeout

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

CLI Commands

system module emon-enhanced slow-timeout

Verifying a DME Configuration

MO	DN
lcmEntity	sys/lcm
lcmSysMod	sys/lcm/sysmod

lcmSysMod Properties

Property Name	Data Type	Description	Values
moduleEmonEnhanced	lcm:ModuleEmonEnhanced (scalar:Enum8)	Configure module emon enhanced status	SELECTION: 0 - disable 1 - enable DEFAULT: enable

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

Configuring an Ethernet Port

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

CLI Commands

slot 1
port 61 type ethernet

Verifying a DME Configuration

MO	DN
lcmSlotCfgEntity	sys/lcm/slotcfg
lcmSlotInst	sys/lcm/slotcfg/slot-1
lcmPortCfg	sys/lcm/slotcfg/slot-1/portcfg

lcmSlotInst Properties

The following table contains information about the lcmSlotInst 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 Name	Data Type	Description	Values
id	lcm:moduleNumber (scalar:Uint16)	Module identifier for Slot property	RANGE: [1 , 32] DEFAULT: 1

lcmPortCfg Properties

The following table contains information about the lcmPortCfg 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 Name	Data Type	Description	Values
portRange	lcm:PortRange (string:Basic)	port range to config port type	A sequence of characters DEFAULT: 1-54
portType	lcm:PortType (scalar:Enum8)	port type to config [ethernet/fc\]	SELECTION: 1 - fc 2 - ethernet DEFAULT: ethernet

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

Deleting an Ethernet Port

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

CLI Commands

slot 1
no port 61 type ethernet

Verifying a DME Configuration

MO	DN
lcmSlotCfgEntity	sys/lcm/slotcfg
lcmSlotInst	sys/lcm/slotcfg/slot-1
lcmPortCfg	sys/lcm/slotcfg/slot-1/portcfg

lcmSlotInst Properties

Property Name	Data Type	Description	Values
id	lcm:moduleNumber (scalar:Uint16)	Module identifier for Slot property	RANGE: [1 , 32] DEFAULT: 1

lcmPortCfg Properties

Property Name	Data Type	Description	Values
portRange	lcm:PortRange (string:Basic)	port range to config port type	A sequence of characters DEFAULT: 1-54
portType	lcm:PortType (scalar:Enum8)	port type to config [ethernet/fc\]	SELECTION: 1 - fc 2 - ethernet DEFAULT: ethernet

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

Configuring an FC Port

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

CLI Commands

slot 1
port 61 type fc

Verifying a DME Configuration

MO	DN
lcmSlotCfgEntity	sys/lcm/slotcfg
lcmSlotInst	sys/lcm/slotcfg/slot-1
lcmPortCfg	sys/lcm/slotcfg/slot-1/portcfg

lcmSlotInst Properties

Property Name	Data Type	Description	Values
id	lcm:moduleNumber (scalar:Uint16)	Module identifier for Slot property	RANGE: [1 , 32] DEFAULT: 1

lcmPortCfg Properties

Property Name	Data Type	Description	Values
portRange	lcm:PortRange (string:Basic)	port range to config port type	A sequence of characters DEFAULT: 1-54
portType	lcm:PortType (scalar:Enum8)	port type to config [ethernet/fc\]	SELECTION: 1 - fc 2 - ethernet DEFAULT: ethernet

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

Deleting and FC Port

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

CLI Commands

slot 1
no port 61 type fc

Verifying a DME Configuration

MO	DN
lcmSlotCfgEntity	sys/lcm/slotcfg
lcmSlotInst	sys/lcm/slotcfg/slot-1
lcmPortCfg	sys/lcm/slotcfg/slot-1/portcfg

lcmSlotInst Properties

Property Name	Data Type	Description	Values
id	lcm:moduleNumber (scalar:Uint16)	Module identifier for Slot property	RANGE: [1 , 32] DEFAULT: 1

lcmPortCfg Properties

Property Name	Data Type	Description	Values
portRange	lcm:PortRange (string:Basic)	port range to config port type	A sequence of characters DEFAULT: 1-54
portType	lcm:PortType (scalar:Enum8)	port type to config [ethernet/fc\]	SELECTION: 1 - fc 2 - ethernet DEFAULT: ethernet

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