Configuration Guide for Cisco Optical Site Manager, IOS XR Release 26.x.x

PDF

Configuration Guide for Cisco Optical Site Manager, IOS XR Release 26.x.x

Database backup and restore

Updated: October 14, 2026

Want to summarize with AI?

Log in

This section explains database backup and restore in Cisco Optical Site Manager. Use it to understand the feature behavior, requirements, and operating context before configuration or verification.

Cisco Optical Site Manager allows the backup of its own database as well as the databases of the devices it manages, ensuring that data can be restored in case of disaster. Backup are executed and stored within the device on which Cisco Optical Site Manager is installed and are accessible through the Cisco Optical Site Manager web user interface.

Backup and download database

Use this task to backup and download database.

Backing up the Cisco Optical Site Manager database ensures data integrity and availability in case of unexpected failures, such as hardware malfunctions or software corruption. By maintaining regular backup, administrators can quickly restore the system to its last known good state, minimizing downtime and operational disruptions.

Before you begin

Log into Cisco Optical Site Manager

Follow these steps to backup and download database.

Procedure

  1. Click Database in the left panel.

  2. Click the Backup button.

    A confirmation dialog box appears.

  3. (Optional) Enable the Stop on Error toggle button to stop the backup process if any of the selected devices for backup are disconnected, unresponsive, or locked.

  4. Click Yes to start the backup.

    The Logs Summary section displays the backedup components, their status, and timestamps.

    The DBBACKUP-IN-PROGRESS alarm is triggered and can be viewed in the Alarms tab of the Fault Monitoring menu.

  5. Click the backup file name under Back Up Information to download entire backup as a ZIP file on your local system.

    Note

    If database backup download fails in a browser, the files can still be downloaded by retrying or using an alternate browser.

The backup and download database task is complete.

Restore database

Use this task to restore database.

When performing a restore operation, you restore Cisco Optical Site Manager and its managed devices database to the state it was in at the backup time. You can choose to restore only the Cisco Optical Site Manager database, only one or multiple managed devices database, or both simultaneously.

Note

Database restoration is supported only if the device node names remain unchanged after the database is downloaded. If the node names are changed post-download, the restore operation will not succeed.

Note

Cisco Optical Site Manager database backup does not include customer-sensitive private information, such as private keys and certificates.

  • If Cisco Optical Site Manager uses self-signed certificates, the certificates are regenerated automatically after the database is restored.

  • If Cisco Optical Site Manager uses customer-provided certificates, these certificates are not reinstalled during a database restore. If the certificates are missing after the restore, you will need to reinstall them. This can be done by deactivating and then activating the system, removing and recreating the container, or performing a fresh reinstallation of the same image. After these steps, reinstall the customer-provided certificates from the local certificate archive.

Use this task to restore the database of either the Cisco Optical Site Manager or the devices it manages.

Before you begin

Log into Cisco Optical Site Manager

Follow these steps to restore database.

Procedure

  1. Click Database in the left panel.

  2. Click the Restore current backup button.

    The Select what do you want to restore dialog box appears.

  3. Perform any of these tasks to restore the database:

    Note

    When restoring the Cisco Optical Site Manager or full database on the host device, the Cisco Optical Site Manager becomes temporarily unavailable.

    To restore

    click the Restore button

    only Cisco Optical Site Manager database,

    in the COSM section.

    only the managed devices database,

    in the Devices section after selecting the one or all check boxes corresponding to the devices for which you want to restore the data.

    both Cisco Optical Site Manager and the managed devices database,

    in the Full section.
    A confirmation dialog box appears.

  4. (Optional) Enable the Stop on Error toggle button to stop the restore process if a mismatch is detected.

    A mismatch can include a difference in the number of devices between backup and restore, or situations where any of the selected devices for restore are disconnected, unresponsive, or locked.

  5. Click Yes to start the restore process.

    The Logs Summary section displays the restored components, their status, and timestamps.

    The DBREST-IN-PROGRESS alarm is triggered and can be viewed in the Alarms tab of the Fault Monitoring menu.

The restore database task is complete.

Upload database

Use this task to upload database.

While multiple backups can be created, only the most recent backup is available for download and restoration. You may need to upload and restore your database in the following situations:

  • Reinstall Cisco Optical Site Manager: If you need to reinstall Cisco Optical Site Manager, uploading the backup file allows you to restore the data to its state prior to the re-installation.

  • Database Transfer Between Nodes: Copy the database from one device to another by backing up from the source device and uploading it on the destination device.

Use this task to upload the database from a downloaded backup ZIP file.

Before you begin

Log into Cisco Optical Site Manager

Follow these steps to upload database.

Procedure

  1. Click Database in the left panel.

  2. Click the Upload Backup button.

    The Upload DB Backup dialog box appears.

  3. Click Select Files to select a ZIP file.

    Note

    You can also drag and drop the backup ZIP file in the Upload DB Backup dialog box.

  4. Click Upload to upload the backup.

    The uploaded backup file is displayed under Back Up Information.

The upload database task is complete.