Cisco IOS Configuration Fundamentals Configuration Guide, Release 12.2SR

Configuration Replace and Configuration Rollback

The Configuration Replace and Configuration Rollback feature provides the capability to replace the current running configuration with any saved Cisco IOS configuration file. This functionality can be used to revert to a previous configuration state, effectively rolling back any configuration changes that were made since that configuration file was saved.

Finding Feature Information

Your software release may not support all the features documented in this module. For the latest feature information and caveats, see the release notes for your platform and software release. To find information about the features documented in this module, and to see a list of the releases in which each feature is supported, see the "Feature Information for Configuration Replace and Configuration Rollback" section.

Use Cisco Feature Navigator to find information about platform support and Cisco IOS and Catalyst OS software image support. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An account on Cisco.com is not required

Contents

•Prerequisites for Configuration Replace and Configuration Rollback

•Restrictions for Configuration Replace and Configuration Rollback

•Information About Configuration Replace and Configuration Rollback

•How to Use Configuration Replace and Configuration Rollback

•Configuration Examples for Configuration Replace and Configuration Rollback

•Additional References

•Command Reference, page 17

•Feature Information for Configuration Replace and Configuration Rollback

Prerequisites for Configuration Replace and Configuration Rollback

•The format of the configuration files used as input by the Configuration Replace and Configuration Rollback feature must comply with standard Cisco IOS software configuration file indentation rules as follows:

–Start all commands on a new line with no indentation, unless the command is within a configuration submode.

–Indent commands within a first-level configuration submode one space.

–Indent commands within a second-level configuration submode two spaces.

–Indent commands within subsequent submodes accordingly.

These indentation rules describe how Cisco IOS software creates configuration files for such Cisco IOS commands as show running-config or copy running-config destination-url. Any configuration file generated on a Cisco IOS device complies with these rules.

•Free memory larger than the combined size of the two configuration files (the current running configuration and the saved replacement configuration) is required.

Restrictions for Configuration Replace and Configuration Rollback

•If the router does not have free memory larger than the combined size of the two configuration files (the current running configuration and the saved replacement configuration), the configuration replace operation is not performed.

•Certain Cisco IOS configuration commands such as those pertaining to physical components of a networking device (for example, physical interfaces) cannot be added or removed from the running configuration. To illustrate, a configuration replace operation cannot remove the interface ethernet 0 command line from the current running configuration if that interface is physically present on the device. Similarly, the interface ethernet 1 command line cannot be added to the running configuration if no such interface is physically present on the device. A configuration replace operation that attempts to perform these types of changes results in error messages indicating that these specific command lines failed.

•In very rare cases, certain Cisco IOS configuration commands cannot be removed from the Cisco IOS running configuration without reloading the router. A configuration replace operation that attempts to remove this type of command results in error messages indicating that these specific command lines failed.

Information About Configuration Replace and Configuration Rollback

To use the Configuration Replace and Configuration Rollback feature, you should understand the following concepts:

•Configuration Archive

•Configuration Replace

•Configuration Rollback

•Benefits of Configuration Replace and Configuration Rollback

Configuration Archive

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 replacement 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 timestamp) 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 are 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.

The Cisco IOS configuration archive, in which the configuration files are stored and available for use with the configure replace command, can be located on the following file systems:

•If your platform has disk0—disk0:, disk1:, ftp:, pram:, rcp:, slavedisk0:, slavedisk1:, or tftp:

•If your platform does not have disk0—ftp:, http:, pram:, rcp:, or tftp:

Configuration Replace

The configure replace command provides the capability to replace the current running configuration with any saved Cisco IOS configuration file. This functionality can be used to revert to a previous configuration state, effectively rolling back any configuration changes that were made since the previous configuration state was saved.

When using the configure replace command, you must specify a saved Cisco IOS configuration as the replacement configuration file for the current running configuration. The replacement file must be a complete configuration generated by a Cisco IOS device (for example, a configuration generated by the copy running-config destination-url command), or, if generated externally, the replacement file must comply with the format of files generated by Cisco IOS devices. When the configure replace command is entered, the current running configuration is compared with the specified replacement configuration and a set of diffs is generated. The algorithm used to compare the two files is the same as that employed by the show archive config differences command. The resulting diffs are then applied by the Cisco IOS parser to achieve the replacement configuration state. Only the diffs are applied, avoiding potential service disruption from reapplying configuration commands that already exist in the current running configuration. This algorithm effectively handles configuration changes to order-dependent commands (such as access lists) through a multiple pass process. Under normal circumstances, no more than three passes are needed to complete a configuration replace operation, and a limit of five passes is performed to preclude any looping behavior.

