Cisco Prime Collaboration Assurance - Advanced and Analytics Guide, 12.1 Service Pack 3 Engineering Special 4

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.

Book Contents
Find Matches in This Book

Results

Updated:
May 27, 2020

Chapter: Perform Backup and Restore

Perform Backup and Restore

This section explains the following:

Perform Backup and Restore

You can schedule periodic backups using the Cisco Prime Collaboration Assurance user interface.

Cisco Prime Collaboration Analytics data is backed up on a remote server using SSH. It does not use the Cisco Prime Collaboration Assurance backup repository. You can backup the analytics data only through User Interface, and restore the data through CLI.

Note

Linux server is recommended for Cisco Prime Collaboration Analytics backup.

You can also backup Cisco Prime Collaboration Analytics on Windows server. Backup supports in Cygwin UNIX shell. Backup support in Windows server is not available using other SSH tools or Unix Shell.

Overview of Backup and Restore

Cisco Prime Collaboration Assurance uses the following purge policy:

  • All conference and endpoint statistics data older than one day are purged.

  • For Cisco Prime Collaboration Release 11.5 and later

    All conference and troubleshooting details older than 14 days are purged every hour.

  • For Cisco Prime Collaboration Release 11.6 and earlier

    Call quality event history and audio/video phone audit report data older than 30 days are purged.

    For Cisco Prime Collaboration Release 12.1 and later

    Call quality event history and endpoint related audit report data older than 30 days are purged.

  • Cleared alarms and events that are older than 14 days are purged every hour. If an alarm is purged, all associated events are also purged. Active events and alarms are not purged.

  • Jobs that are older than 14 days and have a status of completed, failed, or cancelled are purged every hour.

The backup and restore service allows you back up the database, configuration files, and log files to either a remote location or a local disk. Files in following folders are backed up by the backup service:

Type of Data for Assurance Backup

Assurance database

Configuration files

Type of Data for Analytics Backup

Analytics database

Log files

Reports (Scheduled Reports and Custom Reports)

Logos

Backup Time Period

Depending on the number of managed devices in the Cisco Prime Collaboration Assurance server, the data backup should take:

  • Upto 150,000 endpoints - 4 hours

  • Upto 80,000 endpoints - 3 - 2.5 hours

  • Upto 20,000 endpoints - 2 hours

  • Upto 3,000 endpoints - 1 hour


Note

To achieve the preceding time periods, the network latency should not be more than 20 ms.

We recommend you to schedule backups during the non-business hours, because, this operation can slow down the Cisco Prime Collaboration Assurance user interface performance.

Create a Repository on FTP, Disk, SFTP, or TFTP Server

You must create a repository before backing up the Cisco Prime Collaboration data. By default, the backup service creates a *.tar.gpg file under the configured repository. The backed-up file is in a compressed format. The repository can be on CD-ROM, disk, HTTP, FTP, SFTP, or TFTP.

For Cisco Prime Collaboration Release 11.6 and earlier

Procedure
Step 1

Log in to the Cisco Prime Collaboration server with the account that you created during installation. The default login is admin.

Step 2

Enter the following commands to create a repository on the local: 

admin# config t
admin(config)# repository RepositoryName
admin(config-Repository)# url disk:
admin(config-Repository)# exit
admin(config)# exit

Enter the following commands to create a repository on FTP server: 

admin# config t
admin(config)# repository RepositoryName
admin(config-Repository)# url ftp://ftpserver/directory
admin(config-Repository)# user UserName password {plain | hash} Password
admin(config-Repository)# exit
admin(config)# exit

Where:

  • RepositoryName is the location to which files should be backed up. This name can contain a maximum of 30 alphanumeric characters.

  • ftp://ftpserver/directory is the FTP server and the directory on the server to which the file is transferred. You can also use SFTP, HTTP, or TFTP instead of FTP.

  • UserName and {plain | hash} Password are the username and password for the FTP, SFTP, or TFTP server. hash specifies an encrypted password, and plain specifies an unencrypted plain text password.

    For example: 

    admin# config t
admin(config)# repository tmp
admin(config-Repository)# url ftp://ftp.cisco.com/incoming
admin(config-Repository)# user john password plain john!23
admin(config-Repository)# exit
admin(config)# exit
List the Repository Data

You can list the data within a repository. Log in to the Cisco Prime Collaboration server as admin and run the following command: 


admin# show repository RepositoryName

For example: 


admin# show repository myftp
assurance_Sun_Feb_09_14_20_30_CST_2014.tar.gpg

Schedule Backup using Cisco Prime Collaboration Assurance and Analytics User Interface

For Cisco Prime Collaboration Release 11.1 and earlier

You can schedule and run backup for both Assurance and Analytics from the user interface.

For Cisco Prime Collaboration Release 11.5 and later

You must be logged in as an administrator to perform backup.

To create a new backup job:

Procedure

Step 1

Choose System Administration > Backup settings.

Step 2

On the Backup page, click New.

Step 3

Enter a name for the backup job.

If backup name is not specified, the Backup Title field is defaulted with date stamp.

Step 4

Select the Backup Category from the drop-down list.

Step 5

In the Assurance Connection Settings pane, enter the following details.

You can use sFTP, FTP, or local connection to create backup.

If you select sFTP or FTP, provide the following details:

  • IP address of the server where the backup files need to be saved

  • Path to the backup location

    Note 

    The backup is taken in the specified user home directory. For example,

    Field

    Description

    SSH Username

    Enter a name for the SSH Username. For example, user1 or provide any desired name.

    Path

    Enter a name for the path. For example, /backup

    Then, the Assurance backup location will be /user1/backup/assurance_backup.

    The backup is saved in /user1/backup/assurance_backup.

  • Port (for sFTP only)

  • Username

  • Password

