PAWS Management service management

The Cisco PAWS-M platform contains network services and servlets that the system requires to function. Since these services are required for basic functionality, they do not require activation. However, you may need to stop and start (or restart) these services for troubleshooting purposes.

Alarms provide information on runtime status and the state of the system, so you can troubleshoot problems that are associated with your system. After viewing the alarm information, you can run a trace on the service. The trace files can help you further troubleshoot issues with your system.

This section contains information on services and describes how to troubleshoot issues using alarms and traces:

Services

After the installation of the Cisco PAWS-M platform, most services start automatically. You can configure services by setting service parameters for each service. If necessary, for example, for troubleshooting purposes, you may need to stop and start (or restart) a service. You can perform these task by using the command line interface (CLI) on the Cisco PAWS-M platform.

Cisco PAWS-M Platform Manager Service

The Cisco Platform Manager Service supports the PAWS-M application interface. This service must be active for the PAWS-M application to work correctly. It is active by default.

Performance and Monitoring Services

This section describes the Performance and Monitoring Services.

Cisco Log Partition Monitoring Tool

The Cisco Log Partition Monitoring Tool service supports the Log Partition Monitoring feature, which monitors the disk usage of the log partition on the Cisco PAWS-M platform by using configured thresholds and a polling interval.

This service, Alert Manager and Collector service, allows you to retrieve real-time information that exists on the server.

Cisco Audit Event Service

The Cisco Audit Event Service monitors and logs any configuration change to the Cisco PAWS-M platform by a user or as a result of the user action.

SOAP -Log Collection APIs Service

The Cisco SOAP-Log Collection APIs service allows you to collect log files and to schedule collection of log files on a remote SFTP server. Examples of log files that you can collect include syslog, core dump files, Cisco application trace files, and so on.

SOAP -Performance Monitoring APIs Service

The Cisco SOAP Performance Monitoring APIs service allows you to use performance monitoring counters for various applications through SOAP APIs; for example, you can monitor memory information per service, CPU usage, and so on.

Backup and Restore Services

This section describes the Backup and Restore Services.

Cisco DRF Master

The Cisco DRF Master Agent service supports the DRF Master Agent, which works with the CLI to schedule backups, perform restorations, view dependencies, check status of jobs, and cancel jobs, if necessary. The Cisco DRF Master Agent also provides the storage medium for the backup and restoration process.

Cisco DRF Local

The Cisco DRF Local service supports the Cisco DRF Local Agent, which acts as the workhorse for the DRF Master Agent. Components register with the Cisco DRF Local Agent to use the disaster recovery framework. The Cisco DRF Local Agent executes commands that it receives from the Cisco DRF Master Agent. Cisco DRF Local Agent sends the status, logs, and command results to the Cisco DRF Master Agent.

System Services

This section describes the System Services.

Cisco CDP

Cisco CDP advertises the voice application to other network management applications, so the network management application can perform network management tasks for the voice application.

Cisco Trace Collection Servlet

The Cisco Trace Collection Servlet, along with the Cisco Trace Collection Service, supports trace collection and allows users to view traces. If you stop this service, you cannot collect or view traces on the Cisco PAWS-M platform.

For SysLog Viewer and trace and log collection, the Cisco Trace Collection Servlet and the Cisco Trace Collection Service must run on the server.

Cisco Trace Collection Service

The Cisco Trace Collection Service, along with the Cisco Trace Collection Servlet, supports trace collection and allows users to view traces. If you stop this service, you cannot collect or view traces on the Cisco PAWS-M platform.

For SysLog Viewer and trace and log collection, the Cisco Trace Collection Servlet and the Cisco Trace Collection Service must run on the server.

Tip

If necessary, Cisco recommends that, to reduce the initialization time, you restart the Cisco Trace Collection Service before restarting Cisco Trace Collection Servlet.

Platform Services

This section describes the Platform Services.

Cisco Tomcat

The Cisco Tomcat service supports the web server.

Cisco Tomcat Stats Servlet

The Cisco Tomcat Stats servlet collects the Tomcat statistics.

Platform Administrative Web Service

Important:

This service should not be activated on the PAWS-M server

The Platform Administrative Web service is a SOAP API that can be activated on CUCM, CUP and UC systems, to allow the PAWS-M server to upgrade the system.

SNMP Master Agent

This service, which acts as the agent protocol engine, provides authentication, authorization, access control, and privacy functions that relate to SNMP requests.

Tip

After you complete SNMP configuration in the CLI, you must restart the SNMP Master Agent service.

MIB2 Agent

This service provides SNMP access to variables, which are defined in RFC 1213, that read and write variables; for example, system and interfaces.

Host Resources Agent

This service provides SNMP access to host information, such as storage resources, process tables, and installed software base. This service implements the HOST-RESOURCES-MIB.

System Application Agent

This service provides SNMP access to the applications that are installed and executing on the system. This implements the SYSAPPL-MIB.

Cisco CDP Agent

This service uses the Cisco Discovery Protocol to provide SNMP access to network connectivity information on the Cisco PAWS-M platform. This service implements the CISCO-CDP-MIB.

Cisco Syslog Agent

This service supports gathering of syslog messages that various components generate. This service implements the CISCO-SYSLOG-MIB.

Cisco Certificate Expiry Monitor

This service periodically checks the expiration status of certificates that the system generates and sends notification when a certificate gets close to its expiration date.

Working with Services