The Cisco IOS copy source-url running-config command is often used to copy a stored Cisco IOS configuration file to the running configuration. When using the copy source-url running-config command as an alternative to the configure replace target-url command, the following major differences should be noted:

•The copy source-url running-config command is a merge operation and preserves all the commands from both the source file and the current running configuration. This command does not remove commands from the current running configuration that are not present in the source file. In contrast, the configure replace target-url command removes commands from the current running configuration that are not present in the replacement file and adds commands to the current running configuration that need to be added.

•The copy source-url running-config command applies every command in the source file, whether or not the command is already present in the current running configuration. This algorithm is inefficient and, in some cases, can result in service outages. In contrast, the configure replace target-url command only applies the commands that need to be applied—no existing commands in the current running configuration are reapplied.

•A partial configuration file may be used as the source file for the copy source-url running-config command, whereas a complete Cisco IOS configuration file must be used as the replacement file for the configure replace target-url command.

Note In Cisco IOS Release 12.2(25)S and 12.3(14)T, a locking feature for the configuration replace operation was introduced. When the configure replace command is used, the running configuration file is locked by default for the duration of the configuration replace operation. This locking mechanism prevents other users from changing the running configuration while the replacement operation is taking place, which might otherwise cause the replacement operation to terminate unsuccessfully. You can disable the locking of the running configuration by using the nolock keyword when issuing the configure replace command.

The running configuration lock is automatically cleared at the end of the configuration replace operation. You can display any locks that may be currently applied to the running configuration using the show configuration lock command.

Configuration Rollback

The concept of rollback comes from the transactional processing model common to database operations. In a database transaction, you might make a set of changes to a given database table. You then must choose whether to commit the changes (apply the changes permanently) or to roll back the changes (discard the changes and revert to the previous state of the table). In this context, rollback means that a journal file containing a log of the changes is discarded, and no changes are applied. The result of the rollback operation is to revert to the previous state, before any changes were applied.

The configure replace command allows you to revert to a previous configuration state, effectively rolling back changes that were made since the previous configuration state was saved. Instead of basing the rollback operation on a specific set of changes that were applied, the Cisco IOS configuration rollback capability uses the concept of reverting to a specific configuration state based on a saved Cisco IOS configuration file. This concept is similar to the database idea of saving a checkpoint (a saved version of the database) to preserve a specific state.

If the configuration rollback capability is desired, you must save the Cisco IOS running configuration before making any configuration changes. Then, after entering configuration changes, you can use that saved configuration file to roll back the changes (using the configure replace target-url command). Furthermore, since you can specify any saved Cisco IOS configuration file as the replacement configuration, you are not limited to a fixed number of rollbacks, as is the case in some rollback models based on a journal file.

Configuration Rollback Confirmed Change

The Configuration Rollback Confirmed Change feature enables an added criteria of a confirmation to configuration changes. This functionality enables a rollback to occur if a confirmation of the requested changes is not received in a configured time frame. Command failures can also be configured to trigger a configuration rollback.

The following steps outline how this process is achieved:

1. When entering configuration mode, this new option allows you to request confirmation (a confirmation time limit must be supplied) of the configuration changes.

2. After exiting configuration mode, you must enter the confirmation command. If no confirmation is entered within the requested time limit, the configuration will revert to its previous state.

Benefits of Configuration Replace and Configuration Rollback

•Allows you to revert to a previous configuration state, effectively rolling back configuration changes.

•Allows you to replace the current running configuration file with the startup configuration file without having to reload the router or manually undo CLI changes to the running configuration file, therefore reducing system downtime.

•Allows you to revert to any saved Cisco IOS configuration state.

•Simplifies configuration changes by allowing you to apply a complete configuration file to the router, where only the commands that need to be added or removed are affected.

•When using the configure replace command as an alternative to the copy source-url running-config command, increases efficiency and prevents risk of service outages by not reapplying existing commands in the current running configuration.

How to Use Configuration Replace and Configuration Rollback

This section contains the following procedures:

•Creating a Configuration Archive (optional)

•Performing a Configuration Replace or Configuration Rollback Operation (required)

•Monitoring and Troubleshooting the Configuration Replace and Configuration Rollback Feature (optional)

