The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
The Disaster Recovery System backs up and restores all configuration for Cisco HCM-F and all data that is stored in the Shared Data Repository. In addition, DRS restores its own settings (backup device settings and schedule settings) as part of the backup/restore process. DRS backs up and restores drfDevice.xml and drfSchedule.xml files. When the server is restored with these files, you do not need to reconfigure the DRS backup device and schedule.
For more detailed information about the backup and restore relationships between Cisco Hosted Collaboration Mediation Fulfillment, Cisco Unified Communications Domain Manager(s) and Cisco Unified Communications Applications, refer to the Cisco Hosted Collaboration Solution, Release 10.6(1) Maintain and Operate Guide.
Tip | Schedule backups during periods when you expect less network traffic. |
Note | While a backup or restore is running, the command line interface may block you from running some commands, including commands that support upgrades. |
Archive backups to a local drive or remote SFTP server. The Disaster Recovery System does not support tape drives for backup and restore on the Cisco Hosted Collaboration Mediation Fulfillment platform. You must choose a local device if you do not have outgoing SFTP access to the Cisco Hosted Collaboration Mediation Fulfillment platform. If you store backup files to a local device, DRS stores the backup files in the /common/adminsftp/backup directory. You must manually move local backup files from the Cisco Hosted Collaboration Mediation Fulfillment platform by opening an SFTP client and connecting to the Cisco Hosted Collaboration Mediation Fulfillment platform by using the adminsftp user and the administrator password that you set up during installation.
To back up data to a remote device on the network or to move a local backup to another location, you must have an SFTP server that is configured. Cisco allows you to use any SFTP server product but recommends SFTP products that have been certified with Cisco through the Cisco Technology Developer Partner program (CTDP). CTDP partners, such as GlobalSCAPE, certify their products with specified versions. For information on which vendors have certified their products with your version, refer to the following URL:
http://solutionpartner.cisco.com/web/join-the-network/partner/isv
For information on using GlobalSCAPE with supported Cisco Unified Communications versions, refer to the following URL:
http://www.globalscape.com/gsftps/cisco.aspx
You may use one of the following third-party servers, but Cisco recommends that you must contact the vendor for support:
Open SSH (refer to http://sshwindows.sourceforge.net/)
Cygwin (refer to http://www.cygwin.com/)
Titan (refer to http://www.titanftp.com/)
Note | For issues with third-party products that have not been certified through the CTDP process, contact the third-party vendor for support. |
To access the Disaster Recovery System, start an SSH session and log in to the CLI on the Cisco HCM-F platform. To log in to the CLI, you must enter the administrator username and password (from the Cisco HCM-F installation, unless you changed it after installation).
The system automatically activates the Master Agent on the Cisco HCM-F platform. The Master Agent performs the following duties:
The Master Agent stores systemwide component registration information.
The Master Agent maintains a complete set of scheduled tasks in an XML file. The Master Agent updates this file when it receives updates of schedules from the user interface. The Master Agent sends executable tasks to the applicable Local Agents, as scheduled. (Local Agents execute immediate-backup tasks without delay.)
You access the Master Agent through Disaster Recovery System 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 Master Agent stores backup data on a local directory or a remote network location.
The server has a Local Agent to perform backup and restore functions. The Local Agent runs backup and restore scripts on the server.
The following tables provide a quick reference for the backup and restore procedures.
Note | DRS backs up and restores the drfDevice.xml and drfSchedule.xml files. These backup device settings and schedule settings get restored as a part of the restore process. After the server is restored with these files, you do not need to reconfigure DRS backup device and schedule. |
The following table provides a quick, high-level reference to the major steps, in chronological order, for restores through the Disaster Recovery System.
Check the Status of the Restore—While the restore process is running, you can check the status of the current restore job. |
Before using the Disaster Recovery System, you must configure the locations where you want the backup files to be stored. You can create local or network backup devices. If you create a local backup device, Disaster Recovery System stores the backup files in the a preconfigured directory on the Cisco HCM-F platform. You must manually move local backup files from the Cisco HCM-F platform by opening an SFTP client and connecting to the Cisco HCM-F platform by using the adminsftp user and the administrator password that you set up during Cisco HCM-F installation.
Note | You can estimate the size of the .tar file that the backup creates by entering utils disaster_recovery estimate_tar_size HCS. |
You can configure up to 10 backup devices. Perform the following steps to configure backup devices.
Step 1 | To access the
Disaster Recovery
System, start an SSH session and log in to the CLI on the Cisco HCM-F
platform.
The CLI admin prompt displays. | ||||
Step 2 | To create a
local device, enter
utils
disaster_recovery add local
device_name
number of backups
where device_name equals the name of the backup device. The backup device name may contain only alphanumeric characters, spaces ( ), hyphens (-) and underscores (_). Do not use any other characters. By default, DRS stores backup files for local devices in the /common/adminsftp/backup directory. number of backups equals the number of backups that are retained for the backup server. When the backup reaches the limit, the oldest backup files on the backup server are deleted and the new backup files are added. | ||||
Step 3 | To create a
network device so that you can store backup files on a network drive that is
accessed through an SFTP connection, enter
utils
disaster_recovery device add network
device_name
path server_name username number_of_backups
where device_name equals the name of the backup device. The backup device name may contain only alphanumeric characters, spaces ( ), hyphens (-) and underscores (_). Do not use any other characters. path equals the path name for the directory where you want to store the backup file server_name equals the name or IP address of the network server username equals a valid username for an account on the remote system number of backups equals the number of backups allowed for this device
| ||||
Step 4 | To display a
list of backup devices, enter
utils
disaster_recovery
device
list.
The device name, device type, and device path for each backup device displays. | ||||
Step 5 | To delete a
backup device, enter
utils
disaster_recovery device delete
device_name, where
device_name
equals the name of the device that you want to delete.
|
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.
Caution | Schedule backups during off-peak hours to avoid call-processing interruptions and impact to service. |
Note | To view a history of backups, enter utils disaster_recovery history Backup. The results of all backups display. |
Step 1 | To access the
Disaster Recovery
System, start an SSH session and log in to the CLI on the Cisco HCM-F
platform.
The CLI admin prompt displays. | ||
Step 2 | Enter
utils
disaster_recovery schedule add
schedulename
devicename featurelist datetime frequency
where schedulename equals the name of the schedule devicename equals the location where Disaster Recovery System stores the backup files featurelist equals HCS datetime specifies the time and date when Disaster Recovery System performs the backup. The format is yyyy/mm/dd-hh:mm. Enter the time based on a 24-hour clock. frequency equals how often Disaster Recovery System performs the backup. Options are once, daily, weekly, and monthly. | ||
Step 3 | To enable a
schedule, enter
utils
disaster_recovery schedule enable
schedulename.
The next backup occurs automatically at the time that you set.
|
Follow this procedure to enable, disable, or delete backup schedules.
Step 1 | To access the
Disaster Recovery
System, start an SSH session and log in to the CLI on the Cisco HCM-F
platform.
The CLI admin prompt displays. |
Step 2 | To view the list
of backup schedules, enter
utils
disaster_recovery schedule list.
The CLI displays the device name and status for each schedule. The device name specifies where Disaster Recovery System stores the backup files. |
Step 3 | Perform one of
the following tasks:
|
Step 1 | To access the
Disaster Recovery
System, start an SSH session and log in to the CLI on the Cisco HCM-F
platform.
The CLI admin prompt displays. |
Step 2 | Enter
utils
disaster_recovery backup
type
featurelist device_name
where type equals the location of the backup, either local or network featurelist equals HCS device_name equals the name of the backup device |
Step 3 | To view the status of the current backup, enter utils disaster_recovery status backup. |
Step 4 | To cancel the current backup, enter utils disaster_recovery cancel_backup yes. |
You can check the status of the current backup job and cancel the current backup job. Perform the following steps to check the status of the current backup job:
Caution | Be aware that if the backup to the remote server is not completed within 20 hours, the backup session times out. You will then need to begin a fresh backup. |
Note | Successful backups display a status of successful. To view a history of backups, enter utils disaster_recovery history backup. The results of all backups display. |
Step 1 | To access the
Disaster Recovery
System, start an SSH session and log in to the CLI on the Cisco HCM-F
platform.
The CLI admin prompt displays. | ||
Step 2 | To view the status of the current backup, enter utils disaster_recovery status backup. | ||
Step 3 | To cancel the
current backup, enter
utils
disaster_recovery cancel_backup yes.
|
Using the following procedures, you can see the list of backup files that are stored to the local or network drives:
Step 1 | To access the
Disaster Recovery
System, start an SSH session and log in to the CLI on the Cisco HCM-F
platform.
The CLI admin prompt displays. |
Step 2 | To view backup
files, do one of the following:
where path equals the path name for the directory where the backup file is stored servername equals the name or IP address of the network server userid equals a valid user ID for an account on the remote system |
You can restore the data for Cisco HCM-F from a backup file in a network directory or in a local directory. Use one of the following procedures to restore the data for Cisco HCM-F:
Caution | Before you restore Cisco HCM-F platform, ensure that the Cisco HCM-F version that is installed on the platform matches the version of the backup file that you want to restore. The Disaster Recovery System supports only matching versions of Cisco HCM-F for restore. For example, the Disaster Recovery System does not allow a restore from Version 8.6(2)ES1.1000-1 to Version 8.6(2)ES1.1000-2. Essentially, the product version needs to match, end-to-end, for the Disaster Recovery System to run a successful restore. Disaster Recovery System adheres to strict version checking and allows restore only between matching versions of Cisco HCM-F. |
Note | After you choose the server to which you want the data restored, any existing data on that server gets overwritten. |
In multi-node systems, restore the App node first, then restore any WS nodes.
Step 1 | Copy the backup file to the Cisco HCM-F platform by opening an SFTP client, and connecting to the Cisco HCM-F platform by using the adminsftp user and the administrator password that you set up during installation. To do that, navigate to the backup directory by entering cd backup, and copy the backup file to the /common/adminsftp/restore directory. |
Step 2 | Access the
Disaster Recovery
System by starting an SSH session and logging in to the CLI on the
Cisco HCM-F platform.
The CLI admin prompt displays. |
Step 3 | Enter
utils
disaster_recovery restore local
restore_server tarfilename device_name
where restore_server equals the hostname of the server to be restored tarfilename equals the name of the backup file to be restored without extension; for example, 2008-01-21-18-25-03 device_name equals the name of the backup device |
Step 4 | Your data gets restored on the server that you chose. To view the status of the restore, enter utils disaster_recovery status restore. |
Step 5 | Restart the Cisco HCM-F platform. |
To check the status of the current restore job, perform the following steps:
Step 1 | To access the
Disaster Recovery
System, start an SSH session and log in to the CLI on the Cisco HCM-F
platform.
The CLI admin prompt displays. |
Step 2 | To view information about the current restore job, enter utils disaster_recovery status restore. The status shows the restore percentage, log file location, timestamp, feature name, platform name, component name, and component status. |
The Disaster Recovery System (DRS) issues alarms for various errors that can occur during a backup or restore procedure. The following table provides a list of Cisco DRS alarms:
DRS backup process encountered errors while it was accessing device. |
||
New backup cannot start while another backup is still running. |
DRS cannot start new backup while another backup is still running. |
|
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. |
||
The node that is being backed up disconnected from the Master Agent prior to being fully backed up. |
While the DRS Master Agent was running a backup operation, the Cisco HCM-F platform disconnected before the backup operation completed. |
|
DRS requested a component to restore its data; however, an error occurred during the restore process, and the component did not get restored. |
||
The node that is being restored disconnected from the Master Agent prior to being fully restored. |
While the DRS Master Agent was running a restore operation on the Cisco HCM-F platform, the platform disconnected before the restore operation completed. |
|
DRS backup failed because no registered components are available. |
||
DRF system detected a malicious pattern that can result in a security violation. |
The DRF Network Message contains a malicious pattern that can result in a security violation like code injection or directory traversal. DRF Network Message has been blocked. |
|
The IPsec trust store is missing on the node. DRF Local Agent cannot connect to Master Agent. |
||
DRF Master Agent on the platform received a client connection request from an unknown server. The request has been rejected. |
The DRF Master Agent on the platform received a client connection request from an unknown server. The request has been rejected. |