XOS Configuration Back-up and Restore Procedure

book

Article ID: 167915

calendar_today

Updated On:

Products

XOS

Issue/Introduction

This article describes how to save the XOS configuration and how to use the file or archive to restore the XOS configuration.This article describes how to save the XOS configuration and how to use the file or archive to restore the XOS configuration.

Cause

Goal:
To provide instructions for backing up and restoring an XOS configuration.

Resolution

Back-up/restore procedure - configuration only

Backing Up the Configuration

To back up your configuration, enter the following command from the CBS prompt:
CBS# copy running-config <filename>

The file will be saved in the home directory of the current user on the CPM.

Note: The user "admin" has a home directory "/tftpboot/.private/home/admin".

You can now ftp/scp the file from the chassis to a PC for safe keeping, or to move it to another X-Series chassis.

Note: If a periodic backup to a remote server is required, the backup procedure can be automated with a script and run from the external box against the chassis in regular intervals.

Restoring the Configuration
To restore a configuration from a previously saved file, use the following procedure:

Log in as user "admin", and copy the saved configuration file to the home directory '/tftpboot/.private/home/admin'.

After the file is copied, run the following command from the CBS prompt:
CBS# exec -echo prompt-on-error <filename>

Back-Up/restore procedure - entire system (XOS 9.6.0 +)

Backing Up the Configuration
On the XOS version 9.6.0 and later XOS releases, it is possible to use the archive system backup/restore command to back up and restore an overall system including the configuration.

To back up the system, enter the following command in the CBS prompt:
CBS# archive backup system [include-home]

All the applications must be stopped during the procedure. Press "Y"  to disable the VAP groups automatically within the next step:

During backup all the vap-group(s) will be disabled.
Do you want to continue? <Y or N> [Y]:


Depending on the configuration and application deployment, the process could take several minutes. When the backup procedure is done, the archive is stored in the following directory:

/tftpboot/archives/

Restoring the Configuration
To restore the system from a previously backed up archive, use the following procedure:
- Place the archive to the /tftpboot/archives/ directory.
- Verify the archive:
CBS# archive show system

Enter the following command in the CBS prompt to start the restore procedure:
CBS# archive restore system archive <archive_number>

During the restore procedure, the entire XOS configuration will be removed. To remove the configuration within the next step, press "Y":
Warning: The entire XOS configurations including all the VAP groups, home directories and CLI work flow scripts will be destroyed and restored from the specified archive.
Do you want to continue? <Y or N> [N]: y
 
Removing the Archive
To remove the archive when the system restore is finished, enter the following command in the CBS prompt:
CBS# archive delete system archive <archive_number>

Workaround

N/A