checkpoint

To take a snapshot of the current running configuration and store the snapshot in the file system in an ASCII format, use the checkpoint command.

checkpoint [checkpoint-name [description descp-text [...description descp-text]] | description descp-text | file {bootflash: | volatile:}[//server][directory/][filename]]

no checkpoint [checkpoint-name | description descp-text | file {bootflash: | volatile:}[//server][directory/][filename]]

Syntax Description

checkpoint-name

(Optional) Checkpoint name. The name can be a maximum of 32 characters.

description descp-text

(Optional) Specifies a description for the given checkpoint. The text can be a maximum of 80 characters and can contain spaces.

file

(Optional) Specifies that a file be created to store the configuration rollback checkpoint.

bootflash:

Specifies the bootflash local writable storage file system.

volatile:

Specifies the volatile local writable storage file system.

//server

(Optional) Name of the server. Valid values are ///, //module-1/, //sup-1/, //sup-active/, or //sup-local/. The double slash (//) is required.

directory/

(Optional) Name of a directory. The directory name is case sensitive.

filename

(Optional) Name of the checkpoint configuration file. The filename is case sensitive.



Note There can be no spaces in the filesystem://server/directory/filename string. Individual elements of this string are separated by colons (:) and slashes (/).


Command Default

Automatically generates checkpoint name (user-checkpoint-number).

Command Modes

EXEC mode

Command History

Release
Modification

5.0(2)N1(1)

This command was introduced.


Usage Guidelines

Checkpoints are local to a switch. When you create a checkpoint, a snapshot of the current running configuration is stored in a checkpoint file. If you do not provide a checkpoint name, Cisco NX-OS sets the checkpoint name to user-checkpoint-number, where the number is from 1 to 10.

If Fibre Channel over Ethernet (FCoE) is enabled on the switch, you cannot restore the active configuration to the checkpoint state. The following error message appears when you create a checkpoint on a FCoE-enabled switch:

switch# checkpoint chkpoint-1 
ERROR: ascii-cfg: FCOE is enabled. Disbaling rollback module (err_id 0x405F004C)
switch#

On a switch that has FCoE disabled, you see the following message when you create the checkpoint:

switch# checkpoint chkpoint-1 
...Done
switch#

You can create up to ten checkpoints of your configuration per switch. When the number of checkpoints reaches the maximum limit, the oldest entry is removed.

You cannot apply the checkpoint file of one switch into another switch. You cannot start a checkpoint filename with the word system.

The checkpoint files are stored as text files that you cannot directly access or modify. When a checkpoint is cleared from the system, the associated checkpoint configuration file is deleted.

Examples

This example shows how to create a checkpoint:

switch# checkpoint 
...
user-checkpoint-4 created Successfully

Done
switch#

This example shows how to create a checkpoint, named chkpnt-1, and define its purpose:

switch# checkpoint chkpnt-1 description Checkpoint to save current configuration, Sep 9 10:02 A.M. 
switch# 

This example shows how to create a checkpoint configuration file named chkpnt_configSep9-1.txt in the bootflash storage system:

switch# checkpoint file bootflash:///chkpnt_configSep9-1.txt 
switch# 

This example shows how to delete a checkpoint named chkpnt-1:

switch# no checkpoint chkpnt-1 
switch# 

Related Commands

Command
Description

clear checkpoint

Clears the checkpoints on the switch.

rollback

Rolls back the switch to any of the saved checkpoints.

show checkpoint all

Displays all checkpoints configured in the switch.

show checkpoint summary

Displays a summary of all checkpoints configured in the switch.

show checkpoint summary user

Displays all checkpoints created by an user.

show checkpoint system

Displays all checkpoints that were automatically created in the system.