Backup and Restore Operations for CUCM via CLI

Available Languages

Download Options

PDF (78.3 KB)
View with Adobe Reader on a variety of devices
ePub (73.3 KB)
View in various apps on iPhone, iPad, Android, Sony Reader, or Windows Phone
Mobi (Kindle) (69.4 KB)
View on Kindle device or Kindle app on multiple devices

Updated:September 13, 2017

Document ID:211975

Bias-Free Language

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.

Background information

Backup procedure

Restore procedure

Introduction

This document describes a process how to use Disaster Recovery System (DRS) for backup and restore operations on Cisco Unified Communications Manager (CUCM) with command line interface (CLI).

Created by Joy Pal, Edited by Alexander Levichev and Deepak kumar

Prerequisites

There are no prerequisites for this document.

Requirements

There are no specific requirements for this document.

Components Used

This document is not restricted to specific software and hardware versions.

Background information

Administrators usually do backup and restore operations via Disaster Recovery System(DRS) web Graphical User Interface(GUI).
There are a many cases in which an administrator does not have a possibility to Log in to Disaster Recovery System(DRS) web page due to a network issue or when Cisco Tomcat service is not running.
In these cases administrator can perform backup or restore operations with Disaster Recovery System(DRS) ,Command Line Interface(CLI) commands.

Backup procedure

1. Add a backup device.

Syntax:
utils disaster_recovery device add network <backup device name> <path> <ip-address of remote server> <username> [number of backups]

Example:

admin:utils disaster_recovery device add network linuxbox ./ 10.48.53.123 ccmadmin
Please enter password to connect to network server 10.48.53.123:****
drfCliMsg: Backup Device has been saved successfully.

2. Check the device added.

Syntax:
utils disaster_recovery device list

Example:

admin:utils disaster_recovery device list
Device Name             Device Type             Device Path
--------------------------------------------------------------
linuxbox                NETWORK                 ./

3.Take a backup.

Syntax:
utils disaster_recovery backup network <featurelist> <backup device name>
Featurelist - Comma separated list of features to backup. Use 'utils disaster_recovery show_registration <servername>' to display the list of registered features.

Example:

admin:utils disaster_recovery backup network UCM,CDR_CAR,PLM linuxbox
drfCliMsg: Backup initiated successfully. Please run 'utils disaster_recovery status backup' command to see the status

<p style="background-image: url('http://www.cisco.com/en/US/i/templates/warn.gif'); background-repeat: no-repeat; background- position: 2px 4px;
height: auto; width: auto; padding: 10px 5px 10px 35px; margin-top: 10px; margin-bottom: 10px; border-top: 1px solid #ccc; border-bottom: 1px
solid #ccc; overflow-x: hidden;"><strong>Warning</strong>: {The DRS Backup archive encryption depends on the current security password (Provided at the time of install). During a restore, you could be prompted to enter this security password if this password has been changed.}</p>

4.Check the status of a backup.

Syntax:
utils disaster_recovery status backup

Example:

admin:utils disaster_recovery status backup

