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:
Configuring to Always Use Custom Profile when Entering Maintenance Mode
Configuring to Always Use Custom Profile when Entering Maintenance Mode
POST http://<mgmt0_IP>/api/mo/sys/mmode.json
{
"mmodeEntity": {
"children": [
{
"mmodeInst": {
"attributes": {
"useCustomProfile": "yes"
}}}]}}
{
imdata:[]
}
<System>
<mmode-items>
<inst-items>
<useCustomProfile>true</useCustomProfile>
</inst-items>
</mmode-items>
</System>
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:
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:
Deleting to Always Use Custom Profile when Entering Maintenance Mode
Deleting to Always Use Custom Profile when Entering Maintenance Mode
POST http://<mgmt0_IP>/api/mo/sys/mmode.json
{
"mmodeEntity": {
"children": [
{
"mmodeInst": {
"attributes": {
"useCustomProfile": "no"
}}}]}}
{
imdata:[]
}
<System>
<mmode-items>
<inst-items>
<useCustomProfile>false</useCustomProfile>
</inst-items>
</mmode-items>
</System>
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.
no 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:
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:
Configuring a Delay to Allow Protocol Reroute Before Releasing CLI
Configuring a Delay to Allow Protocol Reroute Before Releasing CLI
POST http://<mgmt0_IP>/api/mo/sys/mmode.json
{
"mmodeEntity": {
"children": [
{
"mmodeInst": {
"attributes": {
"maintDelay": "300"
}}}]}}
{
imdata:[]
}
<System>
<mmode-items>
<inst-items>
<maintDelay>300</maintDelay>
</inst-items>
</mmode-items>
</System>
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 maint-delay 300
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 |
---|---|---|---|
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:
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:
Deleting a Delay to Allow Protocol Reroute Before Releasing CLI
Deleting a Delay to Allow Protocol Reroute Before Releasing CLI
POST http://<mgmt0_IP>/api/mo/sys/mmode.json
{
"mmodeEntity": {
"children": [
{
"mmodeInst": {
"attributes": {
"maintDelay": "120"
}}}]}}
{
imdata:[]
}
<System>
<mmode-items>
<inst-items>
<maintDelay>120</maintDelay>
</inst-items>
</mmode-items>
</System>
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.
no system mode maintenance maint-delay 300
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 |
---|---|---|---|
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:
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:
Configuring the Reset Reason
Configuring the Reset Reason
POST http://<mgmt0_IP>/api/mo/sys/mmode.json
{
"mmodeEntity": {
"children": [
{
"mmodeInst": {
"attributes": {
"onReloadResetReasonManualReload": "yes"
}}}]}}
{
imdata:[]
}
<System>
<mmode-items>
<inst-items>
<onReloadResetReasonManualReload>true</onReloadResetReasonManualReload>
</inst-items>
</mmode-items>
</System>
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 on-reload reset-reason MANUAL_RELOAD
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 |
---|---|---|---|
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:
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:
Deleting the Reset Reason
Deleting the Reset Reason
POST http://<mgmt0_IP>/api/mo/sys/mmode.json
{
"mmodeEntity": {
"children": [
{
"mmodeInst": {
"attributes": {
"onReloadResetReasonManualReload": "no"
}}}]}}
{
imdata:[]
}
<System>
<mmode-items>
<inst-items>
<onReloadResetReasonManualReload>false</onReloadResetReasonManualReload>
</inst-items>
</mmode-items>
</System>
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.
no system mode maintenance on-reload reset-reason MANUAL_RELOAD
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 |
---|---|---|---|
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:
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:
Configuring the Delay After Which the After_Maintenance Snapshot will Be Taken
Configuring the Delay After Which the After_Maintenance Snapshot will Be Taken
POST http://<mgmt0_IP>/api/mo/sys/mmode.json
{
"mmodeEntity": {
"children": [
{
"mmodeInst": {
"attributes": {
"snapshotDelay": "600"
}}}]}}
{
imdata:[]
}
<System>
<mmode-items>
<inst-items>
<snapshotDelay>600</snapshotDelay>
</inst-items>
</mmode-items>
</System>
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 snapshot-delay 600
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 |
---|---|---|---|
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:
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:
Deleting the Delay After Which the After_Maintenance Snapshot will Be Taken
Deleting the Delay After Which the After_Maintenance Snapshot will Be Taken
POST http://<mgmt0_IP>/api/mo/sys/mmode.json
{
"mmodeEntity": {
"children": [
{
"mmodeInst": {
"attributes": {
"snapshotDelay": "120"
}}}]}}
{
imdata:[]
}
<System>
<mmode-items>
<inst-items>
<snapshotDelay>120</snapshotDelay>
</inst-items>
</mmode-items>
</System>
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.
no system mode maintenance snapshot-delay 600
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 |
---|---|---|---|
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:
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:
Restarting Maintenance Mode Timer with a New Value
Restarting Maintenance Mode Timer with a New Value
POST http://<mgmt0_IP>/api/mo/sys/mmode.json
{
"mmodeEntity": {
"children": [
{
"mmodeInst": {
"attributes": {
"timeout": "24082"
}}}]}}
{
imdata:[]
}
<System>
<mmode-items>
<inst-items>
<timeout>24082</timeout>
</inst-items>
</mmode-items>
</System>
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 timeout 24082
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 |
---|---|---|---|
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:
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:
Deleting a Configured Maintenance Mode Timer Restart
Deleting a Configured Maintenance Mode Timer Restart
POST http://<mgmt0_IP>/api/mo/sys/mmode.json
{
"mmodeEntity": {
"children": [
{
"mmodeInst": {
"attributes": {
"timeout": "65535"
}}}]}}
{
imdata:[]
}
<System>
<mmode-items>
<inst-items>
<timeout>65535</timeout>
</inst-items>
</mmode-items>
</System>
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.
no system mode maintenance timeout 24082
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 |
---|---|---|---|
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:
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:
Configuring Shutdown on Failure
Configuring Shutdown on Failure
POST http://<mgmt0_IP>/api/mo/sys/lcm.json
{
"lcmEntity": {
"children": [
{
"lcmSysMod": {
"attributes": {
"moduleFailureAction": "shutdown"
}}}]}}
{
imdata:[]
}
<System>
<lcm-items>
<sysmod-items>
<moduleFailureAction>shutdown</moduleFailureAction>
</sysmod-items>
</lcm-items>
</System>
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:
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:
Deleting Shutdown on Failure
Deleting Shutdown on Failure
POST http://<mgmt0_IP>/api/mo/sys/lcm.json
{
"lcmEntity": {
"children": [
{
"lcmSysMod": {
"attributes": {
"moduleFailureAction": "no"
}}}]}}
{
imdata:[]
}
<System>
<lcm-items>
<sysmod-items>
<moduleFailureAction>no</moduleFailureAction>
</sysmod-items>
</lcm-items>
</System>
Example: <description>
POST http://<mgmt0_IP>/api/mo/sys/lcm.json
{
"lcmEntity": {
"attributes": {
"dn": "sys/lcm",
},
"children": [
{
"lcmSysMod": {
"attributes": {
"dn": "sys/lcm/sysmod",
"moduleFailureAction": "no",
}}}]}}
{
imdata:[]
}
<System>
<lcm-items>
<sysmod-items>
<moduleFailureAction>no</moduleFailureAction>
</sysmod-items>
</lcm-items>
</System>
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.
no 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:
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: