Cisco IPICS Server Quick Start Guide, Release 2.1(1)
Maintaining the Cisco IPICS System
Downloads: This chapterpdf (PDF - 394.0KB) The complete bookPDF (PDF - 1.23MB) | Feedback

Maintaining the Cisco IPICS System

Table Of Contents

Maintaining the Cisco IPICS System

Cisco IPICS Serviceability

Viewing Real-Time System Status in the Dashboard Window

Viewing and Downloading Diagnostic Information

Viewing and Downloading the Cisco IPICS System Logs

Cisco IPICS Database Management

Backing Up the System

Choosing the Destination for a Backup

Restoring the System


Maintaining the Cisco IPICS System


Cisco IPICS provides a centralized location for diagnostic and status information, in the Serviceability drawer in the Administration Console. System administrators can use this information for troubleshooting Cisco IPICS issues. The Serviceability drawer allows access to windows that contain system status, diagnostics, and system log information for Cisco IPICS.

This section includes information about using the windows in the Serviceability drawer in the "Cisco IPICS Serviceability" section.

Cisco IPICS Serviceability

From the Serviceability drawer in the Administration Console, you can monitor system status in the various windows.

The following sections provide an overview of some of the system status monitoring tasks that can be performed in the Serviceability drawer:

Viewing Real-Time System Status in the Dashboard Window

Viewing and Downloading Diagnostic Information

Viewing and Downloading the Cisco IPICS System Logs

Viewing Real-Time System Status in the Dashboard Window

Cisco IPICS provides you with current, real-time information regarding the overall status of the system. You can access this information in the Serviceability > Dashboard window. This window lists the resources that Cisco IPICS uses, and includes the following dashboards:

System Dashboard—Displays information about the Cisco IPICS policy engine, server memory and hard disk usage, and multicast address information.

Channel Dashboard—Displays information about the total number of channels, the number of enabled, disabled, active, and connected channels in your system, and the current status of those channels.

Virtual Talk Group Dashboard—Displays information about the number of VTGs and inactive VTGs in your system.

User Dashboard—Displays information about the number of users who are logged in to the Administration Console, the number of users who are logged in to Cisco IPICS by using a Cisco Unified IP Phone, and the number of users who are logged in to Cisco IPICS by using the PMC.

License Dashboard—Displays information about the total and available number of ports that are licensed for use with Cisco IPICS.

RMS Dashboard—Displays information about the available number of voice ports that you system is licensed to use.


Note To refresh the real-time information that displays in this window and obtain the latest data, click Refresh at the top of the window.


Viewing and Downloading Diagnostic Information

You can view diagnostic information for various Cisco IPICS components by navigating to the Serviceability > Diagnostics window. When you access this window, Cisco IPICS displays a summary of diagnostic information that includes the following elements:

Cisco IPICS Server Hostname—Displays the host name of the Cisco IPICS server. You can also obtain this information by entering the following command in a Cisco IPICS terminal window session:

[root]# hostname

Cisco IPICS Server Current Date and Time—Displays the current date and time of the Cisco IPICS server. You can also obtain this information by entering the following command in a Cisco IPICS terminal window session:

[root]# date

Cisco IPICS Server OS Version—Displays the version of the Cisco IPICS operating system that is currently installed on the server. You can also obtain this information by entering the following command in a Cisco IPICS terminal window session:

[root]# cat /etc/redhat-release

Cisco IPICS Server Software Version—Displays the current version of the Cisco IPICS server software. You can also obtain this information by entering the following command in a Cisco IPICS terminal window session:

[root]# grep -i "ipics.server.version=" ${TOMCAT_HOME}/webapps/ipics_server/WEB-INF/classes/resources/common.properties


Note Be sure to include the quotation marks when you enter this command. The grep command searches for the text string that is inside the quotation marks.


Cisco IPICS Server Software Version upgrade history—Displays the date and time that the current version of Cisco IPICS was installed and provides a history, with release versions, of the times that the software has been installed or upgraded. You can also obtain this information by entering the following command in a Cisco IPICS terminal window session:

[root]# cat /etc/ipics-release.history

Hardware Platform Details—Displays detailed information for the hardware platform. You can also obtain this information by entering the following command in a Cisco IPICS terminal window session:

[root]# cat /etc.hwprofile

CPU Details—Displays detailed information for the CPU. You can also obtain this information by entering the following command in a Cisco IPICS terminal window session:

[root]# cat /proc/cpuinfo

Cisco IPICS Server Network Interface Card Information—Displays the configuration of the Network Interface Cards (NICs), and the packets that have been transmitted and received on the NICs, that are installed on the Cisco IPICS server. You can also obtain this information by entering the following command in a Cisco IPICS terminal window session:

[root]# ifconfig

