system maintenance

Accesses config-system-maintenance sub-mode, enables system maintenance mode, and configures the convergence time for redirecting traffic to the maintenance mode node.

Syntax

system maintenance { enable | convergence-time seconds }

no system maintenance

Command Default

By default, system maintenance mode is not enabled.

Parameters

enable: Enables system maintenance mode.
convergence-time seconds: Specifies the number of seconds allowed per stage of the convergence of traffic to the maintenance mode node. Valid values range from 100 through 500. The default is 100.

Modes

Privileged EXEC mode

Config-system-maintenance sub-mode

Usage Guidelines

Planned maintenance operations such as software upgrade, SFP replacement, cable replacement, and node replacement may require the device to be shut down or restarted, resulting in traffic disruption even if alternative paths are available. Maintenance mode provides graceful traffic diversion to alternative traffic paths, helping to minimize traffic loss during such planned operations.

When an alternative path is available, the BGP and MCT protocols redirect traffic away from the node that is going into maintenance mode. When maintenance mode is enabled, all protocols that are running on the maintenance mode node are notified and redirection of traffic (convergence) begins in stages.

The no form of the command disables maintenance mode. In config-system-maintenance sub-mode, the no enable command also disables maintenance mode.

Maintenance mode is not supported for the following features: BGP address-family, Flowspec, Layer 3 VPN, VPLS, and VLL (virtual leased line).

Examples

The following example enables system maintenance mode and specifies a convergence time of 120 seconds.

device# configure terminal
device(config)# system
device(config-system)# maintenance
device(config-system-maintenance)# enable
device(config-system-maintenance)# convergence-time 120

The following example disables maintenance mode.

device# no system maintenance

The following example also disables maintenance mode.

device(config-system-maintenance)# no enable