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

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring to Always Use Custom Profile when Entering Maintenance Mode

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/mmode.json
{
  "mmodeEntity": {
    "children": [
      {
        "mmodeInst": {
          "attributes": {
            "useCustomProfile": "yes"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <mmode-items>
    <inst-items>
      <useCustomProfile>true</useCustomProfile>
    </inst-items>
  </mmode-items>
</System>

Configuring Maintenance Mode

When you place the switch in maintenance mode, all configured Layer 3 control-plane protocols are isolated from the network. Directly connected routes are not withdrawn or modified during this state. When normal mode is restored, the advertisement of all routes is restored.

For more information, see the Cisco Nexus 9000 Series NX-OS System Management Configuration Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-installation-and-configuration-guides-list.html/

Configuring to Always Use Custom Profile when Entering Maintenance Mode

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 mode maintenance always-use-custom-profile

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
mmodeEntity	sys/mmode
mmodeInst	sys/mmode/inst

mmodeInst Properties

The following table contains information about the mmodeInst 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
useCustomProfile	scalar:Bool	Use Custom Profile	SELECTION: true or false

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 to Always Use Custom Profile when Entering Maintenance Mode

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

CLI Commands

no system mode maintenance always-use-custom-profile

Verifying a DME Configuration

MO	DN
mmodeEntity	sys/mmode
mmodeInst	sys/mmode/inst

mmodeInst Properties

Property Name	Data Type	Description	Values
useCustomProfile	scalar:Bool	Use Custom Profile	SELECTION: true or false

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 a Delay to Allow Protocol Reroute Before Releasing CLI

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

CLI Commands

system mode maintenance maint-delay 300

Verifying a DME Configuration

MO	DN
mmodeEntity	sys/mmode
mmodeInst	sys/mmode/inst

mmodeInst Properties

Property Name	Data Type	Description	Values
maintDelay	scalar:Uint16	Maintenance Delay Time	RANGE: [0, 65535] DEFAULT: 120

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 a Delay to Allow Protocol Reroute Before Releasing CLI

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

CLI Commands

no system mode maintenance maint-delay 300

Verifying a DME Configuration

MO	DN
mmodeEntity	sys/mmode
mmodeInst	sys/mmode/inst

mmodeInst Properties

Property Name	Data Type	Description	Values
maintDelay	scalar:Uint16	Maintenance Delay Time	RANGE: [0, 65535] DEFAULT: 120

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 the Reset Reason

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

CLI Commands

system mode maintenance on-reload reset-reason MANUAL_RELOAD

Verifying a DME Configuration

MO	DN
mmodeEntity	sys/mmode
mmodeInst	sys/mmode/inst

mmodeInst Properties

Property Name	Data Type	Description	Values
onReloadResetReasonManualReload	scalar:Bool	On-Reload Reset-Reason Manual Reload	SELECTION: true or false

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 the Reset Reason

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

CLI Commands

no system mode maintenance on-reload reset-reason MANUAL_RELOAD

Verifying a DME Configuration

MO	DN
mmodeEntity	sys/mmode
mmodeInst	sys/mmode/inst

mmodeInst Properties

Property Name	Data Type	Description	Values
onReloadResetReasonManualReload	scalar:Bool	On-Reload Reset-Reason Manual Reload	SELECTION: true or false

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 the Delay After Which the After_Maintenance Snapshot will Be Taken

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

CLI Commands

system mode maintenance snapshot-delay 600

Verifying a DME Configuration

MO	DN
mmodeEntity	sys/mmode
mmodeInst	sys/mmode/inst

mmodeInst Properties

Property Name	Data Type	Description	Values
snapshotDelay	scalar:Uint16	Snapshot Delay Time	RANGE: [0, 65535] DEFAULT: 120

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 the Delay After Which the After_Maintenance Snapshot will Be Taken

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

CLI Commands

no system mode maintenance snapshot-delay 600

Verifying a DME Configuration

MO	DN
mmodeEntity	sys/mmode
mmodeInst	sys/mmode/inst

mmodeInst Properties

Property Name	Data Type	Description	Values
snapshotDelay	scalar:Uint16	Snapshot Delay Time	RANGE: [0, 65535] DEFAULT: 120

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

Restarting Maintenance Mode Timer with a New Value

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

CLI Commands

system mode maintenance timeout 24082

Verifying a DME Configuration

MO	DN
mmodeEntity	sys/mmode
mmodeInst	sys/mmode/inst

mmodeInst Properties

Property Name	Data Type	Description	Values
timeout	mmode:TimeoutInterval (scalar:Uint16)	Timeout	RANGE: [5 , 65535] DEFAULT: 65535

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 a Configured Maintenance Mode Timer Restart

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

CLI Commands

no system mode maintenance timeout 24082

Verifying a DME Configuration

MO	DN
mmodeEntity	sys/mmode
mmodeInst	sys/mmode/inst

mmodeInst Properties

Property Name	Data Type	Description	Values
timeout	mmode:TimeoutInterval (scalar:Uint16)	Timeout	RANGE: [5 , 65535] DEFAULT: 65535

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 Shutdown on Failure

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

CLI Commands

system module failure-action shutdown

Verifying a DME Configuration

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

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 Shutdown 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

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