Uploaded License File Name(s)—Displays the name of the license file(s) that have been uploaded onto the Cisco IPICS server. You can also obtain this information by entering the following command in a Cisco IPICS terminal window session:

[root]# ls -l ${TOMCAT_HOME}/webapps/license/*

Uploaded License File Contents—Displays the contents of the license files that have been uploaded onto the Cisco IPICS server. You can also obtain this information by entering the following command in a Cisco IPICS terminal window session:

[root]# cat ${TOMCAT_HOME}/webapps/license/*

Cisco IPICS Database Status—Displays the current status of the database. The database can be either online or offline. You can also obtain this information by entering the following command in a Cisco IPICS terminal window session:

[root]# onstat -

Cisco IPICS Tomcat Web Server Status—Displays the current status of the Tomcat service. The Tomcat service functions as the Web server. You can also obtain this information by entering the following command in a Cisco IPICS terminal window session:

[root]# ps -ef | grep tomcat


Note If the Tomcat service is inactive (down), you may not be able to access the Administration Console. In specific situations, your Cisco technical support representative may direct you to manually run the ps -ef | grep tomcat script to gather details about the overall state of the system.


Cisco IPICS Server Hard Disk Utilization Information—Displays usage information for the hard disks in the server. You can also obtain this information by entering the following command in a Cisco IPICS terminal window session:

[root]# df -a

Cisco IPICS Configuration File Contents—Displays the contents of the pmc.ini file. You can also obtain this information by entering the following command in a Cisco IPICS terminal window session:

[root]# cat $ {TOMCAT_HOME}/webapps/ipics_server/pmcdownloads/
pmc.ini

Cisco IPICS uses the pmc.ini file to determine how to communicate with the Cisco IPICS server. The pmc.ini file is present only if you have generated a PMC installer. If you have not yet generated the PMC installer file, Cisco IPICS displays the following message:

Cannot find any pmc.ini files under the /opt/cisco/ipics/tomcat/current/
webapps/ipics_files/store/installer folder.

For more information about generating the PMC installer, refer to "Managing PMC Versions" in the Cisco IPICS Server Administration Guide, Release 2.1(1).

You have the ability to execute the diagnostic script or download diagnostic results by clicking the buttons that display under the Diagnostic Summary pane.


Note The PC from which you access the Cisco IPICS Administration Console must have an application installed, such as Win Zip, that can open, and extract files from, a tar file archive.

You must also use a text file viewer that can understand UNIX new-line characters, such as WordPad. If you use Notepad, the file does not display properly.


Viewing and Downloading the Cisco IPICS System Logs

The system logs that you view in the Serviceability > System Logs window contain messages of different severities, ranging from informational-level messages to messages that indicate a fatal error has occurred in Cisco IPICS.

Table 4-1 describes the types of system log entries that can display in the Recent System Log Entries pane.

Table 4-1 System Log Entry Types 

Log Entry Type
Purpose

TRACE

Detailed debug information about the programmatic steps that Cisco IPICS performs to fulfill a request.

DEBUG

Debug information that is less detailed than TRACE information.

INFO

Informational messages about noteworthy events, such as the start of a scheduled policy.

WARN

Warning messages about occurrences such as incorrect user input or requests that Cisco IPICS cannot fulfill.

ERROR

Messages that are similar to a WARN message, but with higher severity, such as in the case of insufficient licenses. ERROR messages display in red in the Recent System Log Entries pane.

FATAL

An unrecoverable error that requires your attention, such as a failed database connection or a router initialization failure. Often a FATAL error requires you to take immediate action to fix the specified error.

When a FATAL error occurs, Cisco IPICS generates an error notification message and displays the message prominently in the current window of any user with system administrator or All privileges. Also, FATAL messages display in red in the Recent System Log Entries pane.

If you continue to encounter FATAL errors, or if you experience unexpected system failures, contact your Cisco technical support representative for further analysis.


To visually identify the type of status message that appears in this window, Cisco IPICS displays log entries of different severities in the following text colors:

Red—Red messages indicate that an ERROR-level error has occurred.

Blue—Blue messages indicate that a WARNING-level error has occurred.

Black—Black messages indicate that an INFO-level error has occurred.

You can view the total number of ERROR, WARNING, and INFO messages in the Status Summary area, which is directly below the Recent System Logs pane.


Note By default, the TRACE and DEBUG messages are not captured in the system logs. You should not activate these logging levels unless you are specifically instructed to do so by your Cisco technical support representative.


Cisco IPICS displays the most current system log information in the System Logs window and allows you to download all the system logs.

Cisco IPICS records system log information in the ipics.log file and continues to add data to it until the file reaches approximately 5.2 MB. When that file size limit has been reached, Cisco IPICS renames the file with an incremental number (starting at 1) and creates a new ipics.log file to capture the most current log data. This process continues until there are 10 system log files that range from ipics.log.1 to ipics.log.10. Cisco IPICS automatically purges the oldest file when you have accumulated 10 files.