Status: SUCCESS :Backup Completed...
Tar Filename: 2017-08-18-12-17-19.tar
Storage Location: NETWORK
Operation: backup
Percentage Complete: 100
PLM CUCM160 ELM-AGENT SUCCESS Fri Aug 18 12:17:19 CEST 2017 activelog/platform/drf/log/2017-08-18-12-17-19_b_cucm160_plm_elm-agent.log
PLM CUCM160 ELM-SERVER SUCCESS Fri Aug 18 12:17:21 CEST 2017 activelog/platform/drf/log/2017-08-18-12-17-19_b_cucm160_plm_elm-server.log
CDR_CAR CUCM160 CAR SUCCESS Fri Aug 18 12:17:27 CEST 2017 activelog/platform/drf/log/2017-08-18-12-17-19_b_cucm160_cdr_car_car.log
UCM CUCM160 BAT SUCCESS Fri Aug 18 12:19:23 CEST 2017 activelog/platform/drf/log/2017-08-18-12-17-19_b_cucm160_ucm_bat.log
UCM CUCM160 CCMPREFS SUCCESS Fri Aug 18 12:19:25 CEST 2017 activelog/platform/drf/log/2017-08-18-12-17-19_b_cucm160_ucm_ccmprefs.log
UCM CUCM160 PLATFORM SUCCESS Fri Aug 18 12:19:30 CEST 2017 activelog/platform/drf/log/2017-08-18-12-17-19_b_cucm160_ucm_platform.log
UCM CUCM160 TCT SUCCESS Fri Aug 18 12:19:34 CEST 2017 activelog/platform/drf/log/2017-08-18-12-17-19_b_cucm160_ucm_tct.log
UCM CUCM160 SYSLOGAGT SUCCESS Fri Aug 18 12:19:35 CEST 2017 activelog/platform/drf/log/2017-08-18-12-17-19_b_cucm160_ucm_syslogagt.log
UCM CUCM160 CDPAGT SUCCESS Fri Aug 18 12:19:36 CEST 2017 activelog/platform/drf/log/2017-08-18-12-17-19_b_cucm160_ucm_cdpagt.log
UCM CUCM160 CLM SUCCESS Fri Aug 18 12:19:37 CEST 2017 activelog/platform/drf/log/2017-08-18-12-17-19_b_cucm160_ucm_clm.log
UCM CUCM160 CCMDB SUCCESS Fri Aug 18 12:19:37 CEST 2017 activelog/platform/drf/log/2017-08-18-12-17-19_b_cucm160_ucm_ccmdb.log
UCM CUCM160 TFTP SUCCESS Fri Aug 18 12:20:15 CEST 2017 activelog/platform/drf/log/2017-08-18-12-17-19_b_cucm160_ucm_tftp.log
UCM CUCM160 ANN SUCCESS Fri Aug 18 12:21:33 CEST 2017 activelog/platform/drf/log/2017-08-18-12-17-19_b_cucm160_ucm_ann.log
UCM CUCM160 MOH SUCCESS Fri Aug 18 12:21:34 CEST 2017 activelog/platform/drf/log/2017-08-18-12-17-19_b_cucm160_ucm_moh.log

Restore procedure

Check backup files present on a remote sftp server.

Syntax:

utils disaster_recovery show_backupfiles <backup device name>

Example:

admin:utils disaster_recovery show_backupfiles linux123

2017-08-18-14-45-38

2017-08-18-12-17-19

2.Restore the system from the backup

Choose a backup file from previous output.

Syntax:

utils disaster_recovery restore network <ip-address of remote server> <tarfilename> <backup device name>

Example:

admin:utils disaster_recovery restore network 10.48.53.160 2017-08-18-14-45-38 linux123
 
drfCliMsg: WARNING! There are nodes in current production cluster but NOT present in the backup. These nodes will be removed if you restore the Publisher. If you want to keep these nodes, you will need to manually re-add them after the restore.
 
Do you want DRS to perform a SHA-1 File Integrity Check of your backup archives y/n ?(n) : y
 
Please enter the comma seperated features you wish to restore. Valid features for server CUCM160 are PLM,CDR_CAR,UCM:PLM,CDR_CAR,UCM
 
Do you want to restore database from the subscriber y/n ?(n) : n
drfCliMsg: Restore initiated successfully. Please run 'utils disaster_recovery status restore' command to see the status
 
ALERT: Please restart the server(s) before performing the next restore for changes to take effect. In case of a cluster, restart the entire cluster.

