Restrictions for Graceful Insertion and Removal
In Cisco IOS XE Everest 16.6.1, GIR is supported for layer two interface shutdown and ISIS routing protocol. This is configured either by creating customized templates or without a template.
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
In Cisco IOS XE Everest 16.6.1, GIR is supported for layer two interface shutdown and ISIS routing protocol. This is configured either by creating customized templates or without a template.
Graceful Insertion and Removal (GIR) isolates a switch from the network in order to perform debugging or an upgrade. When switch maintenance is complete, the switch will return to normal mode on either reaching the configured maintenance timeout, or by enabling the stop maintenance command.
A switch can be put into maintenance mode using default template or a custom template. The default template contains all the ISIS instances, along with shut down l2 . In the custom template, you can configure the required ISIS instances and shutdown l2 option. On entering maintenance mode, all participating protocols are isolated, and L2 ports are shut down. When normal mode is restored, all the protocols and L2 ports are brought back up.
Creating a maintenance mode template before you put the switch in maintenance mode is optional. The objective of maintenance mode for a device is to minimize traffic disruption at the time of removal from the network, as well as during the time of insertion. There are mainly three stages:
Graceful removal of the node from network.
Performing maintenance on the device.
Graceful insertion into the network.
Snapshots are taken automatically while entering and exiting the maintenance mode. You can use the snapshot create snapshot-name snapshot-description command to capture and store snapshots for pre-selected features. Snapshots are useful to compare the state of a switch before it went into maintenance mode and after it came back to normal mode. The snapshot process consists of three parts:
Creating a snapshot of the states of a few preselected features on the switch and storing them onthe persistent storage media.
Listing the snapshots taken at various time intervals and managing them.
Comparing snapshots and showing the summary and details of each feature.
The maximum number of snapshots that may be stored on the switch is 10. You can use the command snapshot delete snapshot-name to delete a specific snapshot from the device.
Layer 2 interfaces will be shut down when the system is transitioning into maintenance mode. Layer 2 interfaces are shut down using the shutdown l2 command in the custom template.
The network administrator can create a template that will be applied when the system goes into maintenance mode. This allows the administrator to isolate specific protocols. All instances that need to be isolated must be explicitly specified.
The admin can create multiple templates with different configurations. However, only a single template will be applied to the maintenance mode CLI. Once applied, the template cannot be updated. If the template needs to be updated, then you must remove it, make the changes, and then re-apply.
Command or Action | Purpose | |
---|---|---|
Step 1 |
enable Example:
|
Enables privileged EXEC mode. Enter your password if prompted. |
Step 2 |
configure terminal Example:
|
Enters the global configuration mode. |
Step 3 |
maintenance-template template_name Example:
|
Creates a template with the specified name. For example, see Examples: Creating customer profile. |
Step 4 |
router routing_protocol instance_id | shutdown l2 Example:
|
Creates instances that should be isolated under this template.
|
Command or Action | Purpose | |
---|---|---|
Step 1 |
enable Example:
|
Enables privileged EXEC mode. Enter your password if prompted. |
Step 2 |
configure terminal Example:
|
Enters the global configuration mode. |
Step 3 |
system mode maintenance Example:
|
Enters system mode maintenance configuration mode. Different sub commands to create maintenance mode parameters are configured in this mode. |
Step 4 |
timeout timeout-value | template template-name | failsafe failsafe-timeout-value | on-reload reset-reason MAINTENANCE |
Configures maintenance mode parameters.
|
Command or Action | Purpose | |
---|---|---|
Step 1 |
enable Example:
|
Enables privileged EXEC mode. Enter your password if prompted. |
Step 2 |
start maintenance Example:
|
Puts the system into maintenance mode. |
Step 3 |
stop maintenance Example:
|
Puts the system back into normal mode. |
The following examples show the sequence followed to enable GIR during a maintanence window.
This example shows how to configure a maintenance template t1 with an ISIS routing protocol instance.
Device# config terminal
Device (config)# maintenance-template t1
Device (config-maintenance-templ)# router isis 1
This example shows how to configure a maintenance template t1 with shutdown l2.
Device# config terminal
Device (config)# maintenance-template t1
Device (config-maintenance-templ)# shutdown l2
This example shows how to create maintenance template and configure the maintenance mode parameters.
Device# config terminal
Device(config)# system mode maintenance
Device(config-maintenance)#timeout 20
Device(config-maintenance)#failsafe 30
Device(config-maintenance)#on-reload reset-reason MAINTENANCE
Device(config-maintenance)#template t1
Device(config-maintenance)#exit
This example shows how to put the system into maintenance mode.
Device# start maintenance
After the activity is completed, the system can be put out of maintenance mode.
This example shows how to put the system out of maintenance mode.
Device# stop maintenance
This example shows how to display system mode settings using different options.
Device#show system mode
System Mode: Normal
Device#show system mode maintenance
System Mode: Normal
Current Maintenance Parameters:
Maintenance Duration: 15(mins)
Failsafe Timeout: 30(mins)
Maintenance Template: t1
Reload in Maintenance: False
Device#show system mode maintenance clients
System Mode: Normal
Maintenance Clients:
CLASS-EGP
CLASS-IGP
router isis 1: Transition None
CLASS-MCAST
CLASS-L2
Device#show system mode maintenance template default
System Mode: Normal
default maintenance-template details:
router isis 1
router isis 2
Device#show system mode maintenance template t1
System Mode: Normal
Maintenance Template t1 details:
router isis 1
Command |
Purpose |
---|---|
show system mode [maintenance [clients | template template-name]] |
Displays information about system mode. |
show system snapshots [dump <snapshot-file-name>] |
Displays all the snapshots present on the device. Using the keyword dump displays all snapshots in XML format. |
show system snapshots compare snapshot-name1 snapshot-name2 |
Displays differences between snapshots taken before entering maintenance mode and after exiting from the maintenance mode. |
Command |
Purpose |
---|---|
debug system mode maintenance |
Displays information for troubleshooting GIR feature. |
Related Topic | Document Title |
---|---|
For complete syntax and usage information for the commands used in this chapter. |
High Availability Command Reference, Cisco IOS XE Everest 16.6.1. |
MIB | MIBs Link |
---|---|
All the supported MIBs for this release. |
To locate and download MIBs for selected platforms, Cisco IOS releases, and feature sets, use Cisco MIB Locator found at the following URL: |
Description | Link |
---|---|
The Cisco Support website provides extensive online resources, including documentation and tools for troubleshooting and resolving technical issues with Cisco products and technologies. To receive security and technical information about your products, you can subscribe to various services, such as the Product Alert Tool (accessed from Field Notices), the Cisco Technical Services Newsletter, and Really Simple Syndication (RSS) Feeds. Access to most tools on the Cisco Support website requires a Cisco.com user ID and password. |