[an error occurred while processing this directive]

Cisco Unity Connection

Disaster Recovery System Administration Guide for Cisco Unity Connection Release 2.x

 Feedback

Table Of Contents

Disaster Recovery System Administration Guide for Cisco Unity Connection Release 2.x

What is the Disaster Recovery System?

Quick-Reference Tables for Backup and Restore Procedures

Backup Quick Reference

Restore Quick Reference

System Requirements

How to Access the Disaster Recovery System

Master Agent Duties and Activation

Duties That the Master Agent Performs

Local Agents

Duties That Local Agents Perform

Managing Backup Devices

Creating and Editing Backup Schedules

Enabling, Disabling, and Deleting Schedules

Starting a Manual Backup

Checking Backup Status

Checking the Status of the Current Backup Job

Restoring a Backup File

Viewing the Restore Status

Viewing the Backup and Restore History

Backup History

Restore History

Command Line Interface

Error Messages

Related Documentation

Obtaining Documentation, Obtaining Support, and Security Guidelines


Disaster Recovery System Administration Guide for Cisco Unity Connection Release 2.x


Revised August 26, 2008

This guide provides an overview of the Disaster Recovery System, describes how to use the Disaster Recovery System, and provides procedures for completing various backup-related tasks and restore-related tasks. This guide serves as a reference and procedural guide that is intended for users of Cisco Unified Communications Manager and other Cisco IP telephony applications.

This document includes the following topics:

What is the Disaster Recovery System?

Quick-Reference Tables for Backup and Restore Procedures

System Requirements

How to Access the Disaster Recovery System

Master Agent Duties and Activation

Local Agents

Managing Backup Devices

Creating and Editing Backup Schedules

Enabling, Disabling, and Deleting Schedules

Starting a Manual Backup

Checking Backup Status

Restoring a Backup File

Viewing the Restore Status

Viewing the Backup and Restore History

Command Line Interface

Error Messages

Related Documentation

Obtaining Documentation, Obtaining Support, and Security Guidelines

What is the Disaster Recovery System?

The Disaster Recovery System (DRS), which can be invoked from Cisco Unified Communications Manager Administration, provides full data backup and restore capabilities. The Disaster Recovery System allows you to perform regularly scheduled automatic or user-invoked data backups.

The Disaster Recovery System includes the following capabilities:

A user interface for performing backup and restore tasks.

A distributed system architecture for performing 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.

Quick-Reference Tables for Backup and Restore Procedures

The following tables provide a quick reference for the backup and restore procedures.

Backup Quick Reference

Table 1 provides a quick, high-level reference to the major steps, in chronological order, that you must perform to do a backup procedure by using the Disaster Recovery System.


Note The Disaster Recovery System does not migrate data from Windows to Linux or from Linux to Linux. A restore must run on the same product version as the backup. For information on data migration from a Windows-based platform to a Linux-based platform, refer to the Data Migration Assistant User Guide before following the steps in Table 1.


Table 1 Major Steps for Performing a Backup Procedure 

Action
Reference

Create backup devices on which to back up data.

"Managing Backup Devices" section

Create and edit backup schedules to back up data on a schedule.

"Creating and Editing Backup Schedules" section

Enable and disable backup schedules to back up data.

"Enabling, Disabling, and Deleting Schedules" section

Optionally, run a manual backup.

"Starting a Manual Backup" section

Check the Status of the Backup—While a backup is running, you can check the status of the current backup job.

"Checking Backup Status" section


Restore Quick Reference

Table 2 provides a quick, high-level reference to the major steps, in chronological order, that you must perform to do a restore procedure by using the Disaster Recovery System.

Table 2 Major Steps for Performing a Restore Procedure

Action
Reference

Choose Storage Location—You must first choose the storage location from which you want to restore a backup file.

"Restoring a Backup File" section

Choose the Backup File—From a list of available files, choose the backup file that you want to restore.

"Restoring a Backup File" section

Choose Features—From the list of available features, choose the features that you want to restore.

"Restoring a Backup File" section

Choose Nodes—If the feature was backed up from multiple nodes, you must choose the nodes that you want to restore.

"Restoring a Backup File" section

Check the Status of the Restore—While the restore process is running, you can check the status of the current restore job.

