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.
Cisco Unified Serviceability and Cisco Unified IM and Presence Serviceability alarms provide information on runtime status and the state of the system, so you can troubleshoot problems that are associated with your system; for example, to identify issues with the Disaster Recovery System. Alarm information, which includes an explanation and recommended action, also includes the application name, machine name, and so on, to help you perform troubleshooting and also applies to clusters.
You configure the alarm interface to send alarm information to multiple locations, and each location can have its own alarm event level (from Debug to Emergency). You can direct alarms to the Syslog Viewer (local syslog), Syslog file (remote syslog), an SDL trace log file (for Cisco CallManager and CTIManager services only), or to all destinations.
When a service issues an alarm, the alarm interface sends the alarm information to the locations that you configure and that are specified in the routing list in the alarm definition (for example, SDI trace). The system can either forward the alarm information, as is the case with SNMP traps, or write the alarm information to its final destination (such as a log file).
You can configure alarms for services, such as Cisco Database Layer Monitor, on a particular node, or you configure alarms for a particular service on all nodes in the cluster.
Note |
Cisco Unity Connection SNMP does not support traps. |
Tip |
For the Remote Syslog Server, do not specify a Cisco Unified Communications Manager server, which cannot accept syslog messages from other servers. |
You use the Trace and Log Central option in the Cisco Unified Real-Time Monitoring Tool (Unifed RTMT) to collect alarms that get sent to an SDL trace log file (for Cisco CallManager and CTIManager services only). You use the SysLog Viewer in Unifed RTMT to view alarm information that gets sent to the local syslog.
You can configure alarms for services, such as Cisco Database Layer Monitor, in Cisco Unified Serviceability. Then, you configure the location or locations, such as Syslog Viewer (local syslog), where you want the system to send the alarm information. With this option, you can do the following:
Cisco Syslog Agent enterprise parameters in Cisco Unified Communications Manager Administration allow you to forward all alarms that meet or exceed the configured threshold to a remote syslog server with these two settings: remote syslog server name and syslog severity. To access these Cisco Syslog Agent parameters, go to the applicable window for your configuration:
Cisco Unified Communications Manager |
In Cisco Unified Communications Manager Administration, choose . |
Cisco Unity Connection |
In Cisco Unity Connection Administration, choose . |
Cisco IM and Presence |
In Cisco Unified Communications Manager IM and Presence Administration, choose . |
The alarms include system (OS/hardware platform), application (services), and security alarms.
The event level/severity settings provide a filtering mechanism for the alarms and messages that the system collects. This setting helps to prevent the Syslog and trace files from becoming overloaded. The system forwards only alarms and messages that exceed the configured threshold.
For more information about the severity levels attached to alarms and events, see the Alarm definitions.
Used for reference, alarm definitions describe alarm messages: what they mean and how to recover from them. You search the Alarm Definitions window for alarm information. When you click any service-specific alarm definition, a description of the alarm information (including any user-defined text that you have added) and a recommended action display.
You can search for alarm definitions of all alarms that display in the Serviceability GUI. To aid you with troubleshooting problems, the definitions, which exist in a corresponding catalog, include the alarm name, description, explanation, recommended action, severity, parameters and monitors.
When the system generates an alarm, it uses the alarm definition name in the alarm information, so you can identify the alarm. In the alarm definition, you can view the routing list, which specifies the locations where the system can send the alarm information. The routing list may include the following locations, which correlate to the locations that you can configure in the Alarm Configuration window:
Tip |
If the SNMP Traps location displays in the routing list, the system forwards the alarm information to the CCM MIB SNMP agent, which generates traps according to the definition in CISCO-CCM-MIB. |
The system sends an alarm if the configured alarm event level for the specific location in the Alarm Configuration window is equal to or lower than the severity that is listed in the alarm definition. For example, if the severity in the alarm definition equals WARNING_ALARM, and, in the Alarm Configuration window, you configure the alarm event level for the specific destination as Warning, Notice, Informational, or Debug, which are lower event levels, the system sends the alarm to the corresponding destination. If you configure the alarm event level as Emergency, Alert, Critical, or Error, the system does not send the alarm to the corresponding location.
For each alarm definition, you can include an additional explanation or recommendation. All administrators have access to the added information. You directly enter information into the User Defined Text pane that displays in the Alarm Details window. Standard horizontal and vertical scroll bars support scrolling. Cisco Unified Serviceability adds the information to the database.
You view alarm information to determine whether problems exist. The method that you use to view the alarm information depends on the destination that you chose when you configured the alarm. You can view alarm information that is sent to the SDL trace log file (Cisco Unified Communications Manager) by using the Trace and Log Central option in Unified RTMT or by using a text editor. You can view alarm information that gets sent to local syslog by using the SysLog Viewer in Unified RTMT.
You can configure the Cisco Syslog Agent enterprise parameters to send system, application, and security alarms/messages that exceed the configured threshold to a remote syslog server that you specify. To access the Cisco Syslog Agent parameters, go to the applicable window for your configuration:
In Cisco Unified Communications Manager Administration, choose . |
|
Cisco IM and Presence |
In Cisco Unified Communications Manager IM and Presence Administration, choose . |
Next, configure the remote syslog server names (Remote Syslog Server Name 1, Remote Syslog Server Name 2, Remote Syslog Server Name 3, Remote Syslog Server Name 4, and Remote Syslog Server Name 5) and syslog severity. Ensure that you specify valid IP addresses while configuring the server names. The syslog severity is applicable to all the remote syslog servers that you configure. Then click Save. For the valid values to enter, click the ? button. If no server name is specified, Cisco Unified Serviceability does not send the Syslog messages.
Caution |
While configuring remote syslog servers in Cisco Unified Communications Manager, do not add duplicate entries for remote syslog server names. If you add duplicate entries, the Cisco Syslog Agent will ignore the duplicate entries while sending messages to the remote syslog servers. |
Note |
Do not configure a Cisco Unified Communications Manager as a remote syslog server. The Cisco Unified Communications Manager node does not accept Syslog messages from another server. |
This section describes how to add or update an alarm for a feature or network service that you manage through Cisco Unified Serviceability.
Note |
Cisco recommends that you do not change SNMP Trap and Catalog configurations. |
Cisco Unity Connection also uses alarms, which are available in Cisco Unity Connection Serviceability. You cannot configure alarms in Cisco Unity Connection Serviceability. For details, see the Cisco Unity Connection Serviceability Administration Guide.
Refer to your online OS documentation for more information on how to use your standard registry editor.
Step 1 |
Choose . The Alarm Configuration window displays. |
||
Step 2 | From the Server drop-down list, choose the server for which you want to configure the alarm; then, click Go. | ||
Step 3 |
From the Service Group drop-down list, choose the category of service, for example, Database and Admin Services, for which you want to configure the alarm; then, click Go.
|
||
Step 4 |
From the Service drop-down list, choose the service for which you want to configure the alarm; then, click Go. Only services that support the service group and your configuration display.
In the Alarm Configuration window, a list of alarm monitors with the event levels displays for the chosen service. In addition, the Apply to All Nodes check box displays. |
||
Step 5 | Cisco Unified Communications Manager only: If you want to do so, you can apply the alarm configuration for the service to all nodes in the cluster by checking the Apply to All Nodes check box, provided your configuration supports clusters. | ||
Step 6 | Configure the settings, as described in Alarm configuration settings, which includes descriptions for monitors and event levels. | ||
Step 7 |
To save your configuration, click the Save button.
|
Tip |
The system sends the alarm if the configured alarm event level for the specific destination in the Alarm Configuration window is equal to or lower than the severity that is listed in the alarm definition. For example, if the severity in the alarm definition equals WARNING_ALARM, and, in the Alarm Configuration window, you configure the alarm event level for the specific destination as Warning, Notice, Informational, or Debug, which are lower event levels, the system sends the alarm to the corresponding destination. If you configure the alarm event level as Emergency, Alert, Critical, or Error, which are higher severity levels, the system does not send the alarm to the corresponding location. To access the alarm definitions for the Cisco Extension Mobility Application service, Cisco Unified Communications Manager Assistant service, Cisco Extension Mobility service, and the Cisco Web Dialer service, choose the JavaApplications catalog in the Alarm Messages Definitions window described in Alarm definitions. |
The following services use Cisco Tomcat for alarm generation:
The system login alarm AuthenticationFailed also uses Cisco Tomcat. To generate alarms for these services, perform the following procedure.
Step 1 | In Cisco Unified Serviceability, choose . |
Step 2 | From the Server drop-down list, choose the server for which you want to configure the alarm; then, click Go. |
Step 3 | From the Services Group drop-down list, choose Platform Services; then, click Go. |
Step 4 | From the Services drop-down list, choose Cisco Tomcat; then, click Go. |
Step 5 | Unified Commuications Manager only: If you want to do so, you can apply the alarm configuration for the service to all nodes in the cluster by checking the Apply to All Nodes check box, if your configuration supports clusters. |
Step 6 | Configure the settings, as described in Alarm configuration settings, which includes descriptions for monitors and event levels. |
Step 7 | To save your configuration, click the Save button. |
Note | Not all listed service groups and services apply to all system configurations. |
Cisco CTIManager, Cisco CallManager, Cisco IP Phone Service, Cisco DHCP Monitor Service, Cisco Dialed Number Analyzer, Cisco Dialed Number Analyzer Server, Cisco Extended Functions, Cisco IP Voice Media Streaming App, Cisco Messaging Interface, and Cisco TFTP
CTI Services
Cisco IP Manager Assistant, Cisco WebDialer Web Service, and Self-Provisioning IVR
Cisco CAR Scheduler, Cisco CDR Agent, and Cisco CDR Repository Manager
Cisco Bulk Provisioning Service, Cisco Database Layer Monitor, and Cisco License Manager
Name | Description | ||
---|---|---|---|
From the drop-down list, choose the server (node) for which you want to configure the alarm; then, click Go. |
|||
Cisco Unity Connection supports only the following service groups: Database and Admin Services, Performance and Monitoring Services, Backup and Restore Services, System Services, and Platform Services. From the drop-down list, choose the category of services, for example, Database and Admin Services, for which you want to configure the alarm; then, click Go. |
|||
From the Service drop-down list, choose the service for which you want to configure the alarm; then, click Go. Only services that support the service group and your configuration display.
|
|||
Unified Communications Manager and Cisco Unified Communications Manager IM and Presence Service only: |
To apply the alarm settings for the service to all nodes in a cluster, check the check box. |
||
The SysLog viewer serves as the alarm destination. The program logs errors in the Application Logs within SysLog Viewer and provides a description of the alarm and a recommended action. You can access the SysLog Viewer from the Cisco Unified Real-Time Monitoring Tool. For information on viewing logs with the SysLog Viewer, refer to the Cisco Unified Real-Time Monitoring Tool Administration Guide. |
|||
The Syslog file serves as the alarm destination. Check this check box to enable the Syslog messages to be stored on a Syslog server and to specify the Syslog server name. If this destination is enabled and no server name is specified, Cisco Unified Serviceability does not send the Syslog messages. The configured AMC primary and failover collectors use the remote syslog settings. The remote syslog settings used by the collectors are those configured on the respective individual nodes. If the remote syslog is only configured on AMC primary collector without configuring remote syslog on AMC failover collector and failover occurs in AMC primary collector, then no remote syslogs will be generated. You must configure exactly the same settings on all nodes, to send the remote syslog alarms to the same remote syslog server. When failover occurs in AMC controller or when the collector configuration changes to a different node, the remote syslog settings on a backup or newly configured node is used. To prevent too many alarms flooding the system, you can check the Exclude End Point Alarms check box. This ensures that the endpoint phone-related events get logged into a separate file. Exclude End Point Alarms check box is displayed only for the CallManager services, and is not checked by default. You need to check the Apply to All Nodes also, when you check this check box. The configuration options for endpoint alarms are listed in Alarm configuration settings.
|
|||
Remote Syslog Servers |
In each of the Server Name 1, Server Name 2, Server Name 3, Server Name 4, and Server Name 5 fields, enter the name or IP address of the remote syslog server that you want to use to accept syslog messages. For example, if you want to send the alarms to Cisco Unified Operations Manager, specify the Cisco Unified Operations Manager as the server name.
|
||
The SDI trace library serves as the alarm destination. To log alarms, check this check box and check the Trace On check box in the Trace Configuration window for the chosen service. For information on configuring settings in the Trace Configuration window in Cisco Unified Serviceability, see Set up trace parameters. |
|||
Unified Communications Manager and Unified Communications Manager BE only: |
The SDL trace library serves as the alarm destination. This destination applies only to the Cisco CallManager service and the CTIManager service. Configure this alarm destination by using Trace SDL configuration. To log alarms in the SDL trace log file, check this check box and check the Trace On check box in the Trace Configuration window for the chosen service. For information on configuring settings in the Trace Configuration window in Cisco Unified Serviceability, see the Set up trace parameters. |
||
|
The following tables describe the default alarm configuration settings.
This section provides procedural information to search, view, and create user information for alarm definitions that display in the Serviceability interface.
Tip |
Cisco Unified Communications Manager and Cisco Unity Connection only: You can view Cisco Unity Connection alarm definitions in Cisco Unity Connection Serviceability. You cannot add user-defined descriptions to alarm definitions in Cisco Unity Connection Serviceability. Cisco Unity Connection also uses certain alarm definitions in Cisco Unified Serviceability, and they must be viewed in Cisco Unified Serviceability. Be aware that alarms that are associated with the catalogs in System catalogs are available for viewing. |
Step 1 | Select . | ||
Step 2 | Perform one of the following actions: | ||
Step 3 | Select Find. | ||
Step 4 | Perform one of the following actions if multiple pages of alarm definitions exist: | ||
Step 5 | Select the alarm definition for which you want alarm details. | ||
Step 6 |
Enter text in the User Defined Text field if you want to add information to the alarm, and then select Save.
|
||
Step 7 | Select Save. | ||
Step 8 | Select Back to Find/List Alarms from the Related Links drop-down list if you want to return to the Alarm Message Definitions window. | ||
Step 9 | Select Go. |
The following table contains the System Alarm Catalog alarm descriptions. The System Alarm Catalog supports Cisco Unified Communications Manager and Cisco Unity Connection.
All cluster manager alarm definitions that are related to the establishment of security associations between servers in a cluster. |
|||||
All Java Applications alarm definitions.
|
|||||
All log partition monitoring and trace collection alarm definitions |
|||||
All Cisco Unified Real-Time Monitoring Tool alarm definitions |
|||||
All alarm definitions that are used for tracking whether SystemAccess provides all thread statistic counters together with all the process statistic counters. |
|||||
All service manager alarm definitions that are related to the activation, deactivation, starting, restarting, and stopping of services. |
|||||
All alarm definitions that are used for sending test alarms through SNMP traps from the command line interface (CLI). For information on the CLI, refer to the Command Line Interface Reference Guide for Cisco Unified Solutions.
|
|||||
The information in this section does not apply to Cisco Unity Connection.
The following table contains the CallManager Alarm Catalog descriptions.
All Cisco computer telephony integration (CTI) manager alarm definitions |
|
All Cisco telephony call dispatcher service alarm definitions |
|
Alarms for Certificate Authority Proxy Function (CAPF) service |
|
SAMLSSOAlarmCatalog |
Alarms for SAML Single Sign On feature. |
The following table contains the IM and Presence Service Alarm Catalog description.
All Config Agent alarms that notify the IM and Presence Service SIP Proxy of configuration changes in the IM and Presence Service IDS database. |
|
All Intercluster Sync Agent alarms that synchronize end user information between IM and Presence Service clusters for intercluster routing. |
|
All Presence Engine alarms that collect information regarding the availability status and communications capabilities of a user. |
|
All SIP Proxy alarms that are related to routing, requestor identification, and transport interconnection. |
|
All simple object access protocol (SOAP) alarms that provide a secure SOAP interface to and from external clients using HTTPS. |
|
All Sync Agent alarms that keep the IM and Presence Service data synchronized with Cisco Unified Communications Manager data. |
|
All XCP alarms that collect information on the status of XCP components and services on IM and Presence Service. |
|
All server recovery manager alarms that relate to the failover and fallback process between nodes in a presence redundancy group. |
|
All Cisco XCP Config Manager alarm definitions that relate to XCP components. |
Alarm information, which includes an explanation and recommended action, also includes the application name, server name, and other information, to help you perform troubleshooting, even for problems that are not on your local IM and Presence Service node.
For more information about the alarms that are specific to the IM and Presence Service, see System Error Messages for IM and Presence on Cisco Unified Communications Manager.