To start, stop, activate, or restart services or to configure service parameters for services on the Cisco PAWS-M platform, you must use the command line interface (CLI). You can start, stop, activate, or refresh only one service at a time. Be aware that when a service is stopping, you cannot start it until after the service is stopped. Likewise, when a service is starting, you cannot stop it until after the service is started.

The following services are activated by default after you install the Cisco PAWS-M platform.

Cisco AMC Service

Cisco Audit Event Service

Cisco CDP

Cisco CDP Agent

Cisco Certificate Expiry Monitor

Cisco DRF Local

Cisco DRF Master

Cisco Log Partition Monitoring Tool

Cisco Platform Manager Service

Cisco RIS Data Collector

Cisco Syslog Agent

Cisco Tomcat

Cisco Tomcat Stats Servlet

Cisco Trace Collection Servlet

Host Resources Agent

MIB2 Agent

SNMP Master Agent

System Application Agent

The following services are stopped by default after you install the Cisco PAWS-M platform.

Cisco Trace Collection Service

SOAP -Log Collection APIs

SOAP -Performance Monitoring APIs

The following services are deactivated by default after you install the Cisco PAWS-M platform.

Platform Administrative Web Service - this service should not be active on the PAWS-M server, this service should be activated on Application servers (CUCM, CUC, CUP) that will be upgraded, using the PAWS-Management server.

Caution

Some changes to service parameters may cause system failure. Cisco recommends that you do not make any changes to service parameters unless you fully understand the feature that you are changing or unless the Cisco Technical Assistance Center (TAC) specifies the changes.

The following table shows the commands that you need to work with services on the Cisco PAWS-M platform.

Table 1 Service CLI Commands

Task

Command

Display a list of services and service status

utils service list

Activate a service

utils service activate servicename

Stop a service

utils service stop servicename

Start a service

utils service start servicename

Restart a service

utils service restart servicename

Alarms

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.

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). Alarms can go to the Syslog Viewer (local syslog), Syslog file (remote syslog), SNMP traps, 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). The system can either forward the alarm information, as is the case with SNMP traps, or the system can write the alarm information to its final destination (such as a log file).

As soon as you enter the CLI command, the system will prompt you for the required parameters. Enter the values to see the output.

This table shows the commands that you need to work with alarms on the Cisco PAWS-M platform.

Table 2 Alarm CLI commands

Task

Command

Display the alarm configuration for a specific service/list of all services

show alarm

Required Parameter:

servicename: Name of the service. It can contain multiple words.

Example:

Enter the servicename as all to show the alarm configurations of all the services.

Enter the servicename as Cisco Tomcat to show the alarm configuration of Cisco Tomcat service.

Traces

Traces assist you in troubleshooting issues with your application. You use the CLI to specify the level of information that you want traced as well the type of information that you want to be included in each trace file. You can configure trace parameters for any service on the PAWS-M platform.

After you have configured information that you want to include in the trace files for the various services, you can collect and view trace files through trace and log collection. To do this, configure trace using the set trace CLI command.

You can configure the level of information that you want traced (debug level), what information you want to trace (trace fields), and information about the trace files (such as number of files per service, size of file, and time that the data is stored in the trace files).

Configuring Trace

You use the command line interface (CLI) to enable and disable tracing as well as to configure trace settings for specific services on the PAWS-M platform. As soon as you enter the CLI command, the system prompts you for the required parameters. For more information regarding trace collection, see the Collecting Traces (Logs) section.

The following table shows the commands required to work with traces on the PAWS-M platform:

Task

Command

Display the trace configuration for a specified service

show trace

Required Parameter:

servicename—Name of the service. It can contain multiple words.

Example:

Enter the servicename as all to show the trace configurations of all the services.

Enter the servicename as Cisco AMC Service to show the trace configuration of Cisco AMC service.

Display the trace levels available for a specified service

show tracelevels

Required Parameter:

servicename—Name of the service. It can contain multiple words.

Enable/Disable trace for a specified service

set trace status

Required Parameters:

status— enable or disable

servicename—Name of the service. It can contain multiple words.

Specify the debug trace level settings for a specified service

set trace tracelevel

Required Parameters:

tracelevel—Use show tracelevels CLI command to find the trace levels for a given servicename.

servicename—Name of the service. It can contain multiple words.

Specify the maximum size of a trace files for a specific service from 1 to 10 megabytes.

set trace maxfilesize

Required Parameters:

servicename—Name of the service. It can contain multiple words.

size—Maximum size of the trace files from 1 to 10 megabytes.

Specify the maximum number of trace files per service.

The system automatically appends a sequence number to the file name to indicate which file it is; for example, cus299.txt. When the last file in the sequence is full, the trace data begins writing over the first file.

set trace maxnumfiles

Required Parameters:

servicename—Name of the service. It can contain multiple words.

filecount—Number of trace files from 1 to 10000.

Set the usercategories flag to the value provided, for a specified service.

Tip

This option is available only for service names beginning with Cisco.

set trace usercategories

Required Parameters:

flagnumber—Hexadecimal value from 0 to 7FFF. 7FFF means all the flags are enabled.

servicename—Name of the service. It can contain multiple words.

Set trace configuration to default values for a specified service.

Tip

This option is available only for service names beginning with Cisco.

set trace default

Required Parameters:

servicename—Name of the service. It can contain multiple words.

Collecting Traces (Logs)

You can collect trace files by performing any of the following tasks:

To view the trace files directly from the CLI, enter the following the CLI commands:

file list

file view

file search

To bundle the various trace files and send them to the local SFTP directory, enter the CLI command file get. Then, use a SFTP client to obtain the .tar files and send to the team that troubleshoots.