When you download the system logs in the Serviceability > System Logs window, Cisco IPICS creates a zip file of all the ipics.log files. The system logs are located in the following directory:

/opt/cisco/ipics/tomcat/current/logs

Cisco IPICS Database Management

As a best practice, Cisco recommends that you back up your Cisco IPICS database on a regular basis and maintain your backups in a secure location. This practice ensures that you do not lose all system configuration if your Cisco IPICS server experiences a software or hardware failure.

Cisco IPICS performs regularly scheduled database backups to preserve your data. If you need to configure specific database parameters, you can do so in the Administration > Database Management window.

You can back up and restore data from a backed-up database, and then download and view the logs in the Database Management window in the Administration Console. You can also export and import the database using command line interface commands.


Note For optimum performance, Cisco recommends that you back up your database during periods of low activity or other off-peak hours. If you perform a backup during periods of high activity, the length of time that it takes to complete this operation can be significantly increased.


This section includes the following database management topics:

Backing Up the System

Restoring the System

Backing Up the System

Cisco IPICS provides you with the following options for database backups:

Manual backups—You can perform a manual database backup to capture the current state of the Cisco IPICS database.


Note Use the Remote Host option only if the remote host supports the Linux Secure Copy (scp) command. If you are using a remote host that does not support scp (for example, a Windows PC or server), click the Local Directory radio button. You must back up your data to the Cisco IPICS server, then use a secure file transfer protocol (SFTP) client software program, such as SSH Secure Shell Client software (or similar software), to copy the backup files to a remote host. Refer to "Performing Cisco IPICS Database Backup and Restore Operations" in the Cisco IPICS Server Administration Guide, Release 2.1(1) for detailed information about how to back up your files to a remote host that does not support scp.


Scheduled backups—By default, Cisco IPICS backs up the database every day at a predefined time and stores the backup in a predefined location. You can define the time, frequency, and the location of the backed-up database. After you modify the default settings for a scheduled backup, you click Save and the new settings become the default settings, and remain in effect until you change them.


Caution Be sure to click Save after you make any changes. If you do not click Save, the server reverts to the current default settings.

As a best practice, make sure that you adhere to the following guidelines when you perform Cisco IPICS backup and restore procedures:

To ensure data integrity in the event of a system failure, Cisco recommends that you back up your files to a remote host location.

Cisco recommends that you regularly check the database logs for status messages and/or error information that may be pertinent to recent backup and recovery activity.

To view the backup log, navigate to the Administration > Database Management > Database Backup window. Log entries display in the Backup Log pane.

To view and/or download the database logs, navigate to the Administration > Database Management > Log window.

To help ensure the security of your data, Cisco IPICS does not support the use of different user IDs for remote backup and restore operations that you perform on the same data set. Therefore, when you restore your data, make sure that you specify the same user ID as the one that you used to back up your data. If you specify a different user ID, the restore procedure does not succeed because of file accessibility issues; in this situation, Cisco IPICS displays "permission denied" error messages in the db-maintenance.log. As a best practice, Cisco recommends that you designate a specific user ID that you can use for all of your remote backup and restore activities.

Choosing the Destination for a Backup

When you specify the options for a scheduled backup, or when you perform a manual backup, you should determine the best location to store the backup. The location for the database backup can be to the default directory of the local Cisco IPICS server, to another directory of the local server, or to a remote host.

You can choose from the following types of locations for your database backup:

Default—This directory is the default location that Cisco IPICS uses. When you choose this location, the backups are stored in the /idspri/backup directory.

Local Directory—Use this option to specify a directory for the backup. Cisco prepopulates the Local Directory field with the idspri/backup/cron directory. You can remove the /cron subdirectory in the field to place your files in the /idspri/backup directory. However, if you back up your files to a local directory in the server, that directory must be a subdirectory of the /idspri/backup directory. Any directory within the /idspri/backup directory, (for example, /idspri/backup/mybackups) is valid as a location for a database backup. If the directory that you specify does not exist, Cisco IPICS creates the directory for you.


Note Make sure that you enter the path within /idspri/backup directory in the Cisco IPICS server, and that you precede the destination path with a forward slash (/). If you do not specify a forward slash, Cisco IPICS displays a pop-up window with an error and does not perform the backup.


Remote Host—Choose this option to back up your database to a remote location.


Note Use the Remote Host option only if the remote host supports the Linux Secure Copy (scp) command. If you are using a remote host that does not support scp (for example, a Windows PC or server), click the Local Directory radio button. You must back up your data to the Cisco IPICS server, then use a secure file transfer protocol (SFTP) client software program, such as SSH Secure Shell Client software (or similar software), to copy the backup files to a remote host. For more information, refer to "Backing Up Data to a Remote Host Without scp Support" in the Cisco IPICS Server Administration Guide, Release 2.1(1).