Click Test to test the sFTP or FTP connection using the credentials.

If you select local, specify the location to save the backup files on your local machine.

For a local backup, you can specify the number of backup files to be saved, using the Backup History drop-down list. By default, the last two backup files are saved. You can save up to nine backup files.

The Analytics Connection Settings pane is available only if you have enabled Cisco Prime Collaboration Analytics.

For Cisco Prime Collaboration Release 11.5 and later

Cisco Prime Collaboration Analytics is supported on the MSP deployments.

Step 6

In the Analytics Connection Settings pane, enter the following details.

You can use only a remote server to backup the Analytics data using SSH.

  • IP address of the remote server where the backup files need to be saved

  • Path to the backup location. You must provide relative path.

    Note 

    The backup is taken in the specified user home directory. For example,

    Field

    Description

    SSH Username

    Enter a name for the SSH Username. For example, user1 or provide any desired name.

    Path

    Enter a name for the path. For example, /backup

    Then, the Analytics backup location will be /backup/pg_basebackup (followed by timestamp (for example, pg_basebackup_201707201255)).

    The backup is saved in /user1/backup.

    The Analytics backup folder will be in the following format: pg_basebackup (followed by the timestamp (for example, pg_basebackup_201707201255)). The backup fails if the user does not exist on the sFTP server.

  • SSH Port

  • SSH Username

  • SSH Password

Click Test to test the connection using the credentials.

Step 7

Specify the backup start time and recurrence interval.

The time displayed in the date picker is the client browser time.

Step 8

(Optional) Enter the email IDs to which the backup status notification needs to be sent. Separate the email IDs using comma.

Configure the SMTP server details in the Cisco Prime Collaboration Assurance server (E-mail Setup for Alarms & Events) to receive emails.

For Cisco Prime Collaboration Release 11.5 and later

Configure the SMTP server details in the Cisco Prime Collaboration Assurance server (Alarm & Report Administration > E-mail Setup for Alarms & Events) to receive emails.

Step 9

Click Save.

The scheduled backup job is listed on the Backup Management page.

You can click Run Now to run the backup immediately.

Troubleshooting

Issue: Cisco Prime Collaboration Assurance backup job status shows failure even after generating the reports. The backup files are generated and stored in a sFTP location when a backup job is scheduled in the Cisco Prime Collaboration Assurance. A non-zero size file is created at the location. The job scheduled in the Cisco Prime Collaboration Assurance is in the failed state every time it is executed.

Expectation: The job must not fail or if it fails there must be reasons for failure.

The Cisco Prime Collaboration Assurance backup job status displays failure in spite of generating reports in sFTP. Hence, while backing up, modify the path of the sFTP server. Use a non-root user location for setting up the sFTP location for reports in the Cisco Prime Collaboration Assurance. The issue is due to the absence of the GPG key in the user folder.

The sFTP location for backup can be any other directory other than the root directory since GPG encryption is not enabled for the root directory.

If you choose the location under the root directory, then you must enable GPG encryption in the root directory.

Backup Cisco Prime Collaboration Assurance Data using CLI

CLI is supported only through SSH; telnet is not supported. The port used for Cisco Prime Collaboration server is 26. After creating the repository, log in to the Cisco Prime Collaboration server as admin and run the following command to back up the data: 


admin# backup Backupfilename repository RepositoryName application cpcm

Where,

  • Backupfilename—Name of the backup file (without the extension-.tar.gpg). This name can be a maximum of 100 alphanumeric characters.

  • RepositoryName—Location to which the files are be backed up. This name can contain a maximum of 30 alphanumeric characters.

The following message is displayed after the backup is complete: 


% Creating backup with timestamped filename: Backupfilename-Timestamp.tar.gpg

The backup file is suffixed with the time stamp (YYMMDD-HHMM) and file extension .tar.gpg and saved in the repository.

For example, in case of backup on the ftp server: 


admin# backup assurance repository myftp application cpcm

where, myftp is a repository name.

Check the Backup History

You can check the backup history. Log in to the Cisco Prime Collaboration Assurance server.

Path: System Administration > Backup Settings

All the backups scheduled or configured are listed on the Backup Settings page. You can check the history from the Run History column. Click the hyperlink on each log listed in the column for more information.

Restore Data on the Same System

The following sections describe the process of restoring the data on the same system.

To restore the data, log in to the Cisco Prime Collaboration application server as admin through VM console using vSphere client. we recommend you to not to trigger the restore from SSH/Putty prompt.

Run the following command to restore the Cisco Prime Collaboration data:

admin# restore Backupfilename repository RepositoryName application cpcm

Where, Backupfilename is the name of the backup file suffixed with the timestamp (YYMMDD-HHMM) and file extension .tar.gpg.

For example, to restore on the ftp server: 


admin# restore assurance_Sun_Feb_09_14_20_30_CST_2014.tar.gpg repository myftp application cpcm

Restore on a New System

Cisco Prime Collaboration allows you to back up the data of a system and restore the data in another system in the event of total system failure.

To restore the backup from another system:

Ensure that the system to which data is restored must have the same MAC address as that of the system that was backed up (IP address and the hostname can be different).

In the case you are unable to assign the MAC address of the original system (that was backed up) to another system, contact Cisco TAC for information on a new license file (for a new MAC address).

To restore the backup from another system, log in as administrator through the VM console using vSphere Client and perform restore as described in Restore Data. See also, Create a Repository.


Note
As a post requirement, you must rediscover all the devices after restoring the data.

Was this Document Helpful?

FeedbackFeedback

Contact Cisco