Creating a Configuration Archive

No prerequisite configuration is needed to use the configure replace command. Using the configure replace command in conjunction with the Cisco IOS configuration archive and the archive config command is optional but offers significant benefit for configuration rollback scenarios. Before using the archive config command, the configuration archive must be configured. Perform this task to configure the characteristics of the configuration archive.

SUMMARY STEPS

1. enable

2. configure terminal

3. archive

4. path url

5. maximum number

6. time-period minutes

7. end

8. archive config

DETAILED STEPS

Performing a Configuration Replace or Configuration Rollback Operation

Perform this task to replace the current running configuration file with a saved Cisco IOS configuration file.

Note You must create a configuration archive before performing this procedure. See Creating a Configuration Archive for detailed steps. The following procedure details how to return to that archived configuration in the event of a problem with the current running configuration.

SUMMARY STEPS

1. enable

2. configure replace target-url [nolock] [list] [force] [ignorecase] [revert trigger [error] [timer minutes] | time minutes]

3. configure revert {now | timer {minutes | idle minutes}}

4. configure confirm

5. exit

DETAILED STEPS

Monitoring and Troubleshooting the Configuration Replace and Configuration Rollback Feature

Perform this task to monitor and troubleshoot the Configuration Replace and Configuration Rollback feature.

SUMMARY STEPS

1. enable

2. show archive

3. debug archive versioning

4. debug archive config timestamp

5. exit

DETAILED STEPS

Step 1 enable

Use this command to enable privileged EXEC mode. Enter your password if prompted. For example:

Router> enable

Router#

Step 2 show archive

Use this command to display information about the files saved in the Cisco IOS configuration archive. For example:

Router# show archive

There are currently 1 archive configurations saved.

The next archive file will be named disk0:myconfig-2

 Archive #  Name

   0 

   1       disk0:myconfig-1 <- Most Recent

   2 

   3 

   4 

   5 

   6 

   7 

   8 

   9 

   10 

   11 

   12 

   13 

   14 

The following is sample output from the show archive command after several archive files of the running configuration have been saved. In this example, the maximum number of archive files to be saved is set to three.

Router# show archive

There are currently 3 archive configurations saved.

The next archive file will be named disk0:myconfig-8

 Archive #  Name

   0        

   1       :Deleted

   2       :Deleted

   3       :Deleted

   4       :Deleted

   5       disk0:myconfig-5

   6       disk0:myconfig-6

   7       disk0:myconfig-7 <- Most Recent

   8

   9

   10

   11

   12

   13

   14

Step 3 debug archive versioning

Use this command to enable debugging of the Cisco IOS configuration archive activities to help monitor and troubleshoot configuration replace and rollback. For example:

Router# debug archive versioning

Jan  9 06:46:28.419:backup_running_config

Jan  9 06:46:28.419:Current = 7

Jan  9 06:46:28.443:Writing backup file disk0:myconfig-7

Jan  9 06:46:29.547: backup worked

Step 4 debug archive config timestamp

Use this command to enable debugging of the processing time for each integral step of a configuration replace operation and the size of the configuration files being handled. For example:

Router# debug archive config timestamp

Router# configure replace disk0:myconfig force

Timing Debug Statistics for IOS Config Replace operation:

       Time to read file slot0:sample_2.cfg = 0 msec (0 sec)

       Number of lines read:55

       Size of file        :1054

Starting Pass 1

       Time to read file system:running-config = 0 msec (0 sec)

       Number of lines read:93

       Size of file        :2539

       Time taken for positive rollback pass = 320 msec (0 sec)

       Time taken for negative rollback pass = 0 msec (0 sec)

       Time taken for negative incremental diffs pass = 59 msec (0 sec)

       Time taken by PI to apply changes = 0 msec (0 sec)

       Time taken for Pass 1 = 380 msec (0 sec)

Starting Pass 2

       Time to read file system:running-config = 0 msec (0 sec)

       Number of lines read:55

       Size of file        :1054

       Time taken for positive rollback pass = 0 msec (0 sec)

       Time taken for negative rollback pass = 0 msec (0 sec)

       Time taken for Pass 2 = 0 msec (0 sec)

Total number of passes:1

Rollback Done

Step 5 exit

Use this command to exit to user EXEC mode. For example:

Router# exit

Router>

Configuration Examples for Configuration Replace and Configuration Rollback

