Table Of Contents
Required Data for This Procedure
Copying from Flash Memory to Another Location
Copying from the Network FTP Server to Another Location
Copying the Flash Running Configuration to Another Location
Copying the Network TFTP Configuration to Another Location
Restoring Factory Default Values
Configuring Backup and Restore Using SFTP
Required Data for This Procedure
Backup Server Authentication Using a SSH Host Key
Configuring Backup Server Authentication Without Using the SSH Host Key
Required Data for This Procedure
Configuring Backup Server Authentication Using the SSH Host Key
Required Data for This Procedure
Encrypting and Signing of Backup Content on the Server
Configuring the Encryption and Signing of Backup Content on the Server
Required Data for This Procedure
Encrypting PINs in Backup Files
Configuring Scheduled Backup Jobs
Backing Up and Restoring Data
Last Updated: August 7, 2009
Cisco Unity Express backup and restore functions use an FTP server to store and retrieve data. The backup function copies the files from the Cisco Unity Express application to the FTP server and the restore function copies the files from the FTP server to the Cisco Unity Express application. The FTP server can reside anywhere in the network if the backup and restore functions can access it with an IP address or hostname.
We recommend that backups be done regularly to preserve voice-mail messages and configuration data.
Backup and restore commands are available in configuration mode and in offline mode.
•In configuration mode, commands are available to set the following parameters:
–Number of backup files to keep (the oldest file is deleted).
–URL of the FTP server where the files will be stored.
•In offline mode, perform the backup or restore procedure. Decide the following:
–Type of files to be backed up: all files (configuration and data), only configuration files, or only data files. Data files consist of voice-mail messages. Configuration files consist of all other system and application parameters.
–URL of the FTP server where the files will be stored.
Caution Offline mode terminates all existing voice-mail calls and IMAP and VoiceView Express sessions. No new voice-mail calls are allowed. Calls to auto attendant are allowed. We recommend doing a backup when no calls are active.
This chapter contains the following sections:
•Restoring Factory Default Values
•Backup and Restore Using SFTP
•Backup Server Authentication Using a SSH Host Key
•Encrypting and Signing of Backup Content on the Server
•Encrypting PINs in Backup Files
•Configuring Scheduled Backup Jobs
Restrictions
Cisco Unity Express does not support the following backup and restore capabilities:
•Scheduled backup and restore operations. The backup and restore procedures begin when the appropriate command is entered.
•Centralized message storage arrangement. Cisco Unity Express backup files cannot be used or integrated with other message stores.
•Selective backup and restore. Only full backup and restore functions are available. Individual voice-mail messages or other specific data cannot be stored or retrieved.
Setting Backup Parameters
The backup parameters define the FTP server to use for storing Cisco Unity Express backup files and the number of backups that are stored before the system deletes the oldest one.
All Cisco Unity Express backup files are stored on the specified server. You can copy the backup files to other locations or servers, if necessary.
Cisco Unity Express automatically assigns an ID to each successful backup. Use this backup ID to restore the backup.
Prerequisites
•Verify that the backup server is configured.
•Verify that an FTP administrator or other user who can log in to the FTP server has full permission on the FTP server, such as read, write, overwrite, create, and delete permissions for files and directories.
Required Data for This Procedure
•Number of revisions to save before the oldest backup is written over
•FTP server URL
•User ID and password of the FTP server login
SUMMARY STEPS
1. config t
2. backup {revisions number | server url ftp-url username ftp-username password ftp-password}
3. exit
4. show backup
DETAILED STEPS
Examples
The following example configures a backup server and displays the show backup output:
se-10-0-0-0# config tse-10-0-0-0#(config)# backup server url ftp://172.16.0.0/backups username admin password voicese-10-0-0-0#(config)# backup revisions 10se-10-0-0-0#(config)# exitse-10-0-0-0#se-10-0-0-0# show backupServer URL: ftp://172.16.0.0/backupsUser Account on Server: adminNumber of Backups to Retain: 10se-10-0-0-0#Backing Up Files
Three types of backup requests are available: data only, configuration only, or all.
•Data—Backs up voice-mail greetings and voice-mail messages.
•Configuration—Backs up system configuration, including recorded names, custom scripts, and custom prompts. Use the show run command to display the current running configuration.
•All—Backs up all data and configuration information.
Backups are performed only in offline mode.
Cisco Unity Express automatically numbers and dates the backup files and identifies the revision number in a backupid field.
Performing different backup types at various times causes different backup IDs for data backups and configuration backups. For example, the last data backup ID might be 3, and the last configuration backup might be 4. Performing an "all" backup might result in a backup ID of 5 for both data and configuration.
When restoring the files, refer to the backup ID for the backup file that you want to use. Use the show backup server command for a list of backup IDs.
Note We recommend that you back up your configuration files whenever changes are made to the system or application files. Data files, which contain voice messages, should be backed up regularly to minimize data loss, such as from a hardware failure.
Caution Offline mode terminates all existing voice-mail calls, and no new voice-mail calls are allowed. Calls to auto attendant are allowed. We recommend doing a backup when telephone subscribers are not active on calls.
SUMMARY STEPS
1. offline
2. backup category {all | configuration | data}
3. continue
4. show backup history
5. show backup server
DETAILED STEPS
Examples
The following example displays the output from the show backup commands:
se-10-0-0-0# show backup history#Start OperationCategory: ConfigurationBackup Server: ftp://10.100.10.215/CUE_backupOperation: BackupBackupid: 2Restoreid: -1Description: test backup 1Date: Sun Jun 13 12:32:48 PDT 1993Result: SuccessReason:#End Operation#Start OperationCategory: DataBackup Server: ftp://10.100.10.215/CUE_backupOperation: BackupBackupid: 2Restoreid: -1Description: CUE test backupDate: Sun Jun 13 12:32:57 PDT 1993Result: SuccessReason:#End Operation#Start OperationCategory: ConfigurationBackup Server: ftp://10.100.10.215/CUE_backupOperation: RestoreBackupid: 2Restoreid: 1Description:Date: Sun Jun 13 12:37:52 PDT 1993Result: SuccessReason:#End Operation#Start OperationCategory: DataBackup Server: ftp://10.100.10.215/CUE_backupOperation: RestoreBackupid: 2Restoreid: 1Description:Date: Sun Jun 13 12:38:00 PDT 1993Result: SuccessReason:#End Operationse-10-0-0-0# show backup serverCategory: DataDetails of last 5 backupsBackupid: 1Date: Tue Jul 22 10:55:52 PDT 2003Description:Backupid: 2Date: Tue Jul 29 18:06:33 PDT 2003Description:Backupid: 3Date: Tue Jul 29 19:10:32 PDT 2003Description:Category: ConfigurationDetails of last 5 backupsBackupid: 1Date: Tue Jul 22 10:55:48 PDT 2003Description:Backupid: 2Date: Tue Jul 29 18:06:27 PDT 2003Description:
Backupid: 3Date: Tue Jul 29 19:10:29 PDT 2003Description:se-10-0-0-0#Restoring Files
After the backup files are created, you can restore them when needed. Restoring is done in offline mode, which terminates all voice-mail active voice-mail calls and IMAP and VoiceView Express sessions. It does not permit new voice-mail calls (auto attendant calls are permitted) or new IMAP and VoiceView Express sessions. You should consider doing the restore when telephone subscribers are least likely to be on the telephone.
Use the show backup server command to locate the backup ID of the file that you want to restore.
SUMMARY STEPS
1. show backup server
2. offline
3. restore id backupid category {all | configuration | data}
4. show backup history
5. reload
DETAILED STEPS
Example
The following example displays the backup server and backup history:se-10-0-0-0# show backup serverCategory: DataDetails of last 5 backupsBackupid: 1Date: Tue Jul 22 10:55:52 PDT 2003Description:Backupid: 2Date: Tue Jul 29 18:06:33 PDT 2003Description:Backupid: 3Date: Tue Jul 29 19:10:32 PDT 2003Description:Category: ConfigurationDetails of last 5 backupsBackupid: 1Date: Tue Jul 22 10:55:48 PDT 2003Description:Backupid: 2Date: Tue Jul 29 18:06:27 PDT 2003Description:
Backupid: 3Date: Tue Jul 29 19:10:29 PDT 2003Description:se-10-0-0-0#se-10-0-0-0# show backup historyStart OperationCategory: ConfigurationBackup Server: ftp://10.100.10.215/CUE_backupOperation: BackupBackupid: 1Restoreid: -1Description: test backup 1Date: Sun Jun 13 12:23:38 PDT 1993Result: FailureReason: Script execution failed: /bin/BR_VMConfg_backup.sh: returnvalue:1; Server Url:ftp://10.100.10.215/CUE_backup: returnvalue:9 Unable to authenticate#End Operation#Start OperationCategory: DataBackup Server: ftp://10.100.10.215/CUE_backupOperation: BackupBackupid: 1Restoreid: -1Description: test backup 1Date: Sun Jun 13 12:23:44 PDT 1993Result: FailureReason: Script execution failed: /bin/BR_VMData_backup.sh: returnvalue:1Voicemail Backup failed; Server Url:ftp://10.100.10.215/CUE_backup: returnvalue:9Unable to authenticate#End Operation#Start OperationCategory: ConfigurationBackup Server: ftp://10.100.10.215/CUE_backupOperation: BackupBackupid: 2Restoreid: -1Description: CUE test backupDate: Sun Jun 13 12:32:48 PDT 1993Result: SuccessReason:#End Operation#Start OperationCategory: DataBackup Server: ftp://10.100.10.215/CUE_backupOperation: BackupBackupid: 2Restoreid: -1Description: CUE test backupDate: Sun Jun 13 12:32:57 PDT 1993Result: SuccessReason:#End Operation
Copying Configurations
The following Cisco Unity Express EXEC commands are available to copy the startup configuration and running configuration to and from Flash memory, the network FTP server, and the network TFTP server.
Copying from Flash Memory to Another Location
Starting in Cisco Unity Express EXEC mode, use the following command to copy the startup configuration in Flash memory to another location:
copy startup-config {ftp: user-id:password@ftp-server-address/[directory] | tftp:tftp-server-address} filename
This command is interactive and prompts you for the information. You cannot enter the parameters in one line. The following examples illustrate this process.
In this example, the startup configuration is copied to the FTP server, which requires a user ID and password to transfer files. The IP address of the FTP server is 172.16.231.193. The startup configuration file is saved on the FTP server with the filename start.
se-10-0-0-0# copy startup-config ftpAddress or name of remote host? admin:voice@172.16.231.193Source filename? startThe following example shows the startup configuration copied to the TFTP server, which does not require a user ID and password. The IP address of the TFTP server is 172.16.231.190. The startup configuration is saved in the TFTP directory configs as filename temp_start.
se-10-0-0-0# copy startup-config tftpAddress or name of remote host? 172.16.231.190/configsSource filename? temp_startCopying from the Network FTP Server to Another Location
Starting in Cisco Unity Express EXEC mode, use the following command to copy the network FTP server configuration to another location:
copy ftp: {running-config | startup-config} user-id:password@ftp-server-address/[directory] filename
This command is interactive and prompts you for the information. You cannot enter the parameters in one line. The following example illustrates this process.
In this example, the FTP server requires a user ID and password. The IP address of the FTP server is 10.3.61.16. The file start in the FTP server configs directory is copied to the startup configuration.
se-10-0-0-0# copy ftp: startup-config!!!WARNING!!! This operation will overwrite your startup configuration.Do you wish to continue[y]? yAddress or name or remote host? admin:voice@10.3.61.16/configsSource filename? startCopying the Flash Running Configuration to Another Location
Starting in Cisco Unity Express EXEC mode, use the following command to copy the running configuration in Flash memory to another location:
copy running-config {ftp: user-id:password@ftp-server-address/[directory] | startup-config | tftp:tftp-server-address} filename
When you copy the running configuration to the startup configuration, enter the command on one line.When you copy to the FTP or TFTP server, this command becomes interactive and prompts you for the information. You cannot enter the parameters in one line. The following example illustrates this process.In the following example, the running configuration is copied to the FTP server, which requires a user ID and password. The IP address of the FTP server is 172.16.231.193. The running configuration is copied to the configs directory as file saved_start.se-10-0-0-0# copy running-config ftp:Address or name of remote host? admin:voice@172.16.231.193/configsSource filename? saved_startIn the following example, the running configuration is copied to the startup configuration as file start. In this instance, enter the command on a single line.se-10-0-0-0# copy running-config startup-config startCopying the Network TFTP Configuration to Another Location
Starting in Cisco Unity Express EXEC mode, use the following command to copy the network TFTP configuration to another location:
copy tftp: {running-config | startup-config} tftp-server-address/[directory] filename
This command is interactive and prompts you for the information. You cannot enter the parameters in one line. The following example illustrates this process.
In this example, the TFTP server has IP address 10.3.61.16. The file start in directory configs on the TFTP server is copied to the startup configuration.
se-10-0-0-0# copy tftp: startup-config!!!WARNING!!! This operation will overwrite your startup configuration.Do you wish to continue[y]? yAddress or name of remote host? 10.3.61.16/configsSource filename? startRestoring Factory Default Values
Cisco Unity Express provides a command to restore the factory default values for the entire system. Restoring the system to the factory defaults erases the current configuration. This function is available in offline mode.
Caution This operation is irreversible. All data and configuration files are erased. Use this feature with caution. We recommend that you do a full system backup before proceeding with this feature.
When the system is clean, the administrator sees a message that the system will reload, and the system begins to reload. When the reload is complete, the system prompts the administrator to go through the postinstallation process.
When logging in to the graphical user interface (GUI), the administrator has the option to run the initialization wizard.
Perform the following steps to reset the system to Cisco Unity Express factory default values.
Step 1 se-10-0-0-0# offline
This command puts the system into offline mode.
Step 2 (offline)# restore factory default
This operation will cause all the configuration and data on the system to be erased. This operation is not reversible. Do you wish to continue? (n)Step 3 Do one of the following:
•Enter n if want to retain the system configuration and data.
The operation is cancelled, but the system remains in offline mode. To return to online mode, enter continue.
•Enter y if you want to erase the system configuration and data.
When the system is clean, a message appears indicating that the system will start to reload. When the reload is complete, a prompt appears to start the postinstallation process.
Backup and Restore Using SFTP
This section discusses the following topics:
•Configuring Backup and Restore Using SFTP
Overview
Starting in release 3.0, you can transfer files from any Cisco Unity Express application to and from the backup server using Secure File Transfer Protocol (SFTP). SFTP provides data integrity and confidentiality that is not provided by FTP.
Because SFTP is based on Secure Shell tunnel version 2 (SSHv2), only SSHv2 servers are supported for this feature.
To run backup and restore over SFTP, you must configure the URL of the backup server in the form of sftp://hostname/dir, and also the username and password to login to the server. The backup server must have an SSH daemon running with the SFTP subsystem enabled. The SSH protocol allows various user authentication schemes. In Version 3.2, however, only password authentication is supported.
Configuring Backup and Restore Using SFTP
Prerequisites
Cisco Unity Express 3.0 or a later version
Required Data for This Procedure
There is no data required.
SUMMARY STEPS
1. config t
2. backup {revisions number | server url sftp-url username sftp-username password sftp-password}
3. end
DETAILED STEPS
Backup Server Authentication Using a SSH Host Key
This section discusses the following topics:
•Configuring Backup Server Authentication Without Using the SSH Host Key
•Configuring Backup Server Authentication Using the SSH Host Key
Overview
Starting in release 3.0, you can authenticate the backup server using the SSH protocol before starting a backup/restore operation. The SSH protocol uses public key cryptography for server authentication.
This feature provides two methods of authenticating a server:
•Establishing a secure connection based only on the URL of a trusted backup server.
•Obtaining the fingerprint of the backup server and using it to establish a secure connection. This fingerprint is also known as the host key or private key.
The first method is easier than the second method, but it is less secure because it does not depend on you knowing the backup server's private host key. However, if you know the URL of a trusted backup server, it is generally safe. In this case, the backup server securely provides the client with its private host key.
In both cases, when server authentication is enabled, the system validates the SSH server's private host key by comparing the fingerprint of the key received from the server with a preconfigured string. If the two fingerprints do not match, the SSH handshake fails, and the backup/restore operation does not occur.
You cannot use the GUI to configure this feature; you must use the CLI.
Both methods are explained in the following sections.
Configuring Backup Server Authentication Without Using the SSH Host Key
Prerequisites
Cisco Unity Express 3.0 or a later version
Required Data for This Procedure
To enable SSH authentication of a backup server without knowing the server's fingerprint (private host key), you must know the URL of a trusted backup server.
SUMMARY STEPS
1. config t
2. backup server url sftp://url
3. backup server authenticate
4. end
5. show security ssh knowhost
DETAILED STEPS
Configuring Backup Server Authentication Using the SSH Host Key
Prerequisites
Cisco Unity Express 3.0 or a later version
Required Data for This Procedure
To use a backup server's fingerprint (private host key) to enable SSH authentication, you must first retrieve the fingerprint "out-of-band" by running the ssh-keygen routine on the backup server. This routine is included in the OpenSSH package. The following example shows the command and its output:
ssh-keygen -l -f /etc/ssh/ssh_host_dsa_key.pub
1024 4d:5c:be:1d:93:7b:7c:da:56:83:e0:02:ba:ee:37:c1 /etc/ssh/ssh_host_dsa_key.pub
SUMMARY STEPS
1. config t
2. security ssh knownhost host {ssh-rsa | ssh-dsa} fingerprint-string
3. end
4. show security ssh knowhost
DETAILED STEPS
Encrypting and Signing of Backup Content on the Server
This section discusses the following topics:
•Configuring the Encryption and Signing of Backup Content on the Server
Overview
Starting in release 3.0, you can protect backed up configuration and data files using signing and encryption before the files are transferred to the backup server.
To enable this feature, you must configure a master key, from which the encryption and signing key (known as the session key) are derived. The backup files are encrypted and signed before they are sent to the backup server. When you restore the files, the master key is used to validate the integrity of the files and decrypt them accordingly. You can also restore the backup files to any other machine running Cisco Unity Express 3.1 or later versions, if you configure the same master key before you begin the restore process. To make it easier to automate a scheduled backup, the master key is stored securely on the hosting device. It is not included in the backup content.
During the restore process, if the system detects that backup content has been tampered with, the restore process aborts. The system also halts and waits for the administrator to take some action, such as restoring using a different revision.
For backward compatibility, you can allow unsigned backup files to be restored if the risk is acceptable.
Configuring the Encryption and Signing of Backup Content on the Server
Prerequisites
Cisco Unity Express 3.0 or a later version
Required Data for This Procedure
There is no data required.
SUMMARY STEPS
1. config t
2. backup security key generate
3. backup security protected
4. backup security enforced
5. end
DETAILED STEPS
Encrypting PINs in Backup Files
Before release 3.0, PINs were stored as clear text in LDAP and were therefore visible in the backup file. This is because user PINs are stored in LDAP, which is backed up in LDIF format. This feature applies SHA-1 hash encryption to PINs before storing them in the LDAP database. As a result, when a user logs in to voice mail, the PIN they submit is hashed and compared to the PIN attribute retrieved from LDAP directory.
To migrate from an earlier version, you must convert from a clear PIN to a hashed PIN in the LDAP directory. This conversion is typically done right after a system upgrade from an earlier version or after a restore operation from an old backup. At his point, the clear PIN is removed from the database and replaced with the encrypted PIN.
Because encryption using SHA-1 is not reversible, after the conversion is complete, you cannot disable or turn off this feature to restore the encrypted PIN to its clear form.
Note This feature, does not require any configuration using the GUI or CLI.
Configuring Scheduled Backup Jobs
Beginning in release 7.1, you to configure one-time or recurring backup jobs.
For recurring backup jobs, you can configure the jobs to repeat:
•Every N days at a specific time
•Every N weeks on a specific day and time
•Every N months on a specific day of the month and time
•Every N years on a specific month
You can configure up to five repetitive scheduled backup jobs and five one-time scheduled backup jobs.
Whenever a backup job (or any scheduled activity) is started and in progress, any other activities that are scheduled to start at this time, are put in queue to wait for the first activity to finish. The maximum size of the queue is nine activities.
You cannot delete individual instances of a recurring scheduled backup schedule; you can only delete the entire series of backup jobs. However, you can suspend a given scheduled action by configuring start and end dates for the action to specify when the action is active. You can also suspend a scheduled action indefinitely by not specifying an expiration date for the action.
Immediate backup requests are always given precedence over scheduled backup jobs. If the scheduled backup is configured to start at the same time as an immediate backup, the scheduled backup job is queued and the system waits for the immediate backup to finish before it attempts to start the scheduled backup job.
SUMMARY STEPS
1. configure terminal
2. backup schedule [name name]
3. repeat every {number days at time |number weeks on day | number months on day date | number years on month month} at time
Note Instead of the repeat every command, you can optionally use one of the following commands:
•repeat once at time
•repeat daily at time
•repeat monthly on day date at time
•repeat weekly on day at time
•repeat yearly on month month at time
4. start-date date
5. end-date date
6. disabled from date to date
7. exec-timeout number minutes
8. exec command command
9. end
10. show backup schedules or show schedules
11. show backup schedule detail job job-name or show schedule detail job job-name
DETAILED STEPS
Examples
The following is sample output from the show backup schedules command:
se-10-0-0-0# show backup schedulesName Schedule Next Run Description CategoriesA22 NOT SET NEVERbackup1000 Every 1 days at 12:34 Jun 25, 2002 12:34 DataTotal: 2The following is sample output from the show schedules command:
se-10-0-0-0# show schedulesName Schedule Next Run Description CategoriesA22 NOT SET NEVERbackup1000 Every 1 days at 12:34 Jun 25, 2002 12:34 DataTotal: 2The following is sample output from the show backup schedule detail job command:
se-10-0-0-0# show backup schedule detail job job-8Name job-8Description main backupCategories TimeCardView Configuration Data HistoricalDataSchedule Daily at 06:00Last Run Jan 1, 2009 at 6:00Last Result SuccessNext Run Jan 2, 2009 at 6:00Active from Jan 01, 2000 until Dec 31, 2009The following is sample output from the show schedule detail job command:
se-10-0-0-0# show schedule detail job job-8Job Name job-8Application backupDescription main backupSchedule Daily at 06:00Last Run 5 hours 59 seconds agoNext Run in 18 hours 1 secondsActive from Jun 25, 2002 until INDEFINITE