-
Cisco IOS High Availability Command Reference
-
Introduction
-
action cli through configure replace
-
control-plane through debug mpls ldp checkpoint
-
debug mpls ldp graceful-restart through event wdsysmon
-
frame-relay redundancy auto-sync lmi-sequence-numbers through issu set rollback-timer
-
match mpls-label through route-target
-
service call-home through show ip pim interface
-
show ip pim neighbor through show ppp subscriber statistics
-
show pppatm statistics through vrrp timers learn
-
Table Of Contents
Cisco IOS High Availability Commands
call-home (global configuration)
clear ip multicast redundancy statistics
clear ip rsvp hello instance counters
clear ip rsvp hello instance statistics
clear ip rsvp hello statistics
clear ip rsvp high-availability counters
clear ppp subscriber statistics
configure issu set rollback timer
Cisco IOS High Availability Commands
action cli
To specify the action of executing a Cisco IOS command-line interface (CLI) command when an Embedded Event Manager (EEM) applet is triggered, use the action cli command in applet configuration mode. To remove the action of executing a CLI command, use the no form of this command.
action label cli command cli-string [pattern pattern-string]
no action label cli command cli-string
Syntax Description
Command Default
No CLI commands are executed when an EEM applet is triggered.
Command Modes
Applet configuration (config-applet)
Command History
Usage Guidelines
Use the action cli command to specify the action of executing a Cisco IOS CLI command when an EEM applet is triggered. The pattern keyword is optional and is used only when the command string solicits input.
There are two types of Cisco IOS CLI commands:
•
Normal—Those Cisco IOS CLI commands that produce output followed by a display of the normal router prompt. The action cli command ends when the normal router prompt is received.
•
The action cli command ends when the solicited prompt as specified in the optional pattern keyword is received. You are required to specify a regular expression pattern that will match the next solicited prompt. Specifying an incorrect pattern will cause the action cli command to wait forever until the applet execution times out due to the maxrun timer expiration.
The vty lines are allocated from the pool of vty lines that are configured using the line vty CLI configuration command. EEM will use a vty line when a vty line is not being used by EEM and there are available vty lines. EEM will also use a vty line when EEM is already using a vty line and there are three or more vty lines available. Be aware that the connection will fail when fewer than three vty lines are available, preserving the remaining vty lines for Telnet use.
Table 8 shows the built-in variable that is set when the action cli command is run.
Table 8 EEM Built-in Variables for action cli Command
$_cli_result
The result of the execution of the CLI command.
Examples
The following example shows how to specify an EEM applet to run when the Cisco IOS interface loopback CLI command is configured three times. The applet executes the no shutdown command to ensure that the loopback interfaces are operational.
Router(config)# event manager applet cli-matchRouter(config-applet)# event cli command {.*interface loopback*} sync yes occurs 3Router(config-applet)# action 1.0 cli command "no shutdown"The following example shows how to specify an EEM applet to run when the pattern keyword specifies the confirm argument for the clear counters Ethernet0/1 command.
Router(config)# event manager applet cli-matchRouter(config-applet)# action 1.0 cli command "enable"Router(config-applet)# action 2.0 cli command "clear counters Ethernet0/1" pattern "confirm"Router(config-applet)# action 3.0 cli command "y"!Related Commands
event manager applet
Registers an event applet with the Embedded Event Manager and enters applet configuration mode.
action cns-event
To specify the action of sending a message to the CNS Event Bus when an Embedded Event Manager (EEM) applet is triggered, use the action cns-event command in applet configuration mode. To remove the action of sending a message to the CNS Event Bus, use the no form of this command.
action label cns-event msg msg-text
no action label cns-event msg msg-text
Syntax Description
Command Default
No messages are sent to the CNS Event Bus.
Command Modes
Applet configuration
Command History
Examples
The following example shows how to specify a message to be sent to the CNS Event Bus when the memory-fail applet is triggered:
Router(config)# event manager applet memory-failRouter(config-applet)# event snmp oid 1.3.6.1.4.1.9.9.48.1.1.1.6.1 get-type exact entry-op lt entry-val 5120000 poll-interval 10Router(config-applet)# action 1.0 cns-event msg "Memory exhausted; current available memory is $_snmp_oid_val bytes"Related Commands
event manager applet
Registers an event applet with the Embedded Event Manager and enters applet configuration mode.
action counter
To specify the action of setting or modifying a named counter when an Embedded Event Manager (EEM) applet is triggered, use the action counter command in applet configuration mode. To restore the default value to the counter, use the no form of this command.
action label counter name counter-name value counter-value op {dec | inc | nop | set}
no action label counter name counter-name value counter-value op {dec | inc | nop | set}
Syntax Description
Command Default
No counter values are set or modified.
Command Modes
Applet configuration
Command History
Usage Guidelines
Use the action counter command when an event occurs periodically and you want an action to be implemented after a specified number of occurrences of that event. When the action counter command completes, an environment variable is updated as shown in Table 8.
Table 8 shows the built-in variable that is set when the action counter command is run.
Table 9 EEM Built-in Variables for action counter Command
$_counter_value_remain
The value of the counter after the execution of the action counter command.
Use the event counter command with the action counter command when an event occurs periodically and you want an action to be implemented after a specified number of occurrences of the event.
Examples
The following example shows an EEM applet called IPSLAping1 being registered to run when there is an exact match on the value of a specified SNMP object ID that represents a successful IP SLA ICMP echo operation (this is equivalent to a ping command). Four actions are triggered when the echo operation fails, and event monitoring is disabled until after the second failure. A message saying that the ICMP echo operation to a server failed is sent to syslog, an SNMP trap is generated, EEM publishes an application-specific event, and a counter called IPSLA1F is incremented by a value of one.
Router(config)# event manager applet IPSLAping1Router(config-applet)# event snmp oid 1.3.6.1.4.1.9.9.42.1.2.9.1.6.4 get-type exact entry-op eq entry-val 1 exit-op eq exit-val 2 poll-interval 5Router(config-applet)# action 1.0 syslog priority critical msg "Server IP echo failed: OID=$_snmp_oid_val"Router(config-applet)# action 1.1 snmp-trap strdata "EEM detected server reachability failure to 10.1.88.9"Router(config-applet)# action 1.2 publish-event sub-system 88000101 type 1 arg1 10.1.88.9 arg2 IPSLAEcho arg3 failRouter(config-applet)# action 1.3 counter name _IPSLA1F value 1 op incThe following example shows a policy—EventCounter_A—that is configured to run once a minute and to increment a well-known counter called critical_errors. A second policy—EventCounter_B—is registered to be triggered when the well-known counter called critical_errors exceeds a threshold of 3. When policy EventCounter_B runs, it resets the counter back to 0.
Router(config)# event manager applet EventCounter_ARouter(config-applet)# event timer watchdog time 60.0Router(config-applet)# action 1.0 syslog msg "EventCounter_A"Router(config-applet)# action 2.0 counter name critical_errors value 1 op incRouter(config-applet)# exitaction force-switchover
To specify the action of switching to a secondary processor in a fully redundant environment when an Embedded Event Manager (EEM) applet is triggered, use the action force-switchover command in applet configuration mode. To remove the action of switching to a secondary processor, use the no form of this command.
action label force-switchover
no action label force-switchover
Syntax Description
Command Default
A switch to a secondary processor is not made.
Command Modes
Applet configuration
Command History
Usage Guidelines
Before using the action force-switchover command, you must install a backup processor in the device. If the hardware is not fully redundant, the switchover action will not be performed.
Examples
The following example shows how to specify a switch to the secondary Route Processor (RP) when the memory-fail applet is triggered:
Router(config)# event manager applet memory-failRouter(config-applet)# event snmp oid 1.3.6.1.4.1.9.9.48.1.1.1.6.1 get-type exact entry-op lt entry-val 5120000 poll-interval 10Router(config-applet)# action 2.0 force-switchoverRelated Commands
event manager applet
Registers an event applet with the Embedded Event Manager and enters applet configuration mode.
action info
To specify the action of obtaining system information when an Embedded Event Manager (EEM) applet is triggered, use the action info command in applet configuration mode. To remove the action info command from the configuration, use the no form of this command.
action label info type {cli frequency | cli history | syslog frequency | syslog history | routername | snmp oid oid-value get-type {exact | next}}
no action label info type {cli frequency | cli history | syslog frequency | syslog history | routername | snmp oid oid-value get-type {exact | next}}
Syntax Description
Command Default
No system information is requested.
Command Modes
Applet configuration
Command History
Usage Guidelines
Use the action info command when an event occurs and you want to request some system information. When the snmp oid keyword is used, an error message is returned when the OID is not one of the defined types.
Table 8 shows the built-in variables that are set for the various action info keywords. The notation [1-N] represents that the built-in variable ends in a sequential number starting at 1 up to the maximum number of entries returned.
Examples
The following example shows how to configure an EEM applet to intercept configuration commands that attempt to access any loopback interface. The applet also performs a no shutdown command on the interface that is selected, and logs a message with the number of times that any "interface loopback" has been attempted. The console output is shown with the configuration because the final line displays the log message.
Note
Router# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# event manager applet cli-matchRouter(config-applet)# event cli pattern ".*interface Loopback.*" sync yesRouter(config-applet)# action 1.0 cli command "enable"Router(config-applet)# action 1.1 cli command "$_cli_msg"Router(config-applet)# action 1.2 cli command "no shutdown"Router(config-applet)# action 1.3 info type cli frequencyRouter(config-applet)# action 1.4 syslog msg "There have been $_info_cli_freq_match_count_1 '$_info_cli_freq_pattern_1' matches."Router(config-applet)# set 1.5 _exit_status 0Router(config-applet)# endRouter#00:37:30: %SYS-5-CONFIG_I: Configured from console by consoleRouter# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# interface loopback0Router(config)#00:37:43: %HA_EM-6-LOG: cli-match: There have been 27 '.*interface Loopback.*' matches.Related Commands
event manager applet
Registers an event applet with the Embedded Event Manager and enters applet configuration mode.
action mail
To specify the action of sending a short e-mail when an Embedded Event Manager (EEM) applet is triggered, use the action mail command in applet configuration mode. To remove the action mail command from the configuration, use the no form of this command.
action label mail server server-address to to-address from from-address [cc cc-address] subject subject body body-text
no action label mail server server-address to to-address from from-address [cc cc-address] subject subject body body-text
Syntax Description
Command Default
No e-mails are sent.
Command Modes
Applet configuration (config-applet)
Command History
Usage Guidelines
Use the action mail command when an event occurs about which you want to send an e-mail message, such as informing an administrator about the event.
In EEM 3.0 for Cisco IOS Release 12.4(22)T, the server-address argument includes an optional username and password along with the fully qualified domain name of the e-mail server to be used to forward the e-mail. The e-mail server name can be in any one of the following template formats:
•
•
•
For example, username:123456@mailserver.cisco.com, or username@mailserver.cisco.com, or mailserver.cisco.com. If a username is supplied, the router will attempt to authenticate using the LOGIN AUTH dialog. If no username is supplied, no authentication is performed.
Examples
The following example shows how to send an e-mail when an EEM applet executes. The applet named EventInterface is triggered every time the receive_throttle counter for Fast Ethernet interface 0/0 is incremented by 5. The polling interval to check the counter is specified to run once every 90 seconds. When the applet is triggered, a syslog message and an e-mail are sent.
Router(config)# event manager applet EventInterfaceRouter(config-applet)# event interface name FastEthernet0/0 parameter receive_throttle entry-op ge entry-val 5 entry-val-is-increment true poll-interval 90Router(config-applet)# action 1.0 syslog msg "Applet EventInterface"Router(config-applet)# action 1.1 mail server mailserver.cisco.com to engineering@cisco.com from devtest@cisco.com cc manager@cisco.com subject "Receive_throttle counter incremented" body "Receive_throttle counter for FastEthernet0/0 interface has incremented by 5"Related Commands
event manager applet
Registers an event applet with the Embedded Event Manager and enters applet configuration mode.
action policy
To specify the action of manually running an Embedded Event Manager (EEM) policy when an EEM applet is triggered, use the action policy command in applet configuration mode. To remove the action policy command from the configuration, use the no form of this command.
action label policy policy-filename
no action label policy policy-filename
Syntax Description
Command Default
No EEM policies are run.
Command Modes
Applet configuration
Command History
Usage Guidelines
EEM usually schedules and runs policies on the basis of an event specification that is contained within the policy itself. The event none command allows EEM to identify an EEM policy that can be run manually or when an EEM applet is triggered. To run the policy, use either the action policy command in applet configuration mode or the event manager run command in global configuration mode.
Examples
The following example shows how to register a policy named policy-manual to be run manually and then to execute the policy:
Router(config)# event manager applet policy-manualRouter(config-applet)# event none policy-manualRouter(config-applet)# action label1 policy policy-manualRelated Commands
action publish-event
To specify the action of publishing an application-specific event when the event specified for an Embedded Event Manager (EEM) applet is triggered, use the action publish-event command in applet configuration mode. To remove the action of publishing an application-specific event, use the no form of this command.
action label publish-event sub-system sub-system-id type event-type arg1 argument-data
[arg2 argument-data] [arg3 argument-data] [arg4 argument-data]no action label publish-event
Syntax Description
Command Default
No application-specific events are published.
Command Modes
Applet configuration
Command History
Examples
The following example shows how a policy named EventPublish_A runs every 20 seconds and publishes an event to a well-known EEM event type numbered 1. A second policy named EventPublish_B is registered to run when the well-known EEM event type of 1 occurs. When policy EventPublish_B runs, it outputs a message to syslog containing the argument 1 argument data passed from EventPublish_A.
Router(config)# event manager applet EventPublish_ARouter(config-applet)# event timer watchdog time 20.0Router(config-applet)# action 1.0 syslog msg "Applet EventPublish_A"Router(config-applet)# action 2.0 publish-event sub-system 798 type 1 arg1 twentyRouter(config-applet)# exitRouter(config)# event manager applet EventPublish_BRouter(config-applet)# event application sub-system 798 type 1Router(config-applet)# action 1.0 syslog msg "Applet EventPublish_B arg1 $_application_data1"Related Commands
event manager applet
Registers an event applet with the Embedded Event Manager and enters applet configuration mode.
action reload
To specify the action of reloading the Cisco IOS software when an Embedded Event Manager (EEM) applet is triggered, use the action reload command in applet configuration mode. To remove the action of reloading the Cisco IOS software, use the no form of this command.
action label reload
no action label reload
Syntax Description
Command Default
No reload of the Cisco IOS software is performed.
Command Modes
Applet configuration
Command History
Usage Guidelines
Before configuring the action reload command, you should ensure that the device is configured to reboot the software version that you are expecting. Use the show startup-config command and look for any boot system commands.
Examples
The following example shows how to reload the Cisco IOS software when the memory-fail applet is triggered:
Router(config)# event manager applet memory-failRouter(config-applet)# event snmp oid 1.3.6.1.4.1.9.9.48.1.1.1.6.1 get-type exact entry-op lt entry-val 5120000 poll-interval 10Router(config-applet)# action 3.0 reloadRelated Commands
action snmp-trap
To specify the action of generating a Simple Network Management Protocol (SNMP) trap when an Embedded Event Manager (EEM) applet is triggered, use the action snmp-trap command in applet configuration mode. To remove the action of generating an SNMP trap, use the no form of this command.
action label snmp-trap [intdata1 integer] [intdata2 integer] [strdata string]
no action label snmp-trap
Syntax Description
Command Default
No SNMP traps are generated when an EEM applet is triggered.
Command Modes
Applet configuration
Command History
Usage Guidelines
Before configuring this command, you must enable the snmp-server enable traps event-manager command to permit SNMP traps to be sent from the Cisco IOS device to the SNMP server. Other relevant snmp-server commands must also be configured.
This command generates an asynchronous message that is sent from the Cisco IOS device to the SNMP agent. The SNMP agent can be coded to understand customized data such as the optional integer and string data that can be sent in the SNMP trap message.
The SNMP trap that is generated uses the EEM MIB, CISCO-EMBEDDED-EVENT-MGR-MIB.my. Details about the MIB can be found using Cisco MIB Locator at the following URL:
Examples
The following example shows an EEM applet called IPSLAping1 being registered to run when there is an exact match on the value of a specified SNMP object ID that represents a successful IP SLA ICMP echo operation (this is equivalent to a ping command). Four actions are triggered when the echo operation fails, and event monitoring is disabled until after the second failure. A message that the ICMP echo operation to a server failed is sent to syslog, an SNMP trap is generated, EEM publishes an application-specific event, and a counter called IPSLA1F is incremented by a value of one.
Router(config)# event manager applet IPSLAping1Router(config-applet)# event snmp oid 1.3.6.1.4.1.9.9.42.1.2.9.1.6.4 get-type exact entry-op eq entry-val 1 exit-op eq exit-val 2 poll-interval 5Router(config-applet)# action 1.0 syslog priority critical msg "Server IP echo failed: OID=$_snmp_oid_val"Router(config-applet)# action 1.1 snmp-trap strdata "EEM detected server reachability failure to 10.1.88.9"Router(config-applet)# action 1.2 publish-event sub-system 88000101 type 1 arg1 10.1.88.9 arg2 IPSLAEcho arg3 failRouter(config-applet)# action 1.3 counter name _IPSLA1F value 1 op incRelated Commands
action syslog
To specify the action of writing a message to syslog when an Embedded Event Manager (EEM) applet is triggered, use the action syslog command in applet configuration mode. To remove the syslog message event criteria, use the no form of this command.
action label syslog [priority priority-level] msg msg-text facility string
no action label syslog
Syntax Description
Command Default
No messages are written to syslog.
Command Modes
Applet configuration (config-applet)
Command History
Examples
The following example shows how to specify a message to be sent to syslog when the memory-fail applet is triggered:
Router(config)# event manager applet memory-failRouter(config-applet)# event snmp oid 1.3.6.1.4.1.9.9.48.1.1.1.6.1 get-type exact entry-op lt entry-val 5120000 poll-interval 10Router(config-applet)# action 4.0 syslog msg "Memory exhausted; current available memory is $_snmp_oid_val bytes"The following example shows how to generate a syslog message when it detects a syslog message pattern "console", using priority level 3 (errors) and facility EEM-FAC:
Router(config)# event manager applet testRouter(config-applet)# event syslog pattern "console"Router(config-applet)# action 4.0 syslog priority errors facility EEM-FAC msg "TEST MSG"
event manager applet
Registers an event applet with the EEM and enters applet configuration mode.
alert-group
To enable an alert group, use the alert-group command in call home configuration mode. To disable an alert group, use the no form of this command.
alert-group {all | configuration | diagnostic | environment | inventory | syslog}
no alert-group
Syntax Description
Command Default
All alert groups are enabled.
Command Modes
Call home configuration (cfg-call-home)
Command History
12.2(33)SXH
This command was introduced.
12.2(33)SRC
This command was integrated into Cisco IOS Release 12.2(33)SRC.
Usage Guidelines
An alert group is a predefined subset of Call Home alerts supported on the Catalyst 6500 series switches. Different types of Call Home alerts are grouped into different alert groups depending on their type. The alert groups are as follows:
•
•
•
•
•
Call Home trigger events are grouped into alert groups with each alert group assigned command-line interface commands to execute when an event occurs. See the Catalyst 6500 Series Switch Cisco IOS Software Configuration Guide for information on the alert group trigger events and commands.
Examples
This example shows how to enable a specific alert group:
Router(cfg-call-home)# alert-group configurationRouter(cfg-call-home)#This example shows how to enable all alert groups:
Router(cfg-call-home)# alert-group allThis example shows how to disable a specific alert group:
Router(cfg-call-home)# no alert-group syslogThis example shows how to disable all alert groups:
Router(cfg-call-home)# no alert-group allRelated Commands
call-home (global configuration)
Enters call home configuration submode.
show call-home
Displays call home configuration information.
archive config
To save a copy of the current running configuration to the Cisco IOS configuration archive, use the archive config command in privileged EXEC mode.
archive config
Syntax Description
This command has no arguments or keywords.
Command Modes
Privileged EXEC (#)
Command History
Usage Guidelines
Note
The Cisco IOS configuration archive is intended to provide a mechanism to store, organize, and manage an archive of Cisco IOS configuration files to enhance the configuration rollback capability provided by the configure replace command. Before this feature was introduced, you could save copies of the running configuration using the copy running-config destination-url command, storing the target file either locally or remotely. However, this method lacked any automated file management. On the other hand, the Configuration Replace and Configuration Rollback feature provides the capability to automatically save copies of the running configuration to the Cisco IOS configuration archive. These archived files serve as checkpoint configuration references and can be used by the configure replace command to revert to previous configuration states.
The archive config command allows you to save Cisco IOS configurations in the configuration archive using a standard location and filename prefix that is automatically appended with an incremental version number (and optional time stamp) as each consecutive file is saved. This functionality provides a means for consistent identification of saved Cisco IOS configuration files. You can specify how many versions of the running configuration are kept in the archive. After the maximum number of files has been saved in the archive, the oldest file is automatically deleted when the next, most recent file is saved. The show archive command displays information for all configuration files saved in the Cisco IOS configuration archive.
Examples
The following example shows how to save the current running configuration to the Cisco IOS configuration archive using the archive config command. Before using the archive config command, you must configure the path command to specify the location and filename prefix for the files in the Cisco IOS configuration archive. In this example, the location and filename prefix are specified as disk0:myconfig as follows:
configure terminal!archivepath disk0:myconfigendYou then save the current running configuration in the configuration archive, as follows:
archive configThe show archive command displays information on the files saved in the configuration archive as shown in the following sample output:
Router# show archiveThere are currently 1 archive configurations saved.The next archive file will be named disk0:myconfig-2Archive # Name01 disk0:myconfig-1 <- Most Recent2345678910Related Commands
bfd
To set the baseline Bidirectional Forwarding Detection (BFD) session parameters on an interface, use the bfd command in interface configuration mode. To remove the baseline BFD session parameters, use the no form of this command.
bfd interval milliseconds min_rx milliseconds multiplier multiplier-value
no bfd interval milliseconds min_rx milliseconds multiplier multiplier-value
Syntax Description
Command Default
No baseline BFD session parameters are set.
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
The bfd command can be configured on the following interfaces:
•
•
•
•
•
•
Other interface types are not supported by BFD.
Examples
The following example shows the BFD session parameters set for FastEthernet interface 3/0:
Router> enableRouter# configure terminalRouter(config)# interface fastethernet 3/0Router(config-if)# bfd interval 50 min_rx 50 multiplier 3Router(config-if)# endRelated Commands
bfd all-interfaces
To enable Bidirectional Forwarding Detection (BFD) for all interfaces participating in the routing process, use the bfd all-interfaces command in router configuration mode. To disable BFD for all interfaces, use the no form of this command.
bfd all-interfaces
no bfd all-interfaces
Syntax Description
This command has no arguments or keywords.
Command Default
BFD is not enabled on the interfaces participating in the routing process.
Command Modes
Router configuration
Command History
Usage Guidelines
There are two methods to configure routing protocols to use BFD for failure detection. To enable BFD for all neighbors of a routing protocol, enter the bfd all-interfaces command in router configuration mode. If you do not want to enable BFD on all interfaces, enter the bfd interface command in router configuration mode.
Examples
The following example shows BFD enabled for all Enhanced Interior Gateway Routing Protocol (EIGRP) neighbors:
Router> enableRouter# configure terminalRouter(config)# router eigrp 123Router(config-router)# bfd all-interfacesRouter(config-router)# endThe following example shows BFD enabled for all Intermediate System-to-Intermediate System (IS-IS) neighbors:
Router> enableRouter# configure terminalRouter(config)# router isis tag1Router(config-router)# bfd all-interfacesRouter(config-router)# endThe following example shows BFD enabled for all Open Shortest Path First (OSPF) neighbors:
Router> enableRouter# configure terminalRouter(config)# router ospf 123Router(config-router)# bfd all-interfacesRouter(config-router)# endRelated Commands
bfd
Sets the baseline BFD session parameters on an interface.
bfd all-interfaces
Enables BFD for all interfaces for a BFD peer.
bfd interface
To enable Bidirectional Forwarding Detection (BFD) on a per-interface basis for a BFD peer, use the bfd interface command in router configuration mode. To disable BFD on a per-interface basis, use the no form of this command.
bfd interface type number
no bfd interface type number
Syntax Description
type
Interface type for the interface to be enabled for BFD.
number
Interface number for the interface to be enabled for BFD.
Command Default
BFD is not enabled on the interface.
Command Modes
Router configuration
Command History
Usage Guidelines
There are two methods to configure routing protocols to use BFD for failure detection. To enable BFD for all neighbors of a routing protocol, enter the bfd all-interfaces command in router configuration mode. If you do not want to enable BFD on all interfaces, enter the bfd interface command in router configuration mode.
Examples
The following example shows BFD enabled for the Enhanced Interior Gateway Routing Protocol (EIGRP) neighbor Fast Ethernet interface 3/0:
Router> enableRouter# configure terminalRouter(config)# router eigrp 123Router(config-router)# bfd interface fastethernet 3/0Router(config-if)# endRelated Commands
bfd
Sets the baseline BFD session parameters on an interface.
bfd all-interfaces
Enables BFD for all interfaces for a BFD peer.
bgp graceful-restart
To enable the Border Gateway Protocol (BGP) graceful restart capability globally for all BGP neighbors, use the bgp graceful-restart command in address family or in router configuration mode. To disable the BGP graceful restart capability globally for all BGP neighbors, use the no form of this command.
bgp graceful-restart [restart-time seconds | stalepath-time seconds] [all]
no bgp graceful-restart
Syntax Description
Command Default
The following default values are used when this command is entered without any keywords or arguments:
restart-time: 120 seconds
stalepath-time: 360 seconds
Note
Command Modes
Address-family configuration (config-router-af)
Router configuration (router-config)Command History
Usage Guidelines
The bgp graceful-restart command is used to enable or disable the graceful restart capability globally for all BGP neighbors in a BGP network. The graceful restart capability is negotiated between nonstop forwarding (NSF)-capable and NSF-aware peers in OPEN messages during session establishment. If the graceful restart capability is enabled after a BGP session has been established, the session will need to be restarted with a soft or hard reset.
The graceful restart capability is supported by NSF-capable and NSF-aware routers. A router that is NSF-capable can perform a stateful switchover (SSO) operation (graceful restart) and can assist restarting peers by holding routing table information during the SSO operation. A router that is NSF-aware functions like a router that is NSF-capable but cannot perform an SSO operation.
The BGP graceful restart capability is enabled by default when a supporting version of Cisco IOS software is installed. The default timer values for this feature are optimal for most network deployments. We recommend that they are adjusted only by experienced network operators. When adjusting the timer values, the restart timer should not be set to a value greater than the hold time that is carried in the OPEN message. If consecutive restart operations occur, routes (from a restarting router) that were previously marked as stale will be deleted.
Note
Examples
In the following example, the BGP graceful restart capability is enabled:
Router# configure terminalRouter(config)# router bgp 65000Router(config-router)# bgp graceful-restartIn the following example, the restart timer is set to 130 seconds:
Router# configure terminalRouter(config)# router bgp 65000Router(config-router)# bgp graceful-restart restart-time 130In the following example, the stalepath timer is set to 350 seconds:
Router# configure terminalRouter(config)# router bgp 65000Router(config-router)# bgp graceful-restart stalepath-time 350Related Commands
show ip bgp
Displays entries in the BGP routing table.
show ip bgp neighbors
Displays information about the TCP and BGP connections to neighbors.
boot system
To specify the system image that the router loads at startup, use one of the following boot system command in global configuration mode. To remove the startup system image specification, use the no form of this command.
Loading System Image from a URL or a TFTP File
boot system {file-url | filename}
no boot system {file-url | filename}
Booting from a System Image in Internal Flash
boot system flash [flash-fs:] [partition-number:] [filename]
no boot system flash [flash-fs:] [partition-number:] [filename]
Booting from a MOP Server
boot system mop filename [mac-address] [interface]
no boot system mop filename [mac-address] [interface]
Booting from ROM
boot system rom
no boot system rom
Booting a System Image from a Network, TFTP, or FTP Server
boot system {rcp | tftp | ftp} filename [ip-address]
no boot system {rcp | tftp | ftp} filename [ip-address]
Syntax Description
Command Default
If you configure the router to boot from a network server but do not specify a system image file with the boot system command, the router uses the configuration register settings to determine the default system image filename. The router forms the default boot filename by starting with the word cisco and then appending the octal equivalent of the boot field number in the configuration register, followed by a hyphen (-) and the processor type name (cisconn-cpu). Refer to the appropriate hardware installation guide for details on the configuration register and default filename. See also the config-register or confreg command.
Command Modes
Global configuration
Command History
Usage Guidelines
For this command to work, the config-register command must be set properly.
Enter several boot system commands to provide a fail-safe method for booting your router. The router stores and executes the boot system commands in the order in which you enter them in the configuration file. If you enter multiple boot commands of the same type—for example, if you enter two commands that instruct the router to boot from different network servers—then the router tries them in the order in which they appear in the configuration file. If a boot system command entry in the list specifies an invalid device, the router omits that entry. Use the boot system rom command to specify use of the ROM system image as a backup to other boot system commands in the configuration.
For some platforms, the boot image must be loaded before the system image is loaded. However, on many platforms, the boot image is loaded only if the router is booting from a network server or if the flash file system is not specified. If the file system is specified, the router will boot faster because it need not load the boot image first.
This section contains the following topics:
•
•
•
•
•
•
•
Changing the List of Boot System Commands
To remove a single entry from the bootable image list, use the no form of the command with an argument. For example, to remove the entry that specifies a bootable image on a flash memory card inserted in the second slot, use the no boot system flash slot1:[filename] command. All other entries in the list remain.
To eliminate all entries in the bootable image list, use the no boot system command. At this point, you can redefine the list of bootable images using the previous boot system commands. Remember to save your changes to your startup configuration by issuing the copy system:running-config nvram:startup-config command.
Each time you write a new software image to flash memory, you must delete the existing filename in the configuration file with the no boot system flash filename command. Then add a new line in the configuration file with the boot system flash filename command.
Note
Booting Compressed Images
You can boot the router from a compressed image on a network server. When a network server boots software, both the image being booted and the running image must be able to fit into memory. Use compressed images to ensure that enough memory is available to boot the router. You can compress a software image on any UNIX platform using the compress command. Refer to your UNIX platform's documentation for the exact usage of the compress command. (You can also uncompress data with the UNIX uncompress command.)
Understanding rcp
The rcp requires that a client send the remote username in an rcp request to a server. When the router executes the boot system rcp command, the Cisco IOS software sends the hostname as both the remote and local usernames by default. Before the rcp can execute properly, an account must be defined on the network server for the remote username configured on the router.
If the server has a directory structure, the rcp software searches for the system image to boot from the remote server relative to the directory of the remote username.
By default, the router software sends the hostname as the remote username. You can override the default remote username by using the ip rcmd remote-username command. For example, if the system image resides in the home directory of a user on the server, you can specify that user's name as the remote username.
Understanding TFTP
You need a TFTP server running to retrieve the router image from the host.
Understanding FTP
You need an FTP server running to retrieve the router image from the host. You also need an account on the server or anonymous file access to the server.
Stopping Booting and Entering ROM Monitor Mode
During the first 60 seconds of startup, you can force the router to stop booting by pressing the Break key. The router will enter ROM monitor mode, where you can change the configuration register value or boot the router manually.
Cisco 1600 Series, Cisco 3600 Series, Cisco 7000 Family, and Cisco 7600 Series Router Notes
For the Cisco 3600 series and Cisco 7000 family, the boot system command modifies the BOOT variable in the running configuration. The BOOT variable specifies a list of bootable images on various devices.
Note
To display the contents of the BOOT variable, use the show bootvar EXEC command.
Examples
The following example illustrates a configuration that specifies two possible internetwork locations for a system image, with the ROM software being used as a backup:
Router(config)# boot system tftp://192.168.7.24/cs3-rx.90-1Router(config)# boot system tftp://192.168.7.19/cs3-rx.83-2Router(config)# boot system romThe following example boots the system boot relocatable image file named igs-bpx-l from partition 2 of the flash device:
Router(config)# boot system flash:2:igs-bpx-lThe following example instructs the router to boot from an image located on the flash memory card inserted in slot 0:
Router(config)# boot system slot0:new-configThe following example specifies the file named new-ios-image as the system image for a Cisco 3600 series router to load at startup. This file is located in the fourth partition of the flash memory card in slot 0.
Router(config)# boot system slot0:4:dirt/images/new-ios-imageThis example boots from the image file named c1600-y-l in partition 2 of flash memory of a Cisco 1600 series router:
Router(config)# boot system flash:2:c1600-y-lRelated Commands
call-home (global configuration)
To enter call home configuration submode, use the call-home command in global configuration mode.
call-home
Syntax Description
This command has no arguments or keywords.
Command Default
This command has no default settings.
Command Modes
Global configuration (config)
Command History
12.2(33)SXH
This command was introduced.
12.2(33)SRC
This command was integrated into Cisco IOS Release 12.2(33)SRC.
12.2(52)SG, 12.2(33)SXI2
The vrf command was added.
Usage Guidelines
Once you enter the call-home command, the prompt changes to Router(cfg-call-home)#, and you have access to the call home configuration commands as follows:
•
•
•
•
•
•
•
•
You can define backup e-mail servers by repeating the mail-server command and entering different priority numbers.
•
•
•
•
•
•
•
•
Note
Examples
This example show how to configure the contact information:
Router(config)# call-homeRouter(cfg-call-home)# contact-email-addr username@example.comRouter(cfg-call-home)# contract-id Company1234Router(cfg-call-home)# customer-id Customer1234Router(cfg-call-home)# phone-number +1-800-555-0199Router(cfg-call-home)# site-id Site1Router(cfg-call-home)# street-address "1234 Any Street, Any city, Any state, 12345"This example shows how to configure the call-home message rate-limit threshold:
Router(config)# call-homeRouter(cfg-call-home)# rate-limit 50This example shows how to set the call-home message rate-limit threshold to the default setting:
Router(config)# call-homeRouter(cfg-call-home)# default rate-limitThis example shows how to create a new destination profile with the same configuration settings as an existing profile:
Router(config)# call-homeRouter(cfg-call-home)# copy profile profile1 profile1aThis example shows how to configure the general e-mail parameters, including a primary and secondary e-mail server:
Router(config)# call-homeRouter(cfg-call-home)# mail-server smtp.example.com priority 1Router(cfg-call-home)# mail-server 192.168.0.1 priority 2Router(cfg-call-home)# sender from username@example.comRouter(cfg-call-home)# sender reply-to username@example.comThis example shows how to enable vrf support by specifying the configured interface interface from which to send an email message:
Router(config)# call-homeRouter(cfg-call-home)# vrf <vrf-instance-name>Related Commands
alert-group
Enables an alert group.
profile
Enters call-home profile configuration mode.
show call-home
Displays call home configuration information.
call-home send alert-group
To send a specific alert group message, use the call-home send alert-group command in privileged EXEC mode.
call-home send alert-group {configuration | diagnostic module number | inventory} [profile profile-name]
Syntax Description
Command Default
This command has no default settings.
Command Modes
Privileged EXEC (#)
Command History
12.2(33)SXH
This command was introduced.
12.2(33)SRC
This command was integrated into Cisco IOS Release 12.2(33)SRC.
Usage Guidelines
When you enter the module number, you can enter the number of the module, the slot/subslot, or the slot/bay number.
If you do not specify the profile profile-name, the message is sent to all subscribed destination profiles.
Only the configuration, diagnostic, and inventory alert groups can be manually sent. The destination profile need not be subscribed to the alert group.
Examples
This example shows how to send the configuration alert-group message to the destination profile:
Router# call-home send alert-group configurationThis example shows how to send the diagnostic alert-group message to the destination profile for a specific module, slot/subslot, or slot/bay number.
Router# call-home send alert-group diagnostic module 3 5/2This example shows how to send the diagnostic alert-group message to all destination profiles for a specific module, slot/subslot, or slot/bay number.
Router# call-home send alert-group diagnostic module 3 5/2 profile Ciscotac1This example shows how to send the inventory call-home message:
Router# call-home send alert-group inventoryRelated Commands
call-home test
To manually send a Call Home test message, use the call-home test command in privileged EXEC mode.
call-home test ["test-message"] profile profile-name
Syntax Description
"test-message"
(Optional) Test message text.
profile profile-name
Specifies the name of the destination profile.
Command Default
This command has no default settings.
Command Modes
Privileged EXEC (#)
Command History
12.2(33)SXH
This command was introduced.
12.2(33)SRC
This command was integrated into Cisco IOS Release 12.2(33)SRC.
Usage Guidelines
This command sends a test message to the specified destination profile. If you enter test message text, you must enclose the text in quotes ("") if it contains spaces. If you do not enter a message, a default message is sent.
Examples
This example shows how to manually send a Call Home test message:
Router# call-home test "test of the day" profile Ciscotac1Related Commands
capability lls
To enable the use of the Link-Local Signalling (LLS) data block in originated Open Shortest Path First (OSPF) packets and reenable OSPF nonstop forwarding (NSF) awareness, use the capability lls command in router configuration mode. To disable LLS and OSPF NSF awareness, use the no form of this command.
capability lls
no capability lls
Syntax Description
This command has no arguments or keywords.
Command Default
LLS is enabled.
Command Modes
Router configuration
Command History
Usage Guidelines
You might want to disable NSF awareness by disabling the use of the LLS data block in originated OSPF packets. You might want to disable NSF awareness if the router has no applications using LLS.
If NSF is configured and you try to disable LLS, you will receive the error message, "OSPF Non-Stop Forwarding (NSF) must be disabled first."
If LLS is disabled and you try to configure NSF, you will receive the error message, "OSPF Link-Local Signaling (LLS) capability must be enabled first."
Examples
The following example disables LLS support and OSPF NSF awareness:
router ospf 2no capability llsclear configuration lock
To clear the lock on the running configuration file, use the clear configuration lock command in privileged EXEC mode.
clear configuration lock
Syntax Description
This command has no arguments or keywords.
Command Modes
Privileged EXEC
Command History
Examples
The following is sample output from the clear configuration lock command when the running configuration file is not locked by the configure replace command:
Router# clear configuration lockParser Config not locked.The following is sample output from the clear configuration lock command when the running configuration file is locked by the configure replace command:
Router# clear configuration lockProcess <3> is holding the EXCLUSIVE lock !Do you want to clear the lock?[confirm] yThe following example shows how to use the clear configuration lock command to display the owner or process ID of the lock and prompt the user for confirmation:
Router# clear configuration lockProcess <46> is holding the EXCLUSIVE lock.Do you want to clear the lock?[confirm] yAfter the lock is cleared, a message will be sent to the terminal if the owner of the lock is a TTY user:
Router(config)# The configuration lock was cleared by user <steve> from terminal <5>Related Commands
clear ip cef epoch
Note
To begin a new epoch and increment the epoch number for one or all Cisco Express Forwarding tables, use the clear ip cef epoch command in privileged EXEC mode.
clear ip cef epoch [all-vrfs | full | vrf [table]]
Syntax Description
Command Modes
Privileged EXEC (#)
Command History
Usage Guidelines
Use the clear ip cef epoch command when you want to rebuild a table. This command increments the epoch number and flushes entries with the old epoch number. This command clears any inconsistencies that might exist, so if everything in the system is working correctly, this command does not affect the Cisco Express Forwarding forwarding tables other than changing the current epoch values.
Examples
The following example shows the output before and after you clear the epoch table and increment the epoch number:
Router# show ip cef epochCEF epoch information:Table: Default-tableTable epoch: 2 (43 entries at this epoch)Adjacency tableTable epoch: 2 (5 entries at this epoch)Router# clear ip cef epoch fullRouter# show ip cef epochCEF epoch information:Table: Default-tableTable epoch: 3 (43 entries at this epoch)Adjacency tableTable epoch: 3 (5 entries at this epoch)Related Commands
show cef state
Displays the state of Cisco Express Forwarding.
show ip cef epoch
Displays the table epochs of the adjacency table and of all FIB tables.
clear ip multicast redundancy statistics
To reset IP multicast redundancy statistics, use the clear ip multicast redundancy statistics command in privileged EXEC mode.
clear ip multicast redundancy statistics
Syntax Description
This command has no arguments or keywords.
Command Modes
Privileged EXEC (#)
Command History
12.2(33)SXI
This command was introduced.
12.2(33)SRE
This command was integrated into Cisco IOS Release 12.2(33)SRE.
Examples
The following example shows how to clear IP multicast redundancy statistics:
Router# clear ip multicast redundancy statisticsRelated Commands
show ip multicast redundancy statistics
Displays IP multicast redundancy statistics.
clear ip rsvp hello instance counters
To clear (refresh) the values for hello instance counters, use the clear ip rsvp hello instance counters command in privileged EXEC mode.
clear ip rsvp hello instance counters
Syntax Description
This command has no arguments or keywords.
Command Modes
Privileged EXEC (#)
Command History
Examples
Following is sample output from the show ip rsvp hello instance detail command and then the clear ip rsvp hello instance counters command. Notice that the "Statistics" fields have been cleared to zero.
Router# show ip rsvp hello instance detailNeighbor 10.0.0.2 Source 10.0.0.1State: UP (for 2d18h)Type: PASSIVE (responding to requests)I/F: Et1/1LSPs protecting: 0Refresh Interval (msec) (used when ACTIVE)Configured: 100Statistics: (from 2398195 samples)Min: 100Max: 132Average: 100Waverage: 100 (Weight = 0.8)Current: 100Src_instance 0xA9F07C13, Dst_instance 0x9BBAA407Counters:Communication with neighbor lost:Num times: 0Reasons:Missed acks: 0Bad Src_Inst received: 0Bad Dst_Inst received: 0I/F went down: 0Neighbor disabled Hello: 0Msgs Received: 2398194Sent: 2398195Suppressed: 0Router# clear ip rsvp hello instance countersNeighbor 10.0.0.2 Source 10.0.0.1State: UP (for 2d18h)Type: PASSIVE (responding to requests)I/F: Et1/1LSPs protecting: 0Refresh Interval (msec) (used when ACTIVE)Configured: 100Statistics:Min: 0Max: 0Average: 0Waverage: 0Current: 0Src_instance 0xA9F07C13, Dst_instance 0x9BBAA407Counters:Communication with neighbor lost:Num times: 0Reasons:Missed acks: 0Bad Src_Inst received: 0Bad Dst_Inst received: 0I/F went down: 0Neighbor disabled Hello: 0Msgs Received: 2398194Sent: 2398195Suppressed: 0Related Commands
clear ip rsvp hello instance statistics
To clear hello statistics for an instance, use the clear ip rsvp hello instance statistics command in privileged EXEC mode.
clear ip rsvp hello instance statistics
Syntax Description
This command has no arguments or keywords.
Command Default
Hello statistics are not cleared for an instance.
Command Modes
Privileged EXEC (#)
Command History
Examples
This example shows sample output from the show ip rsvp hello statistics command and the values in those fields after you enter the clear ip rsvp hello instance statistics command.
Router# show ip rsvp hello statisticsStatus: EnabledPacket arrival queue:Wait times (msec)Current:0Average:0Weighted Average:0 (weight = 0.8)Max:4Current length: 0 (max:500)Number of samples taken: 2398525Router# clear ip rsvp hello instance statisticsStatus: EnabledPacket arrival queue:Wait times (msec)Current:0Average:0Weighted Average:0 (weight = 0.8)Max:0Current length: 0 (max:500)Number of samples taken: 0Related Commands
clear ip rsvp hello statistics
To clear hello statistics globally, use the clear ip rsvp hello statistics command in privileged EXEC mode.
clear ip rsvp hello statistics
Syntax Description
This command has no arguments or keywords.
Command Default
Hello statistics are not globally cleared.
Command Modes
Privileged EXEC (#)
Command History
Usage Guidelines
Use this command to remove all information about how long hello packets have been in the hello input queue.
Examples
Following is sample output from the show ip rsvp hello statistics command and the clear ip rsvp hello statistics command. Notice that the values in the "Packet arrival queue" fields have been cleared.
Router# show ip rsvp hello statisticsStatus: EnabledPacket arrival queue:Wait times (msec)Current:0Average:0Weighted Average:0 (weight = 0.8)Max:4Current length: 0 (max:500)Number of samples taken: 2398525Router# clear ip rsvp hello statisticsStatus: EnabledPacket arrival queue:Wait times (msec)Current:0Average:0Weighted Average:0 (weight = 0.8)Max:0Current length: 0 (max:500)Number of samples taken: 16Related Commands
ip rsvp signalling hello statistics
Enables hello statistics on a router.
show ip rsvp hello statistics
Displays how long hello packets have been in the hello input queue.
clear ip rsvp high-availability counters
To clear (set to zero) the Resource Reservation Protocol (RSVP) traffic engineering (TE) high availability (HA) counters that are being maintained by a Route Processor (RP), use the clear ip rsvp high-availability counters command in privileged EXEC mode.
clear ip rsvp high-availability counters
Syntax Description
This command has no arguments or keywords.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
Use the clear ip rsvp high-availability counters command to clear (set to zero) the HA counters, which include state, ISSU, resource failures, and historical information.
Examples
The following example clears all the HA information currently being maintained by the RP:
Router# clear ip rsvp high-availability counters
Related Commands
show ip rsvp high-availability counters
Displays the RSVP TE HA counters that are being maintained by an RP.
clear issu state
To clear the state and current version of the Route Processors (RPs) during the In Service Software Upgrade (ISSU) process, use the clear issu state command in user EXEC or privileged EXEC mode.
clear issu state
Syntax Description
This command has no arguments or keywords.
Command Modes
User EXEC (>)
Privileged EXEC (#)Command History
Usage Guidelines
This command clears the state and current version of RPs during the ISSU process.
Examples
The following example clears state and current version of the RPs during the ISSU process:
Router# clear issu stateclear mpls counters
To clear the Multiprotocol Label Switching (MPLS) forwarding table disposition counters and the Any Transport over MPLS (AToM) imposition and disposition virtual circuit (VC) counters, use the clear mpls counters command in privileged EXEC mode.
clear mpls counters
Syntax Description
This command has no arguments or keywords.
Defaults
Checkpoint information resides on the active and standby Route Processor.
Command Modes
Privileged EXEC
Command History
Examples
In the following example, the first show mpls forwarding-table command shows that 590 label-switched bytes exist in the forwarding table. The clear mpls counters command clears the counters. The second show mpls forwarding-table command shows that the number of label-switched bytes is 0.
Router# show mpls forwarding-tableLocal Outgoing Prefix Bytes Label Outgoing Next HopLabel Label or VC or Tunnel Id Switched interface20 30 10.10.17.17 590 Et3/0 172.16.0.2Router# clear mpls countersClear "show mpls forwarding-table" counters [confirm]mpls forward counters clearedRouter# show mpls forwarding-tableLocal Outgoing Prefix Bytes Label Outgoing Next HopLabel Label or VC or Tunnel Id Switched interface20 30 10.10.17.17 0 Et3/0 172.16.0.2In the following example, the first show mpls l2 vc detail command shows that 15 packets were received and sent, 1656 bytes were received, and 1986 bytes were sent. The clear mpls counters command clears the counters. The second show mpls l2 transport vc detail command shows that no bytes or packets were received or sent.
Router# show mpls l2 vc detailLocal interface: Et0/0.10 up, line protocol up, Eth VLAN 10 upMPLS VC type is Eth VLAN, interworking type is EthernetDestination address: 10.0.0.2, VC ID: 10, VC status: upOutput interface: Et1/0, imposed label stack {16}Preferred path: not configuredDefault path: activeNext hop: 10.0.0.2Create time: 00:19:35, last status change time: 00:19:09Signaling protocol: LDP, peer 10.0.0.2:0 upMPLS VC labels: local 16, remote 16Group ID: local 0, remote 0MTU: local 1500, remote 1500Remote interface description:Sequencing: receive enabled, send enabledVC statistics:packet totals: receive 15, send 15 <---- packet totalsbyte totals: receive 1656, send 1986 <---- byte totalspacket drops: receive 0, seq error 0, send 0Router# clear mpls countersClear "show mpls forwarding-table" counters [confirm] mpls forwardcounters clearedRouter# show mpls l2 vc detailLocal interface: Et0/0.10 up, line protocol up, Eth VLAN 10 upMPLS VC type is Eth VLAN, interworking type is EthernetDestination address: 10.0.0.2, VC ID: 10, VC status: upOutput interface: Et1/0, imposed label stack {16}Preferred path: not configuredDefault path: activeNext hop: 10.0.0.2Create time: 00:22:55, last status change time: 00:22:29Signaling protocol: LDP, peer 10.0.0.2:0 upMPLS VC labels: local 16, remote 16Group ID: local 0, remote 0MTU: local 1500, remote 1500Remote interface description:Sequencing: receive enabled, send enabledVC statistics:packet totals: receive 0, send 0 <---- packet totalsbyte totals: receive 0, send 0 <---- byte totalspacket drops: receive 0, seq error 0, send 0Related Commands
clear mpls ip iprm counters
To clear the IP Rewrite Manager (IPRM) counters, use the clear mpls ip iprm counters command in privileged EXEC mode.
clear mpls ip iprm counters
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
Privileged EXEC
Command History
Usage Guidelines
This command sets IPRM counters to zero.
Examples
The command in the following example clears the IPRM counters:
Router# clear mpls ip iprm countersClear iprm counters [confirm]Related Commands
clear mpls ldp checkpoint
To clear the checkpoint information from the Label Information Base (LIB) entries on the active Route Processor (RP) or PRE and to clear the LIB entries created by checkpointing on the standby RP or PRE, use the clear mpls ldp checkpoint command in privileged EXEC mode.
clear mpls ldp checkpoint [vrf vpn-name] {network {mask | length} [longer-prefixes] | *} [incomplete]
Cisco 10000 Series Routers
clear mpls ldp checkpoint {network {mask | length} [longer-prefixes] | *} [incomplete]
Syntax Description
Defaults
Checkpoint information resides on the active and standby RP.
Command Modes
Privileged EXEC
Command History
12.2(25)S
This command was introduced.
12.2(28)SB
This command was integrated into Cisco IOS Release 12.2(28)SB and implemented on the Cisco 10000 series routers.
Usage Guidelines
Use this command only when Cisco support personnel recommend it as a means of rectifying a problem.
On the active RP or PRE, this command does the following:
•
•
On the standby RP or PRE, this command deletes all of the LIB entries created by checkpointing.
Examples
The command in the following example clears the checkpointing information for prefix 10.1.10.1:
Router(config)# clear mpls ldp checkpoint 10.1.10.1 32Clear LDP bindings checkpoint state [confirm]00:20:29: %LDP-5-CLEAR_CHKPT: Clear LDP bindings checkpoint state (*) by consoleRelated Commands
show mpls ldp checkpoint
Displays information about the LDP checkpoint system on the active RP.
clear ppp subscriber statistics
To clear PPP subscriber statistics and reset counters to zero, use the clear ppp subscriber statistics command in privileged EXEC mode.
clear ppp subscriber statistics
Syntax Description
This command has no arguments or keywords.
Command Modes
Privileged EXEC
Command History
12.2(31)SB2
This command was introduced.
12.2(33)SRC
This command was integrated into Cisco IOS Release 12.2(33)SRC.
Usage Guidelines
Use the clear ppp subscriber statistics command to clear all PPP subscriber statistics and reset counters to zero.
Examples
The following example clears all PPP subscriber statistics and resets counters to zero:
Router# clear ppp subscriber statisticsRelated Commands
clear pppatm statistics
To clear PPP over ATM statistics and reset counters to zero, use the clear pppatm statistics command in privileged EXEC mode.
clear pppatm statistics
Syntax Description
This command has no arguments or keywords.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
Use the clear pppatm statistics command to clear PPPoA statistics and reset counters to zero.
Examples
The following example clears PPPoA statistics and reset counters to zero:
Router# clear pppatm subscriber statisticsRelated Commands
clear pppoe statistics
To clear PPP over Ethernet (PPPoE) statistics and reset counters to zero, use the clear pppoe statistics command in privileged EXEC mode.
clear pppoe statistics
Syntax Description
This command has no arguments or keywords.
Command Modes
Privileged EXEC
Command History
12.2(31)SB2
This command was introduced.
12.2(33)SRC
This command was integrated into Cisco IOS Release 12.2(33)SRC.
Usage Guidelines
Use the clear pppoe statistics command to clear all PPPoE statistic and reset counters to zero.
Examples
The following example clears all PPPoE statistics and resets counters to zero:
Router# clear pppoe statisticsRelated Commands
config-register
To change the configuration register settings, use the config-register command in global configuration mode.
config-register value
Syntax Description
Command Default
Refer to the documentation for your platform for the default configuration register value. For many newer platforms, the default is 0x2102, which causes the router to boot from Flash memory and the Break key to be ignored.
Command Modes
Global configuration
Command History
Usage Guidelines
This command applies only to platforms that use a software configuration register.
The lowest four bits of the configuration register (bits 3, 2, 1, and 0) form the boot field. The boot field determines if the router boots manually, from ROM, or from Flash or the network.
To change the boot field value and leave all other bits set to their default values, follow these guidelines:
•
•
•
For more information about the configuration register bit settings and default filenames, refer to the appropriate router hardware installation guide.
Note
Examples
In the following example, the configuration register is set to boot the system image from Flash memory:
config-register 0x2102Related Commands
configure confirm
To confirm replacement of the current running configuration with a saved Cisco IOS configuration file, use the configure confirm command in privileged EXEC mode.
configure confirm
Syntax Description
This command has no arguments or keywords.
Command Modes
Privileged EXEC (#)
Command History
Usage Guidelines
The configure confirm command is used only if the time seconds keyword and argument of the configure replace command are specified. If the configure confirm command is not entered within the specified time limit, the configuration replace operation is automatically reversed (in other words, the current running configuration file is restored to the configuration state that existed prior to entering the configure replace command).
Examples
The following example shows the use of the configure replace command with the time seconds keyword and argument. You must enter the configure confirm command within the specified time limit to confirm replacement of the current running configuration file:
Router# configure replace nvram:startup-config time 120This will apply all necessary additions and deletionsto replace the current running configuration with thecontents of the specified configuration file, which isassumed to be a complete configuration, not a partialconfiguration. Enter Y if you are sure you want to proceed. ? [no]: YTotal number of passes: 1Rollback DoneRouter# configure confirmRelated Commands
configure issu set rollback timer
To configure the rollback timer value, use the configure issu set rollback timer command in global configuration mode.
configure issu set rollback timer seconds
Syntax Description
seconds
The rollback timer value, in seconds. The valid timer value range is from 0 to 7200 seconds (two hours). A value of 0 seconds disables the rollback timer.
Command Default
Rollback timer value is 45 minutes.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
Use the configure issue set rollback timer command to configure the rollback timer value. Note that you can enable this command only when the Route Processors (RPs) are in the init state.
Examples
The following example sets the rollback timer value to 3600 seconds, or 1 hour:
Router(config)# configure issu set rollback timer 3600Related Commands
configure replace
To replace the current running configuration with a saved Cisco IOS configuration file, use the configure replace command in privileged EXEC mode.
configure replace target-url [nolock] [list] [force] [ignorecase] [revert trigger [error] [timer minutes] | time minutes]
Syntax Description
Command Modes
Privileged EXEC (#)
Command History
Usage Guidelines
When configuring more than one keyword option, the following rules apply:
•
•
If the current running configuration is replaced with a saved Cisco IOS configuration file that contains commands unaccepted by the Cisco IOS software parser, an error message is displayed listing the commands that were unaccepted. The total number of passes performed in the configuration replace operation is also displayed.
Note
The running configuration lock is automatically cleared at the end of the configuration replace operation. It is not expected that you should need to clear the lock manually during the replace operation, but as a protection against any unforeseen circumstances, you can manually clear the lock using the clear configuration lock command. You can also display any locks that may be currently applied to the running configuration using the show configuration lock command.
Examples
This section contains the following examples:
•
•
•
•
Replacing the Current Running Configuration with a Saved Cisco IOS Configuration File
The following example shows how to replace the current running configuration with a saved Cisco IOS configuration file named disk0:myconfig. Note that the configure replace command interactively prompts you to confirm the operation.
Router# configure replace disk0:myconfigThis will apply all necessary additions and deletionsto replace the current running configuration with thecontents of the specified configuration file, which isassumed to be a complete configuration, not a partialconfiguration. Enter Y if you are sure you want to proceed. ? [no]: YTotal number of passes: 1Rollback DoneIn the following example, the list keyword is specified to display the command lines that were applied during the configuration replace operation:
Router# configure replace disk0:myconfig listThis will apply all necessary additions and deletionsto replace the current running configuration with thecontents of the specified configuration file, which isassumed to be a complete configuration, not a partialconfiguration. Enter Y if you are sure you want to proceed. ? [no]: Y!Pass 1!List of Commands:no snmp-server community public rosnmp-server community mystring roendTotal number of passes: 1Rollback DoneReverting to the Startup Configuration File
The following example shows how to revert to the Cisco IOS startup configuration file. This example also shows the use of the optional force keyword to override the interactive user prompt.
Router# configure replace nvram:startup-config forceTotal number of passes: 1Rollback DonePerforming a Configuration Replace Operation with the configure confirm Command
The following example shows the use of the configure replace command with the time seconds keyword and argument. You must enter the configure confirm command within the specified time limit to confirm replacement of the current running configuration file. If the configure confirm command is not entered within the specified time limit, the configuration replace operation is automatically reversed (in other words, the current running configuration file is restored to the configuration state that existed prior to entering the configure replace command).
Router# configure replace nvram:startup-config time 120This will apply all necessary additions and deletionsto replace the current running configuration with thecontents of the specified configuration file, which isassumed to be a complete configuration, not a partialconfiguration. Enter Y if you are sure you want to proceed. ? [no]: YTotal number of passes: 1Rollback DoneRouter# configure confirmPerforming a Configuration Rollback Operation
The following example shows how to make changes to the current running configuration and then roll back the changes. As part of the configuration rollback operation, you must save the current running configuration before making changes to the file. In this example, the archive config command is used to save the current running configuration. Note that the generated output of the configure replace command indicates that only one pass was performed to complete the rollback operation.
Note
You first save the current running configuration in the configuration archive as follows:
Router# archive configYou then enter configuration changes as shown in the following example:
Router# configure terminalRouter(config)# user netops2 password rainRouter(config)# user netops3 password snowRouter(config)# exitAfter making changes to the running configuration file, you might want to roll back these changes and revert to the configuration that existed before the changes were made. The show archive command is used to verify the version of the configuration to be used as a target file. The configure replace command is then used to revert to the target configuration file as shown in the following example:
Router# show archiveThere are currently 1 archive configurations saved.The next archive file will be named disk0:myconfig-2Archive # Name01 disk0:myconfig-1 <- Most Recent2345678910Router# configure replace disk0:myconfig-1Total number of passes: 1Rollback DoneRelated Commands