This section provides the following configuration examples:

•Creating a Configuration Archive: Example

•Replacing the Current Running Configuration with a Saved Cisco IOS Configuration File: Example

•Reverting to the Startup Configuration File: Example

•Performing a Configuration Replace Operation with the configure confirm Command: Example

•Performing a Configuration Rollback Operation: Example

Creating a Configuration Archive: Example

The following example shows how to perform the initial configuration of the Cisco IOS configuration archive. In this example, disk0:myconfig is specified as the location and filename prefix for the files in the configuration archive and a value of 10 is set as the maximum number of archive files to be saved.

configure terminal

!

archive

 path disk0:myconfig

 maximum 10

 end

Replacing the Current Running Configuration with a Saved Cisco IOS Configuration File: Example

The following example shows how to replace the current running configuration with a saved Cisco IOS configuration file named disk0:myconfig. The configure replace command interactively prompts you to confirm the operation.

Router# configure replace disk0:myconfig

This will apply all necessary additions and deletions

to replace the current running configuration with the

contents of the specified configuration file, which is

assumed to be a complete configuration, not a partial

configuration. Enter Y if you are sure you want to proceed. ? [no]: Y

Total number of passes: 1

Rollback Done

In the following example, the list keyword is specified in order to display the command lines that were applied during the configuration replace operation:

Router# configure replace disk0:myconfig list

This will apply all necessary additions and deletions

to replace the current running configuration with the

contents of the specified configuration file, which is

assumed to be a complete configuration, not a partial

configuration. Enter Y if you are sure you want to proceed. ? [no]: Y

!Pass 1

!List of Commands:

no snmp-server community public ro

snmp-server community mystring ro                                                                  

end

Total number of passes: 1

Rollback Done

Reverting to the Startup Configuration File: Example

The following example shows how to revert to the Cisco IOS startup configuration file using the configure replace command. This example also shows the use of the optional force keyword to override the interactive user prompt.

Router# configure replace nvram:startup-config force

Total number of passes: 1

Rollback Done

Performing a Configuration Replace Operation with the configure confirm Command: Example

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 back to the configuration state that existed prior to entering the configure replace command).

Router# configure replace nvram:startup-config time 120

This will apply all necessary additions and deletions

to replace the current running configuration with the

contents of the specified configuration file, which is

assumed to be a complete configuration, not a partial

configuration. Enter Y if you are sure you want to proceed. ? [no]: Y

Total number of passes: 1

Rollback Done

Router# configure confirm

The following example shows the use of the configure revert command with the time keyword. You must enter the configure revert command to cancel the timed rollback and trigger the rollback immediately, or to reset parameters for the timed rollback.

Router# configure revert timer 100

Performing a Configuration Rollback Operation: Example

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. The generated output of the configure replace command indicates that only one pass was performed to complete the rollback operation.

Note 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.

You first save the current running configuration in the configuration archive as follows:

archive config

You then enter configuration changes as shown in the following example:

configure terminal

!

user netops2 password rain

user netops3 password snow

exit

After having made changes to the running configuration file, assume you now 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 replacement file. The configure replace command is then used to revert to the replacement configuration file as shown in the following example:

Router# show archive

There are currently 1 archive configurations saved.

The next archive file will be named disk0:myconfig-2

 Archive #  Name

   0

   1       disk0:myconfig-1 <- Most Recent

   2

   3

   4

   5

   6

   7

   8

   9

   10

Router# configure replace disk0:myconfig-1

Total number of passes: 1

Rollback Done

Additional References

The following sections provide references related to the Configuration Replace and Configuration Rollback feature.

Related Documents

Standards

MIBs

RFCs

Technical Assistance

Feature Information for Configuration Replace and Configuration Rollback

Table 1 lists the release history for this feature. Not all commands may be available in your Cisco IOS software release. For release information about a specific command, see the command reference documentation.

Cisco IOS software images are specific to a Cisco IOS software release, a feature set, and a platform. Use Cisco Feature Navigator to find information about platform support and Cisco IOS software image support. Access Cisco Feature Navigator at http://www.cisco.com/go/cfn. An account on Cisco.com is not required.

Note Table 1 lists only the Cisco IOS software release that introduced support for a given feature in a given Cisco IOS software release. Unless noted otherwise, subsequent releases of that Cisco IOS software release also support that feature.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)

Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.

© 2004-2010 Cisco Systems, Inc. All rights reserved.