"Viewing the Restore Status" section


System Requirements

Revised August 26, 2008

Make sure that Cisco Unified Communications Manager is running

To back up data to a remote device on the network, you must have an SFTP server configured. The following SFTP servers are supported and recommended, but you may use any SFTP server:

Open SSH (for Unix systems)

Cygwin (refer to http://sshwindows.sourceforge.net/)

How to Access the Disaster Recovery System

To access the Disaster Recovery System, choose Disaster Recover System from the Navigation menu in the upper, right corner of Cisco Unified Communications Manager Administration window. Log in to the Disaster Recovery System by using the same Administrator username and password that you use for Cisco Unified Communications Operating System Administration.


Note You set the Administrator username and password during Cisco Unified Communications Manager installation, and you can change the Administrator password or set up a new Administrator account by using the Command Line Interface (CLI). Refer to theCisco Unified Communications Operating System Administration Guide for more information.


Master Agent Duties and Activation

The system automatically activates the Master Agent (MA) on the server.

Duties That the Master Agent Performs

The Master Agent (MA) performs the following duties:

The MA stores systemwide component registration information.

The MA maintains a complete set of scheduled tasks in the database. When it receives updates from the user interface, the MA sends executable tasks to the applicable Local Agents, as scheduled. (Local Agents execute immediate-backup tasks without delay.)

You access the MA through the Disaster Recovery System user interface to perform activities such as configuring backup devices, scheduling backups by adding new backup schedules, viewing or updating an existing schedule, displaying status of executed schedules, and performing system restoration.

The MA stores backup data on a locally attached tape drive or a remote network location.

Local Agents

The server also has a Local Agent to perform backup and restore functions.

Duties That Local Agents Perform

The Local Agent runs backup and restore scripts on the server.

Managing Backup Devices

Before using the Disaster Recovery System, you must configure the locations where you want the backup files to be stored. You can configure up to 10 backup devices. Perform the following steps to configure backup devices.

Procedure


Step 1 Navigate to the Disaster Recovery System. Log in to Cisco Unified Communications Manager Administration, choose Disaster Recovery System from the Navigation menu in the upper, right corner of the Cisco Unified Communications Manager Administration window, and click Go.

The Disaster Recovery System Logon window displays.

Step 2 Log in to the Disaster Recovery System by using the same Administrator username and password that you use for Cisco Unified Communications Operating System Administration.

Step 3 Navigate to Backup>Backup Device. The Backup Device List window displays.

Step 4 To configure a new backup device, click Add New.

Step 5 To edit a backup device, select it in the Backup Device list, then click Edit Selected.

The Backup Device window displays.

Step 6 Enter the backup device name in the Backup device name field.


Note The backup device name may contain only alpha numeric characters, spaces ( ), dashes (-) and underscores (_). No other characters are allowed.


Step 7 Choose one of the following backup devices and enter the appropriate field values in the Select Destination area:

Tape Device—Stores the backup file on a locally attached tape drive. Choose the appropriate tape device from the list.


Note You cannot span tapes or store more than one backup per tape.


Network Directory—Stores the backup file on a networked drive that is accessed through an SFTP connection. Enter the following required information:

Server name: Name or IP address of the network server

Path name: Path name for the directory where you want to store the backup file

User name: Valid username for an account on the remote system

Password: Valid password for the account on the remote system

Number of backups to store on Network Directory: The number of backups to store on this network directory.


Note You must have access to an SFTP server to configure a network storage location. The SFTP path must exist prior to the backup. The account that is used to access the SFTP server must have write permission for the selected path.


Step 8 To update these settings, click Save.


Note After you click the Save button, the DRS Master Agent validates the selected backup device. If the user name, password, server name, or directory path is invalid, the save will fail.


Step 9 To delete a backup device, select it in the Backup Device list, then click Delete Selected.


Note You cannot delete a backup device that is configured as the backup device in a backup schedule.



Creating and Editing Backup Schedules

You can create up to 10 backup schedules. Each backup schedule has its own set of properties, including a schedule for automatic backups, the set of features to back up, and a storage location.

Perform the following steps to manage backup schedules:

Procedure


Step 1 Navigate to the Disaster Recovery System. Log in to Cisco Unified Communications Manager Administration, choose Disaster Recovery System from the Navigation menu in the upper, right corner of the Cisco Unified Communications Manager Administration window, and click Go.

The Disaster Recovery System Logon window displays.

Step 2 Log in to the Disaster Recovery System by using the same Administrator username and password that you use for Cisco Unified Communications Operating System Administration.

Step 3 Navigate to Backup>Scheduler.

The Schedule List window displays.

Step 4 Do one of the following steps to add a new schedule or edit an existing schedule

a. To create a new schedule, click Add New.

b. To configure an existing schedule, click its name in the Schedule List column.

The scheduler window displays.

Step 5 Enter a schedule name in the Schedule Name field.


Note You cannot change the name of the default schedule.


Step 6 Select the backup device in the Select Backup Device area.

Step 7 Select the features to back up in the Select Features area. You must choose at least one feature.

You must back up the database and voice names. Backing up messages is optional.

Step 8 Choose the date and time when you want the backup to begin in the Start Backup at area.

Step 9 Choose the frequency at which you want the backup to occur in the Frequency area: Once, Daily, Weekly, or Monthly. If you choose Weekly, you can also choose the days of the week when the backup will occur.


Tip To set the backup frequency to Weekly, occurring Tuesday through Saturday, click Set Default.


Step 10 To update these settings, click Save.

Step 11 To enable the schedule, click Enable Schedule.

The next backup occurs automatically at the time that you set.

Step 12 To disable the schedule, click Disable Schedule.


Enabling, Disabling, and Deleting Schedules

Procedure


Step 1 Navigate to the Disaster Recovery System. Log in to Cisco Unified Communications Manager Administration, choose Disaster Recovery System from the Navigation menu in the upper, right corner of the Cisco Unified Communications Manager Administration window, and click Go.

The Disaster Recovery System Logon window displays.

Step 2 Log in to the Disaster Recovery System by using the same Administrator username and password that you use for Cisco Unified Communications Operating System Administration.

Step 3 Navigate to Backup>Scheduler.

The Schedule List window displays.

Step 4 Check the check boxes next to the schedules that you want to modify.

To select all schedules, click Select All.

To clear all check boxes, click Clear All.

Step 5 To enable the selected schedules, click Enable Selected Schedules.

Step 6 To disable the selected schedules, click Disable Selected Schedules.

Step 7 To delete the selected schedules, click Delete Selected.


Starting a Manual Backup

Follow this procedure to start a manual backup.

Procedure


Step 1 Navigate to the Disaster Recovery System. Log in to Cisco Unified Communications Manager Administration, choose Disaster Recovery System from the Navigation menu in the upper, right corner of the Cisco Unified Communications Manager Administration window, and click Go.

The Disaster Recovery System Logon window displays.

Step 2 Log in to the Disaster Recovery System by using the same Administrator username and password that you use for Cisco Unified Communications Operating System Administration.

Step 3 Navigate to Backup>Manual Backup. The Manual Backup window displays.

Step 4 Select a backup device in the Select Backup Device area.

Step 5 Select the features to back up in the Select Features area.

You must back up the database and voice names. Backing up messages is optional.

Step 6 To start the manual backup, click Start Backup.


Checking Backup Status

You can check the status of the current backup job and cancel the current backup job. To view the backup history, see the "Viewing the Backup and Restore History" section.

Checking the Status of the Current Backup Job

Perform the following steps to check the status of the current backup job.

Procedure


Step 1 Navigate to the Disaster Recovery System. Log in to Cisco Unified Communications Manager Administration, choose Disaster Recovery System from the Navigation menu in the upper, right corner of the Cisco Unified Communications Manager Administration window, and click Go.

The Disaster Recovery System Logon window displays.

Step 2 Log in to the Disaster Recovery System by using the same Administrator username and password that you use for Cisco Unified Communications Operating System Administration.

Step 3 Navigate to Backup>Current Status. The Backup Status window displays.

Step 4 To view the backup log file, click the log filename link.

Step 5 To cancel the current backup, click Cancel Backup.


Note The backup cancels after the current component has completed its backup operation.



Restoring a Backup File

The Restore Wizard walks you through the steps that are required to restore a backup file. To perform a restore, use the procedure that follows.


Caution Before you restore Cisco Unified Communications Manager, ensure that the Cisco Unified Communications Manager version that is installed on the server matches the version of the backup file that you want to restore.

Procedure


Step 1 Navigate to the Disaster Recovery System. Log in to Cisco Unified Communications Manager Administration, choose Disaster Recovery System from the Navigation menu in the upper, right corner of the Cisco Unified Communications Manager Administration window, and click Go.

The Disaster Recovery System Logon window displays.

Step 2 Log in to the Disaster Recovery System by using the same Administrator username and password that you use for Cisco Unified Communications Operating System Administration.

Step 3 Navigate to Restore>Restore Wizard. The Restore Wizard Step 1window displays.

Step 4 Choose the backup device from which to restore in the Select Backup Device area, then click Next.

The Restore Wizard Step 2window displays.

Step 5 Choose the backup file that you want to restore.


Note The backup filename indicates the date and time that the system created the backup file.


Step 6 Click Next. The Restore Wizard Step 3 window displays.

Step 7 Choose the features that you want to restore.


Note Only the features that were backed up to the file that you chose display.


Step 8 Click Next. The Restore Wizard Step 4 window displays.

Step 9 To start restoring the data, click Restore.

You get prompted to choose the node to restore.

Step 10 Choose the appropriate node.


Caution After you choose the node to which you want the data restored, any existing data on that server gets overwritten.

Step 11 Your data gets restored on the nodes that you chose. To view the status of the restore, see the "Viewing the Restore Status" section.

Step 12 Restart the server. For more information on restarting, see the Cisco Unified Communications Operating System Administration Guide.


Note Depending on the size of your database and the components that you choose to restore, the system can require one hour or more to restore.



Viewing the Restore Status

To check the status of the current restore job, perform the following steps:

Procedure


Step 1 Navigate to the Disaster Recovery System. Log in to Cisco Unified Communications Manager Administration, choose Disaster Recovery System from the Navigation menu in the upper, right corner of the Cisco Unified Communications Manager Administration window, and click Go.

The Disaster Recovery System Logon window displays.

Step 2 Log in to the Disaster Recovery System by using the same Administrator username and password that you use for Cisco Unified Communications Operating System Administration.

Step 3 Navigate to Restore>Status. The Restore Status window displays.

Step 4 To view the restore log file, click the log filename link.


Viewing the Backup and Restore History

Using the following procedures, you can see the last 20 backup and restore jobs:

Backup History

Restore History

Backup History

Perform the following steps to view the backup history.

Procedure


Step 1 Navigate to the Disaster Recovery System. Log in to Cisco Unified Communications Manager Administration, choose Disaster Recovery System from the Navigation menu in the upper, right corner of the Cisco Unified Communications Manager Administration window, and click Go.

The Disaster Recovery System Logon window displays.

Step 2 Log in to the Disaster Recovery System by using the same Administrator username and password that you use for Cisco Unified Communications Operating System Administration.

Step 3 Navigate to Backup>History. The Backup History window displays.

Step 4 From the Backup History window, you can view the backups that you have performed, including filename, backup device, completion date, result, and features that are backed up.


Note The Backup History window displays only the last 20 backup jobs.



Restore History

Perform the following steps to view the restore history.

Procedure


Step 1 Navigate to the Disaster Recovery System. Log in to Cisco Unified Communications Manager Administration, choose Disaster Recovery System from the Navigation menu in the upper, right corner of the Cisco Unified Communications Manager Administration window, and click Go.

The Disaster Recovery System Logon window displays.

Step 2 Log in to the Disaster Recovery System by using the same Administrator username and password that you use for Cisco Unified Communications Operating System Administration.

Step 3 Navigate to Restore>History. The Restore History window displays.

Step 4 From the Restore History window, you can view the restores that you have performed, including filename, backup device, completion date, result, and the features that were restored.


Note The Restore History window displays only the last 20 restore jobs.



Command Line Interface

The Disaster Recovery System also provides command-line access to a subset of backup and restore functions, as shown in Table 3. For more information on these commands and on using the command line interface, see the Cisco Unified Communications Operating System Administration Guide.

Table 3 Disaster Recovery System Command Line Interface 

Command
Description

utils disaster_recovery backup

Starts a manual backup by using the features that are configured in the Disaster Recovery System interface

utils disaster_recovery restore

Starts a restore and requires parameters for backup location, filename, features, and nodes to restore

utils disaster_recovery status

Displays the status of ongoing backup or restore job

utils disaster_recovery show_backupfiles

Displays existing backup files

utils disaster_recovery cancel_backup

Cancels an ongoing backup job

utils disaster_recovery show_registration

Displays the currently configured registration

utils disaster_recovery show_tapeid

Displays the tape identification information


Error Messages

The Disaster Recovery System (DRS) issues alarms for various errors that could occur during a backup or restore procedure. Table 4 provides a list of Cisco DRS alarms.

Table 4 Disaster Recovery System Alarms  

Alarm Name
Description
Explanation

CiscoDRFBackupDeviceError

DRF backup process has problems accessing device

DRS backup process encountered errors while accessing device.

CiscoDRFBackupFailure

Cisco DRF Backup process failed

DRS backup process encountered errors.

CiscoDRFBackupInProgress

Unable to start new backup while another backup is still running

DRS cannot start new backup while another backup is still running.

CiscoDRFInternalProcessFailure

DRF internal process has encountered an error.

DRS internal process encountered an error.

CiscoDRFLA2MAFailure

DRF Local Agent is not able to connect to Master Agent

DRS Local Agent cannot connect to Master Agent.

CiscoDRFLocalAgentStartFailure

DRF Local Agent was not able to start

DRS Local Agent might be down.

CiscoDRFMA2LAFailure

DRF Master Agent is not able to connect to Local Agent

DRS Master Agent cannot connect to Local Agent.

CiscoDRFMABackupComponent
Failure

DRF was unable to backup at least one component.

DRS requested a component to back up its data; however, an error occurred during the backup process, and the component did not get backed up.

CiscoDRFMABackupNodeDisconnect

The node being backed up disconnected from the Master Agent prior to being fully backed up.

While the DRS Master Agent was running a backup operation on a Cisco Unified Communications Manager node, the node disconnected before the backup operation completed.

CiscoDRFMARestoreComponent
Failure

DRF was unable to restore at least one component.

DRS requested a component to restore its data; however, an error occurred during the restore process, and the component did not get restored.

CiscoDRFMARestoreNodeDisconnect

The node being restored disconnected from the Master Agent prior to being fully restored.

While the DRS Master Agent was running a restore operation on a Cisco Unified Communications Manager node, the node disconnected before the restore operation completed.

CiscoDRFMasterAgentStartFailure

DRF Master Agent was not able to start

DRS Master Agent might be down.

CiscoDRFNoRegisteredComponent

No registered components available, backup failed

DRS backup failed because no registered components are available.

CiscoDRFNoRegisteredComponent

No feature selected for backup

No feature got selected for backup.

CiscoDRFRestoreDeviceError

DRF restore process has problems accessing device

DRS restore process cannot read from device.

CiscoDRFRestoreFailure

DRF restore process failed

DRS restore process encountered errors.

CiscoDRFSftpFailure

DRF sftp operation has errors

Errors exist in DRS SFTP operation.


Related Documentation

Refer to the Cisco Unified Communications Manager Documentation Guide to learn about the documentation for Cisco Unified Communications Manager.

Obtaining Documentation, Obtaining Support, and Security Guidelines

For information on obtaining documentation, obtaining support, providing documentation feedback, security guidelines, and also recommended aliases and general Cisco documents, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Cisco Product Security Overview

This product contains cryptographic features and is subject to United States and local country laws governing import, export, transfer and use. Delivery of Cisco cryptographic products does not imply third-party authority to import, export, distribute or use encryption. Importers, exporters, distributors and users are responsible for compliance with U.S. and local country laws. By using this product you agree to comply with applicable laws and regulations. If you are unable to comply with U.S. and local laws, return this product immediately.

A summary of U.S. laws governing Cisco cryptographic products may be found at: http://www.cisco.com/wwl/export/crypto/tool/stqrg.html. If you require further assistance please contact us by sending email to export@cisco.com.


[an error occurred while processing this directive]