When you choose this option, you must specify the following information:

Remote Host IP Address—Enter the IP address of the remote host.

User Name—Enter a valid user name for access to the remote host

User Password—Enter a valid password for this user.

Remote Directory—Enter the location of the full directory path on the remote host where you want the database to be stored.

Cisco recommends that you use the following guidelines when choosing a destination for your Cisco IPICS database backups:

Choose a remote host location when you back up your database. Using the remote host option ensures that you have a location for your backups that cannot be affected by any hardware or software failures that might occur with the Cisco IPICS server.

For an extra safeguard, you can also copy or move a database backup from one remote host to another for redundancy purposes.

Manually perform a database backup to a remote host before you uninstall, reinstall, or upgrade the Cisco IPICS server software to ensure that you have a copy of the most recent data.

The Cisco IPICS software requires the Cisco IPICS operating system to operate. If you reinstall the Cisco IPICS operating system software on your server, the installation process formats the hard drive and removes all data from your server. To prevent the loss of all of your backups, you should back up your database to a remote location prior to installing the Cisco IPICS operating system.

For this backup, choose the remote host option only if the remote host supports the scp command, such as a Linux server. To back up your data to a remote host that does not support scp, such as a Windows-based PC or server, choose the local directory option.

To back up your files to a Linux-based server, use the remote host option before you install the new Cisco IPICS operating system.

To back up your files to a Windows-based machine, use the local directory option; then, use the SSH Secure Shell Client software, or similar software, to perform a secure copy (scp) to the Windows-based machine.

Restoring the System

You may need to restore your database if you encounter any of the following situations:

You have to reinstall the server software, and you need to restore the database to the state that it was in before you reinstalled the software.

Server data, such as channels, channel groups, or VTG templates, were deleted from the database mistakenly and you need to retrieve them.

You need to copy a database from one Cisco IPICS server to another. You copy the database by performing a database backup from one server, and restoring the database from that backup to another server.


Note You can restore data from one server to another only if both servers are running the same version of Cisco IPICS software. If the software versions of the two servers differ, the database schema might not be the same. In this case, the restore operation may not succeed or you could encounter unpredictable errors when you perform tasks in the Administration Console.



Caution Be aware that a restore operation logs all users out of the Cisco IPICS database, and users cannot log in to Cisco IPICS until the restore operation completes. To minimize any disruption that the restore operation may cause to users, Cisco recommends that you perform a restore procedure during maintenance operations or other off-peak hours.

You can choose from the following options to restore your data:

Default—Choose this option to restore your data from the default location, which is /idspri/backup. If you backed up your database in the default location, choose this option. If there is more than one database backup in the default directory (for example, if you perform regularly scheduled database backups), Cisco IPICS uses the most recent backup for the restore operation.

Local Directory (requires full path)—Choose this option to restore your data from the local directory that you specify.

When you specify a local directory or remote host for your restore operation, make sure that you specify the entire directory path and that you include the following directories in the directory path:

The /idspri/backup directory—Cisco IPICS stores every backup to a local directory in the /idspri/backup directory.

The IDSB_yyyy-mm-dd_hh-mm-ss directory that Cisco IPICS created when it performed the database backup.

Remote Host—Choose this option to restore your data from a remote host, in the directory location that you specify.

When you choose to restore your data from a remote host, you must specify the following information:

Remote Host IP Address—Enter the IP address of the remote host.

User Name—Enter a valid user name for access to the remote host.

The user name to restore the database must be the same user name that you used to back up the database. If you specify a different user name, the restore procedure does not succeed because the user does not have the correct permissions to access the database backup.

User Password—Enter a valid password for this user.

Remote Directory—Enter the directory path for the remote host from which you want the database to be restored. Enter the full directory path, including the directory that was generated by Cisco IPICS for the database backup, for example /mybackups/IDSB_2006-08-25_17-13-55.


Note Be sure to enter the correct user name, password, and remote directory; otherwise, the scp process fails. If the scp process fails, you can determine the cause of the failure by checking the logs in the Administration > Database Management > Log window.


A restore operation does not allow you to view the log details of the operation while it is in progress. The Tomcat service restarts during the restore operation and automatically logs all users out of Cisco IPICS. You must wait for the restore process to complete before you can log in again.


Tip You can check the status of the restore process in the /opt/cisco/ipics/database/logs/db-maintenance.log file on the Cisco IPICS server. For more information, refer to "Checking the Restore Status in the Database Log" in the Cisco IPICS Server Administration Guide, Release 2.1(1).