Introduction
This document describes the setup requirements for Backup
and Restore
features in CUCM from the Graphic User Interface (GUI)
.
Prerequisites
Requirements
Cisco recommends knowledge of these topics:
Cisco Unified Communications Manager
Secure File Transfer Protocol (SFTP)
Components Used
The information in this document is based on these software versions:
Cisco Unified Communications Manager
version 10.5.2.15900-8
The information in this document was created from the devices in a specific lab environment. All of the devices used in this document started with a cleared (default) configuration. If your network is live, ensure that you understand the potential impact of any command.
Background Information
The Disaster Recovery System (DRS)
, which can be invoked from CUCM Administration, provides full data backup and restore capabilities for all servers in the cluster. The DRS enables regularly scheduled automatic or user-invoked data backups.
DRS restores its own parameters (backup device and schedule parameters) as part of the platform backup/restore. DRS backs up and restores the drfDevice.xml
and drfSchedule.xml
files. When the server is restored with these files, there is no need to reconfigure DRS backup device and schedule.
The Disaster Recovery System
includes these capabilities:
- A user interface in order to perform backup and restore tasks
- A distributed system architecture with backup and restore functions
- Scheduled backups
- Archive backups to a physical tape drive or remote SFTP server
The Disaster Recovery System
contains two key functions, Master Agent (MA)
and Local Agent (LA)
.
The Master Agent
coordinates backup and restore activity with Local Agents
. The system automatically activates the Master Agent
and Local Agent
on all nodes in the cluster.
CUCM cluster (this involves the CUCM nodes and the Cisco Instant Messaging & Presence (IM&P)
servers) must fulfil these requirements:
Port 22
open in order to establish the communication with SFTP server
-
Validated that the IPsec
and Tomcat
certificates are not expired.
In order to verify the validity of the certificates, navigate to Cisco Unified OS Administration > Security > Certificate Management
Note: In order to regenerate ipsec and Tomcat certificates, use the Procedure to regenerate certificates in CUCM
- Ensure that the Database Replication is setup completed and does not show any errors or mismatches from the CUCM Publisher and the IM&P Publisher servers.
SFTP server settings must cover these requirements:
- Login credentials are available
- It must be reachable from the CUCM server
- Files are included in the path selected when a restore is performed
Configure
Backup
The Disaster Recovery System
performs a cluster-level backup, which means that it collects backups for all servers in a CUCM cluster to a central location and archives the backup data to physical storage device.
Step 1. To create backup devices on which data is saved; navigate to Disaster Recovery System > Backup > Backup Device
.
Step 2. Select Add New
; define a Backup Device Name
and enter the SFTP values. Save
![Configure Backup and Restore from GUI - Configure Backup device](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-00.png)
Step 3. Create and edit backup schedules in order to back up data. Navigate to Backup > Scheduler
.
Step 4. Define a Schedule Name
. Select the Devicee Name
and check the Features
based on your scenario.
![Configure Backup and Restore from GUI - Scheduler configuration](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-01.png)
Step 5. Configure a scheduled backup based on your scenario.
![Configure Backup and Restore from GUI - Frequency config](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-02.png)
Step 6. Select Save
and notice the warning as shown in the image. Select OK
in order to move forward.
![Configure Backup and Restore from GUI - Pop-up message](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-03.png)
Step 7. Once that a Backup Schedule
is created, select Enable Schedule
.
![Configure Backup and Restore from GUI - Scheduler disabled](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-04.png)
Step 8. Wait until the status is changed to Enabled
.
![Configure Backup and Restore from GUI - Scheduler enabled](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-05.png)
Step 9. If a Manual backup is required, navigate to Backup > Manual Backup
.
Step 10. Select the Device Name
and check the Features
based on your scenario.
![Configure Backup and Restore from GUI - Manual backup](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-06.png)
Step 11. Select Start Backup
and operation is displayed in progress.
![Configure Backup and Restore from GUI - backup status](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-07.png)
Step 12. When the manual backup is completed, the completion message is displayed.
![Configure Backup and Restore from GUI - Backup completed](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-08.png)
Step 13. To estimate the size of backup tar file that SFTP device uses, select Estimate Size
.
![Configure Backup and Restore from GUI - Select device and feature](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-09.png)
Step 14. Estimate size is displayed as shown in the image
![Configure Backup and Restore from GUI - Estimated size](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-10.png)
Note: Estimate Size function is calculated based on previous successful backups and can vary in case configuration has been changed since the last backup.
Step 15. To check the Status of the Backup while a backup runs, navigate to Backup > Backup Status
.
![Configure Backup and Restore from GUI - Backup status page](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-11.png)
Step 16. To consult the backup procedures performed in the system, navigate to Backup > History
.
![Configure Backup and Restore from GUI - Backup history](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-12.png)
Restore
DRS restores mainly drfDevice.xml
and drfSchedule.xml
files. However, when a system data restoration is performed, you can choose which nodes in the cluster require to get restored.
Note: Backup Device (SFTP server) must be already configured in order to retrieve the tar files from it and restore the system with these files.
Step 1. Navigate to Disaster Recovery System > Restore > Restore Wizard
.
Step 2. Select the Device Name
which stores the backup file to use for the restore. Select Next
.
![Configure Backup and Restore from GUI - Restore Step1](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-13.png)
Step 3. Select the Backup File
from the displayed list of available files as shown in the image. Selected backup file must include the information to restore.
![Configure Backup and Restore from GUI - backup list](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-14.png)
Step 4. From the list of available features, select the feature to restore.
![Configure Backup and Restore from GUI - Type of restore](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-15.png)
Step 5. Select the nodes in which to apply the restore.
![Configure Backup and Restore from GUI - Step 4 restore](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-16.png)
Note: One-Step Restore allows the restoration of the entire cluster if the Publisher has already been rebuilt or fresh installed. This option is visible ONLY if the backup file selected for restore is the backup file of the cluster and the features chosen for restore includes the feature(s) that is registered with both publisher and subscriber nodes.
Step 6. Select Restore
to start the process and Restore status is updated.
![Configure Backup and Restore from GUI - Restore progress](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-17.png)
Step 7. To verify the status of the restore, navigate to Restore > Current Status
.
![Configure Backup and Restore from GUI - Restore in progress Sub](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-18.png)
Step 8. Restore Status
changes to SUCCESS
when it is complete.
![Configure Backup and Restore from GUI - Restore completed](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-19.png)
Step 9. For the changes to take effect, the system must be restarted.
![Configure Backup and Restore from GUI - CLI Reboot server](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-20.png)
Tip: Use a supported procedure in order to restart the system Shut Down or Restart the System
Step 10. In order to consult the restore procedures performed in the system, navigate to Restore > History
.
![Configure Backup and Restore from GUI - Restore history](/c/dam/en/us/support/docs/unified-communications/unified-communications-manager-callmanager/214626-configure-backup-and-restore-from-gui-in-21.png)
Troubleshoot
This section provides information to troubleshoot your configuration.
CUCM cluster (this involves the CUCM nodes and the Cisco Instant Messaging & Presence (IM&P) servers) must fulfil these requirements:
Port 22
open in order to establish the communication with SFTP server
-
Validated that the IPsec
and Tomcat
certificates are not expired.
In order to verify the validity of the certificates, navigate to Cisco Unified OS Administration > Security > Certificate Management
Note: To regenerate ipsec and Tomcat certificates, use the Procedure to regenerate certificates in CUCM
- Ensure that the Database Replication is setup completed and does not show any errors or mismatches from the CUCM Publisher and the IM&P Publisher servers.
- Validate reachability between the servers and the SFTP Server.
- Validate that all the servers in the cluster are authenticated with the command
show network cluster
.
When Backup or Restore failures are reported and further assistance is required, this set of logs must be collected and shared with Technical Assistance Center (TAC):
- Cisco DRF Master Logs
- Cisco DRF Local Logs
- Failure logs from the DRF Current Status page
- Timestamp of the issue
Related Information