<p style="background-image: url('http://www.cisco.com/en/US/i/templates/note.gif'); background-repeat: no-repeat; background- position: 2px 4px;
height: auto; width: auto; padding: 10px 5px 10px 35px; margin-top: 10px; margin-bottom: 10px; border-top: 1px solid #ccc; border-bottom: 1px
solid #ccc; overflow-x: hidden;"><strong>Note</strong>: {If you are restoring the system to be in FIPS mode, please note that it will be enabled during this restore, but will not take effect until the next reboot..}</p>

Check the restore status

A restore procedure could take time depends on the database size.

Syntax:

utils disaster_recovery status restore

Example:

admin:utils disaster_recovery status restore
 
Status: SUCCESS :Restore Completed...
Tar Filename: 2017-08-18-14-45-38.tar
Storage Location: NETWORK
Operation: restore
Percentage Complete: 100
CDR_CAR   CUCM160   CAR   SUCCESS   Fri Aug 18 15:20:15 CEST 2017   activelog/platform/drf/log/2017-08-18-15-20-01_r_cucm160_cdr_car_car.log
PLM   CUCM160   ELM-AGENT   SUCCESS   Fri Aug 18 15:24:34 CEST 2017   activelog/platform/drf/log/2017-08-18-15-20-01_r_cucm160_plm_elm-agent.log
PLM   CUCM160   ELM-SERVER   SUCCESS   Fri Aug 18 15:24:34 CEST 2017   activelog/platform/drf/log/2017-08-18-15-20-01_r_cucm160_plm_elm-server.log
UCM   CUCM160   BAT   SUCCESS   Fri Aug 18 15:27:06 CEST 2017   activelog/platform/drf/log/2017-08-18-15-20-01_r_cucm160_ucm_bat.log
UCM   CUCM160   CCMPREFS   SUCCESS   Fri Aug 18 15:27:06 CEST 2017   activelog/platform/drf/log/2017-08-18-15-20-01_r_cucm160_ucm_ccmprefs.log
UCM   CUCM160   PLATFORM   SUCCESS   Fri Aug 18 15:27:13 CEST 2017   activelog/platform/drf/log/2017-08-18-15-20-01_r_cucm160_ucm_platform.log
UCM   CUCM160   TCT   SUCCESS   Fri Aug 18 15:32:15 CEST 2017   activelog/platform/drf/log/2017-08-18-15-20-01_r_cucm160_ucm_tct.log
UCM   CUCM160   SYSLOGAGT   SUCCESS   Fri Aug 18 15:34:39 CEST 2017   activelog/platform/drf/log/2017-08-18-15-20-01_r_cucm160_ucm_syslogagt.log
UCM   CUCM160   CDPAGT   SUCCESS   Fri Aug 18 15:34:39 CEST 2017   activelog/platform/drf/log/2017-08-18-15-20-01_r_cucm160_ucm_cdpagt.log
UCM   CUCM160   CLM   SUCCESS   Fri Aug 18 15:37:03 CEST 2017   activelog/platform/drf/log/2017-08-18-15-20-01_r_cucm160_ucm_clm.log
UCM   CUCM160   CCMDB   SUCCESS   Fri Aug 18 15:37:05 CEST 2017   activelog/platform/drf/log/2017-08-18-15-20-01_r_cucm160_ucm_ccmdb.log
UCM   CUCM160   TFTP   SUCCESS   Fri Aug 18 15:45:12 CEST 2017   activelog/platform/drf/log/2017-08-18-15-20-01_r_cucm160_ucm_tftp.log
UCM   CUCM160   ANN   SUCCESS   Fri Aug 18 15:46:38 CEST 2017   activelog/platform/drf/log/2017-08-18-15-20-01_r_cucm160_ucm_ann.log
UCM   CUCM160   MOH   SUCCESS   Fri Aug 18 15:46:39 CEST 2017   activelog/platform/drf/log/2017-08-18-15-20-01_r_cucm160_ucm_moh.log

Command Line Interface Reference Guide for Cisco Unified Communications Solutions

Disaster Recovery System Administration Guide for Cisco Unified Communications Manager and IM & Presence Service