Cisco Hosted Collaboration Mediation Fulfillment Maintain and Operate Guide, Release 10.6(1)
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.
- Updated:
- June 26, 2015
Chapter: Perform Routine Maintenance
- Maintenance Tools and Utilities
- Infrastructure Manager
- Jobs
- Failed or Cancelled Jobs
- Service Provider
- Settings
- Diagnostics
- API Gateway Diagnostic Report
- CHPA Diagnostic Report
- CUCDMSync Diagnostic Report
- DMA-SA Diagnostic Report
- Fulfillment Diagnostic Report
- HLM Diagnostic Report
- NBI Diagnostic Report
- NBIRESTFF Diagnostic Report
- NBIRESTSDR Diagnostic Report
- SDRCNF Diagnostic Report
- SI Diagnostic Report
- UCPA Diagnostic Report
- UCSMSync Diagnostic Report
- VcenterSync Diagnostic Report
- HCS License Manager for Cisco HCM-F
- UC Solution Impacts and Dependencies
- Limitations
- HCS Licensing Operations
- HCS License Report
- Audit
- Launch RTMT
- Profiles
- Categories
- Using the HCM-F RTMT Performance Counter Monitoring
- Add Counter Using Performance Queries
- Remove Counter From Performance Monitoring Pane
- Add Counter Instance
- Set Up Counter Alert Notification
- Display Counter Description
- Start Perfmon Counter Logging
- Stop Perfmon Counter Logging
- Configure Data Sample
- View Counter Data
- View Performance Monitor Log Files
- Collect Trace Files
- Collect Installation Logs
- Collect and Download Trace Files Using Query Wizard
- Schedule Trace Collection
- View Trace Collection Status
- Collect a Crash Dump File
- Collect Audit Logs
- Display Downloaded Trace Files using Local Browse
- Display and Download Trace Files using Remote Browse
- Real-time Trace
- Edit RTMT Trace Settings
- Display Messages in SysLog Viewer
Perform Routine Maintenance
Maintenance Tools and Utilities
Service Inventory
General Settings for Service Inventory Setup
In the Service Inventory administrative interface, you manage credentials and configure general settings for Service Inventory on the Configuration page. The following table provides a list of settings that you configure on the Configuration page.
 Tip | Service Inventory works with Cisco Unified Communications Domain Manager or two UC Applications - Cisco Unified Communications Manager and Cisco Unity Connection. For Service Inventory to work, make sure that you configure Cisco Unified Communications Domain Manager or the supported UC Application in the Infrastructure Manager administrative interface. |
Service Inventory can generate reports only from a Cisco Unified Communications Manager and Cisco Unity Connection running UC Application Software Version 8.6(2) or later.
In the Service Inventory administrative interface, click Configuration. Enter the configuration for the settings in the following table; then click Save.
|
Field |
Description |
||
|---|---|---|---|
|
Service Inventory Settings Use this section to configure a Service Inventory server. |
|||
|
Hostname |
Enter the hostname of the Service Inventory server. The Service Inventory hostname must be entered as an IP address or a fully qualified domain name.
|
||
|
Port |
Enter the SFTP port number that is used by the Cisco Unified Communications Domain Manager server to send the requested SI billing data to this Service Inventory server. The default is 22. |
||
|
Username |
Cisco Unified Communications Domain Manager uses the username, adminsftp, to transfer data to the Service Inventory application. You cannot update this field. |
||
|
Password |
Enter the password for the adminsftp user account. This step is required as an identity confirmation for security purposes. This password is the same as the HCS administrator password that you set up during the Cisco HCM-F installation (or changed after installation). |
||
|
Service Provider SFTP and Remote Backup SFTP Settings Use this section to configure and enable transfer of Service Inventory reports to remote SFTP servers. Remote SFTP servers configured on this page also serve as the destination of files when you initiate a transfer from the Backup page. You must configure a primary remote SFTP server. If you want to do so, you may configure a secondary remote SFTP server. If you configure the secondary remote SFTP server, the generated report files get sent to the location for the secondary remote SFTP server in addition to the primary remote SFTP location.
|
|||
|
Hostname |
Enter the hostname of the primary remote SFTP server. |
||
|
Port |
Enter a port number for the primary remote SFTP server or use the default, which is 22. |
||
|
Username |
Enter a valid username to access the remote SFTP server. |
||
|
Password |
Enter the password to access the remote SFTP server. |
||
|
Destination Path |
Enter a path on the SFTP server where the billing files will be stored. |
||
|
Retry Count |
Set the number of times the Service Inventory service will attempt to transfer billing reports if the SFTP transfer does not succeed on the first try.
|
||
|
Maximum File Size (MB) |
Enter the maximum individual file size (in MB) for Service Inventory reports that are transferred to remote SFTP servers. The Service Inventory application will split and rename files to meet this size requirement before transfer. The maximum value you can enter is 2047 MB. |
||
|
Local Settings Use this section to configure the local settings for report backup retention, for log trace levels, to enable report customization and to set up the failure notification email feature. |
|||
|
Local Backup Retention period (days) |
Set the number of days that you want to retain backup copies of generated Service Inventory reports. Enter between 30 and 60, with 60 being the default. |
||
|
Log Trace Level |
Set the log trace level. Available trace levels are Fatal, Error, Warning, Informational, and Detailed. |
||
|
Enable Report Customization |
Check to enable additional customization of Service Inventory reports. Verify that an appropriate Cisco Advanced Services application plug-in is installed. Service Inventory application executes the plug-in to provide additional report customization after basic processing if this option is enabled and the plug-in is installed. |
||
|
Failure Notification The Service Inventory service provides the ability to send email notifications in the event of application errors and failures. This notification service is optional, but is used if configured.
|
|||
|
SMTP Hostname |
Enter the outbound SMTP hostname or use the default of local host. |
||
|
SMTP Port |
Enter the SMTP port number or use the default, which is 25. |
||
|
Email Address (From) |
Enter the outbound email address. |
||
|
Email Address (To) |
Enter the inbound email address. |
||
Infrastructure Manager for Service Inventory Support Setup
Service Inventory can generate reports from Cisco Unified Communications Domain Manager. If you use Unified Communications Domain Manager with Service Inventory, verify that a managed Unified Communications Domain Manager application instance is configured within Infrastructure Manager.
Service Inventory can also generate reports directly from a supported UC Application, Cisco Unified Communications Manager and Cisco Unity Connection application servers for customers that are provisioned in Cisco HCM-F that do not have a Unified Communications Domain Manager configured. If you do not have a Unified Communications Domain Manager configured, you need to add a Cisco Unified Communications Manager and Cisco Unity Connection application server manually to run a Service Inventory report.
Cisco Unified Communications Domain Manager should appear on the Management Network page in the Infrastructure Manager administrative interface (). If you determine that an instance does not exist, configure the settings in the following table.
|
Field |
Description |
|---|---|
|
General Information |
|
|
Application Type |
From the drop-down list box, select CUCDM. |
|
Name |
Enter the name of the Cisco Unified Communications Domain Manager. |
|
Description |
Enter a description for the Unified Communications Domain Manager. |
|
Auto Link to Virtual Machine |
Check this check box to automatically link to the virtual machine. |
|
Virtual Machine |
Enter the location of the virtual machine where Unified Communications Domain Manager is installed. |
|
Credentials |
|
|
Credentials Type |
From the drop-down list box, select ADMIN. |
|
User ID |
Enter the User ID that is used to access Unified Communications Domain Manager. Service Inventory uses the 'hcsadmin' user for querying Cisco Unified Communications Domain Manager. |
|
Password and Re-enter Password |
Enter the password for the User ID. Re-enter the same password for the User ID. |
|
Access Type |
Service Inventory requires Read Only, but you can select either option. |
|
Network Addresses |
|
|
Network Space |
From the drop-down list box, select Service Provider Space. |
|
IPv4 Address |
If your Unified Communications Domain Manager platform uses IPv4, enter the IPv4 address for the Unified Communications Domain Manager platform. |
|
IPv6 Address |
If your Unified Communications Domain Manager platform uses IPv6, enter the IPv6 address for the Unified Communications Domain Manager platform. |
|
Hostname |
If you use DNS, enter the hostname for the Unified Communications Domain Manager platform. |
|
Domain |
Enter the domain for the Unified Communications Domain Manager platform. |
|
SRV Address |
This setting does not apply to Service Inventory. |
To configure both Cisco Unified Communications Manager and Cisco Unity Connection, go to the Customer Management page in the Infrastructure Manager administrative interface ().
Report Generation for Service Inventory
At the time that is specified in the Service Inventory configuration, Service Inventory sends a real-time query request to Cisco Unified Communications Domain Manager and all Cisco HCM-F provisioned UC Applications that are assigned to customers that are not associated with a Cisco Unified Communications Domain Manager.
Cisco Unified Communications Domain Manager generates the necessary files and sends the files to Service Inventory through SFTP.
Service Inventory processes the files or messages, including but not limited to backing up the files for troubleshooting purposes, creating the report, and transferring the report to the SFTP servers that are configured in the Service Inventory administrative interface.
Service Inventory supports Partitioned Unity Connection.
Example: Customer A - Sharedent 1 and Customer B - Sharedent 2.
Customer A and B are sharing the partitioned unity connection application.
The generated report contains data for the previous 24 hours, up to and including the end time that you specify on the Overview page in the Service Inventory administrative interface.
 Note | The first SI report (OnDemand or Scheduled) with Cisco Unified Communications Domain Manager 10.x will not have MACD reported. The subsequent reports will have MACD in the "si" report. |
Generated Reports
In the Service Inventory administrative interface, the Backup page displays a list of generated report files. The Backup page displays the file name, date, and file size for the generated report. Filter the results by selecting an option from the Show drop-down list box or by clicking one of the columns on the page.
Tip | The configuration for the Local Backup Retention Period setting on the Configuration page determines the files that appear in the list on the Backup page. Service Inventory deletes reports based on the value that you configure for this setting. For example, if you configure this setting as 35, and the report is 36 days old, the report name does not appear in the list. |
On Demand Reporting
Service Inventory provides On Demand Inventory and Location reporting. These On Demand reports allow the administrator to generate reports at any time without having to alter the reporting schedule. Location Summary reports generate a report to indicate the number of devices and subscribers per location.
For On Demand Service Inventory reports, a check box is available for "Each Reseller & Customer" and "Generate XLS Report". Upon selecting "Each Reseller & Customer" you will have Aggregate reports generated for each Customer & Reseller in the system. Each Customer/Reseller will have a Summary, Detailed & MACD report generated as well as a Service Provider level Summary Report. Upon selecting "Generate XLS Report" checkbox, an excel-formatted report is generated. For this release, the report extension is .xlsm and for other releases, the report extension is .xlsx.
Note | You must generate an inventory report (.si) before you can generate a location report. If you try and generate a location report first, you will receive an error. |
Both Scheduled and On Demand reports require that either CUCDM, UCAPP, or CUCDM&UCAPP be chosen as the report source, the default being CUCDM. Selecting CUCDM as the source generates a ".si" report and summary reports will be generated from Cisco Unified Communication Domain Manager. If UCAPP is chosen as the report source, ".ucsi" and ".simacd" reports will be generated from a Cisco Unified Communication application, provided Cisco Unified Communication application has been configured in Cisco Unified Communcations Domain Manager and provisioned in Cisco Hosted Collaboration Mediation Fulfillment & synced with Cisco Unified Communications Manager). If CUCDM&UCAPP is chosen as the report source, ".si", ".ucsi", and ".simacd" reports will be generated.
The following table describes the fields to configure On Demand Reporting.
| Field | Description |
|---|---|
| System Time | Click the refresh button to acquire the system time. |
| Type of report to generate | Generated report type (Location Report or Inventory Report). |
| Report Source | Report Source will either be CUCDM, UCAPP, or CUCDM&UCAPP |
| Report Format Version |
Version report format (8.6.2, 9.0.1, 9.1.1, 9.1.2, 10.0.1, 10.1.2, 10.6.1). |
| Report must include information up to (GMT) | Report will contain data up to a specified time period (listed in 15 minute intervals). |
| Create separate report files for: (checkboxes) | |
| Service Provider | Systemwide service providers' report (selected by default). |
| Each reseller and customer | Report created for each reseller and customer. |
| Generate XLS Report | Report created in XLS Format. |
In a deployment where UCDM 8.1(x) and UCDM 10 co-exist, a report will be generated for both UCDM 8.1(x) and UCDM 10. The report file name for UCDM 8.1(x) will have a tag of "+CUCDM+" and the UCDM 10 tag will be "+CUCDM2+".
The below report format is common for the Service Inventory and the Location report generates with any source (CUCDM or UCAPP).
Report generated Year-Month-Date followed by the time- GMT timezone.
The following are example file names:
CUCDM 8.1.4 customers: 20140804131528GMT+1+CUCDM+1+1.si
CUCDM 10 customers: 20140804131528GMT+1+CUCDM2+1+1.si
Location Reporting
Location Reporting provides details of each customer's internal hierarchy and locations as modeled by Cisco Unified Communications Domain Manager. The report should be executed on demand through the Service Inventory user interface or the Cisco Hosted Collaboration Mediation Fulfillment Northbound Interface and then transferred to the service provider's primary SFTP location. A previously generated Service Inventory report file is used as the source file to generate the data in the Location report.
Note | Location reports require that at least one Inventory report request has been executed. |
Customer and Reseller Reports
For both Scheduled & On Demand Service Inventory reports, a check box is available for "Each Reseller & Customer". Upon selecting this check box you will have Aggregate reports generated for each Customer & Reseller in the system. Each Customer/Reseller will have a Summary, Detailed and MACD report generated as well as a service provider level Summary Report.
Detailed Reporting
Detailed Aggregate level reports compliment existing service inventory (.si) reports by generating detailed information for both Cisco Unified Communications Domain Manager and Cisco Unified Communication application based configurations. Aggregate reporting at any level will have detailed report data for its customers only.
The status of a generated report can be viewed in Infrastructure Manager > Administration > Jobs.
Note | Only customer level detailed reports are generated for Cisco UC application based configurations. |
Summary Reporting
Summary reporting gives the high level information of Cisco HCS Service Inventory customers along with the subscribers and devices. When aggregate level reporting is enabled in the Service Inventory configuration, summary reports along with other aggregate level reports are generated and saved to the Cisco Hosted Collaboration Mediation Fulfillment server. The Service Inventory configuration can also be completed through the Cisco Hosted Collaboration Mediation Fulfillment Northbound Interface.
Summary reports will get generated at different aggregate levels for multiple providers, each reseller and each customer present in Cisco Unified Communications Domain Manager and non Cisco Unified Communications Domain Manager deployment(UC Deployment). In a Hybrid deployment model, Service Inventory pulls inventory data directly from the UC Applications created on Cisco Hosted Collaboration Mediation Fulfillment and puts them into a report. A message is sent to get an inventory report, which Service Inventory then takes and formats based on the version's format specification. This generates a single summary report using data from both Cisco Unified Communications Domain Manager and Unified Communication applications.
MACD (Move-Add-Change-Delete) Reporting
MACD reports are generated for both Cisco Unified Communications Domain Manager-based and Cisco Unified Communication Application-based configurations. However, Cisco Unified Communication Application-based reports are not generated at the reseller level.
Report Matrix
|
Report Version |
CUCDM 8.x |
CUCDM 10.x |
UC APP |
Comments |
|---|---|---|---|---|
|
8.6.2 |
Yes |
Yes |
No |
Report from CUCDM 10.x is as close as possible to CUCDM 8.x. (The only exception is the features/feature groups where in 10.x, it is based on actual features that are enabled.) |
|
9.0.1 |
Yes |
Yes |
No |
Report from CUCDM 10.x is as close as possible to CUCDM 8.x. (The only exception is the features/feature groups where in 10.x, it is based on actual features that are enabled.) |
|
9.1.1 |
No |
No |
Yes |
This report appears only when the report source is selected as UC APP. |
|
9.1.2 |
No |
No |
Yes |
This report appears only when the report source is selected as UC APP. |
|
9.2.1 |
Yes |
No |
No |
This report version is purely from CUCDM 8.x, as we cannot provide the Connected Location and Fake Phone info in CUCDM 10.x. |
9.2.2 |
No |
Yes |
No |
This report appears only when the report source is selected as CUCDM 10.x. |
|
10.0.1 |
Yes |
Yes |
No |
From CUCDM 10.x we generate 10.0.1 format. For CUCDM 8.x we generate the latest report version available (9.2.1) from CUCDM 8.x. |
|
10.1.2 |
Yes |
Yes |
No |
From CUCDM 10.x we generate 10.1.2 format. For CUCDM 8.x we generate the latest report version available (9.2.1) from CUCDM 8.x. |
|
10.6.1 |
Yes |
Yes |
No |
From CUCDM 10.x we generate 10.6.1 format. For CUCDM 8.x we generate the latest report version available (9.2.1) from CUCDM 8.x. |
Report Combinations
Cisco HCS Deployment with Cisco Unified Communications Domain Manager 8.x
| Source of Report | Report Version selected | |||||
| 8.6.2 | 9.0.1 | 9.1.1 | 9.2.1 | 9.1.2 | 9.2.2 | |
| UCAPP | N/A |
N/A |
UCApp report ".ucsi" is generated of report version 9.1.1 |
N/A |
UCApp report ".ucsi" is generated with report version 9.1.2 |
N/A |
| CUCDM | CUCDM ".si" report is generated of report version 8.6.2 |
CUCDM ".si" report is generated of report version 9.0.1 |
N/A |
CUCDM ".si" report is generated of report version 9.2.1 |
N/A |
CUCDM ".si" report is generated with report version 9.2.2 |
| CUCDM & UCAPP |
CUCDM ".si" report is generated of report version 8.6.2 AND UCApp report ".ucsi" is generated of report version 9.1.1 . |
CUCDM ".si" report is generated of report version 9.0.1 AND UCApp report" .ucsi" is generated of report version 9.1.1 |
N/A |
CUCDM ".si" report is generated of report version 9.2.1 AND UCApp report ".ucsi" is generated of report version 9.1.1 |
N/A |
CUCDM ".si" report is generated of report version 9.2.2 AND CUCDM ".si" report is generated of report version 9.2.2 |
Deployment with Cisco Unified Communications Domain Manager 10.x
| Source of Report | Report Version selected | |||||||
| 8.6.2 | 9.0.1 | 9.1.1 | 9.2.1 | 9.2.2 | 10.0.1 | 10.1.2 | 10.6.1 | |
| UCAPP | N/A | N/A | UCApp report ".ucsi" is generated of report version 9.1.1 | N/A | N/A |
N/A | N/A |
N/A |
| CUCDM | CUCDM ".si" report is generated of report version 8.6.2. | CUCDM ".si" report is generated of report version 9.0.1 . | CUCDM ".si" report is generated of report version 9.2.1 | N/A | CUCDM ".si" report is generated of report version 9.2.2 |
CUCDM ".si" report is generated of report version 10.0.1 | CUCDM ".si" report is generated of report version 10.1.2 |
CUCDM ".si" report is generated with report version 10.6.1 |
| CUCDM & UCAPP |
CUCDM ".si" report is generated of report version 8.6.2 AND UCApp report ".ucsi" is generated of report version 9.1.1 . |
CUCDM ".si" report is generated of report version 9.0.1 AND UCApp report ".ucsi" is generated of report version 9.1.1 |
N/A |
CUCDM ".si" report is generated of report version 9.2.1 AND UCApp report ".ucsi" is generated of report version 9.1.1 |
CUCDM ".si" report is generated with report version 9.2.2 AND UCApp report ".ucsi" is generated with report version 9.1.2 |
CUCDM ".si" report is generated of report version 10.0.1 AND UCApp report ".ucsi" is generated of report version 9.1.1 |
CUCDM ".si" report is generated of report version 10.1.2 AND UCApp report ".ucsi" is generated of report version 9.1.1 |
UCApp report ".ucsi" is generated with report version 9.1.2 AND UCApp report ".ucsi" is generated with report version 9.1.2 |
Deployment without Cisco Unified Communications Domain Manager 10.x/8.x
| Source of Report | Report Version selected | |||||||
| 8.6.2 | 9.0.1 | 9.1.1 | 9.2.1 | 9.2.2 | 10.0.1 | 10.1.2 | 10.6.1 | |
| UCAPP | N/A | N/A | UCApp report ".ucsi" is generated of report version 9.1.1 | N/A | N/A |
N/A | N/A |
N/A |
|
CUCDM |
CUCDM ".si" report is generated of report version 8.6.2 from both the CUCDM's are generated |
CUCDM ".si" report is generated of report version 9.0.1 from both the CUCDM's are generated |
N/A |
CUCDM ".si" report is generated of report version 9.2.1 from both the CUCDM's are generated |
CUCDM ".si" report is generated of report version 9.2.2 from both the CUCDM's are generated |
CUCDM ".si" report is generated of report version 10.0.1 from CUCDM 10.x and report version of 9.2.1 from CUCDM 8.x are generated |
CUCDM ".si" report is generated of report version 10.1.2 from CUCDM 10.x and report version of 9.2.1 from CUCDM 8.x are generated |
CUCDM ".si" report is generated with report version 10.6.1from CUCDM 10.x and report version of 9.2.2 from CUCDM 8.x are generated |
|
CUCDM & UCAPP |
CUCDM ".si" report is generated of report version 8.6.2 from both the CUCDM's are generated AND UCApp report ".ucsi" is generated of report version 9.1.1 |
CUCDM ".si" report is generated of report version 9.0.1 from both the CUCDM's are generated AND UCApp report ".ucsi" is generated of report version 9.1.1 |
N/A |
CUCDM ".si" report is generated of report version 9.2.1 from both the CUCDM's are generated AND UCApp report ".ucsi" is generated of report version 9.1.1 |
CUCDM ".si "report is generated with report version 9.2.2 from both the CUCDM's are generated AND UCApp report ".ucsi" is generated with report version 9.1.2 |
CUCDM ".si" report is generated of report version 10.0.1 from CUCDM 10.x and report version of 9.2.1 from CUCDM 8.x are generated AND UCApp report ".ucsi" is generated of report version 9.1.1 |
CUCDM ".si" report is generated of report version 10.1.2 from CUCDM 10.x and report version of 9.2.1 from CUCDM 8.x are generated AND UCApp report ".ucsi" is generated of report version 9.1.1 |
CUCDM ".si "report is generated with report version 10.6.1 from CUCDM 10.x and report version of 9.2.2 from CUCDM 8.x are generated AND UCApp report ".ucsi" is generated with report version 9.1.2 |
Infrastructure Manager
Infrastructure Manager allows you to provision and query the Cisco HCS Shared Data Repository. The Cisco HCS Shared Data Repository provides configuration information for HCM-Service Assurance. The Cisco HCS Shared Data Repository is a repository of data that represents the Cisco HCS configuration of Data Centers, customers, and management components in the service provider's network. This repository is then used by HCM-Service Assurance to provide more effective, detailed, and accurate operational alarms and events.
Jobs
The Jobs Summary page displays a list of the last 400 automatic and manual jobs added to your Cisco HCM-F as well as basic details about each one.
Note | A purge of the job list occurs every 24 hours. |
Jobs Field Descriptions
|
Job Entity |
Displays the job entity. |
Entity Name |
Displays entity name. |
|
Displays the job status. If the Job Status is In Progress or Fail, hover the cursor over the info circle and more information is given as well as recommended actions. |
|
Failed or Cancelled Jobs
Checking the Job Status
To view the job status, navigate to Administration > Jobs in Infrastructure Manager in HCM-F GUI. For Infrastructure Provisioning Adapter (IPA) jobs, the Job Type is "Provisioning", the Description is "IPA Provisioning Request", and the Entity Name is the name of the customer. The job status table is displayed and will remain until deleted or automatically removed.
Additional status information and recommended actions for the job can be seen by hovering over the job details icon. If the IPA service is stopped or restarted while a job is in-progress, the job status will be marked as failed when IPA resumes.
Note | Cancelling a job is supported with no rollback support. If the job is already in progress, remaining tasks of the job are cancelled and you must manually delete any Virtual Machines created as part of provisioning the job. |
Canceling the job
You can cancel queued or in-progress jobs by clicking the cancel button under the actions column for the job status page in the HCM-F GUI. The job will immediately be cancelled and marked as such after the GUI refreshes. No new vCenter tasks will begin for that job, but any current operations in the vCenter will continue until they are completed or are cancelled by the user. The user must manually clean up any Virtual Machines from the job just as in the case of a failed job. Any queued jobs for the customer will run immediately. Cisco recommends that the user cancels the queued jobs prior to cancelling the active job if an entire customer's provisioning needs to be stopped.
Failed/cancelled jobs
If the job fails, the user must clean up any Virtual Machines from the job and resubmit the job. Failures in the preliminary validation phase do not leave behind any Virtual Machines. If the job fails or is cancelled during the identity process, the cloned Virtual Machines may still have the identity (hostname, IP address) of the template. You must power off or remove these Virtual Machines before attempting to clone again from the same template. Subsequent jobs will time out while waiting for the node to come online if there is a conflict.
Service Provider
The service provider page displays the details of the service provider in your Cisco HCS.
Note | If CUCDMSync is enabled and successful, customer equipment is added, edited, and deleted through the CUCDMSync. |
Service Provider Field Descriptions
Settings
The settings page provides thresholds for Cisco Prime Collaboration assignments that you can configure the maximum number of customers and devices each Cisco Prime Collaboration can service. The settings page also allows the administrator to specify warning thresholds.
When a maximum is reached, you can make no further assignments to that Cisco Prime Collaboration. When a warning threshold is reached, the Usage is highlighted on the Management Application page.
Settings Field Descriptions
Diagnostics
Diagnostics allows you to get real time status and statistics from running services, run real time tests to make sure services are working properly and if not, indicate recommended actions for administrators.
These diagnostic reports can also be accessed from the command line interface. For more information on CLI diagnostic commands, see Cisco Hosted Collaboration Mediation Fulfillment Command Line Interface Reference Guide, Release 10.6(1).
| Field | Description |
|---|---|
|
Diagnostic |
Allows a selection of the type of diagnostics to run. |
|
Request Diagnostics |
Button to click to submit the diagnostic request. |
- API Gateway Diagnostic Report
- CHPA Diagnostic Report
- CUCDMSync Diagnostic Report
- DMA-SA Diagnostic Report
- Fulfillment Diagnostic Report
- HLM Diagnostic Report
- NBI Diagnostic Report
- NBIRESTFF Diagnostic Report
- NBIRESTSDR Diagnostic Report
- SDRCNF Diagnostic Report
- SI Diagnostic Report
- UCPA Diagnostic Report
- UCSMSync Diagnostic Report
- VcenterSync Diagnostic Report
API Gateway Diagnostic Report
API Gateway Proxy web service
The following table outlines the diagnostic report for the API Gateway Proxy web service.
| Property Name | Property Value Description |
|---|---|
| Start Time | Timestamp of when the service was started. |
| Up Time | The amount of time the web service has been running. |
| Maximum Memory | The maximum memory allocated for the service. |
| Free Memory | The free memory available for the service. |
| Percent Free Memory | The free memory available for the service in percent. |
| Global Address and Http Port | The global address and http port advertised by API Gateway Proxy if configured. |
| Property Name | Property Value Description |
|---|---|
| Number of Routes by RoutingId | Number of Routes that are routed based on routing ID. |
| Number of Routes by Cluster | Number of Routes that are routed based on customer name and cluster name. |
| Number of Routes by Cluster and Node | Number of Routes that are routed based on customer name, cluster name and node name. |
| Number of Routes by Domain Manager | Number of Routes that are routed based on domain manager name. |
| Number of Clusters that aren't associated with a Customer | Number of clusters that are not associated with a customer. |
| Number of Invalid Routes | Number of routes that are not configured correctly. |
| Property Name | Property Value Description |
|---|---|
| Northbound Rxd (North ==> Proxy) | Displays the number of messages received from the clients. |
| Northbound Txd (North <== Proxy) | Displays the number of messages transmitted to the clients. |
| Southbound Txd (Proxy ==> South) | Displays the number of messages transmitted to the Cisco Unified Communications Manager applications. |
| Southbound Rxd (Proxy <== South) | Displays the number of messages received from the Cisco Unified Communications Manager applications. |
| AsyncNorthbound Txd (North <== Proxy | Displays the number of asynchronous messages transmitted to the clients. |
| AsyncSouthbound Rxd (Proxy <== South) | Displays the number of asynchronous messages received from the Cisco Unified Communications Manager applications. |
| Southbound Failures | Displays the number of messages that API Gateway Proxy failed to transmit to the Cisco Unified Communications Manager applications. |
| Northbound Failures | Displays the number of messages that API Gateway Proxy failed to transmit to the client. |
| Routing Failures | Displays the number of messages that API Gateway Proxy failed to route. |
| Property Name | Property Value Description |
|---|---|
| Database State | Whether the database is up or down. |
| Last Test Time | The time of the last test. |
| Currently Sleeping for (Ms) | The time in Ms that the database has been inactive. |
| Registered Callback Handlers | The number of registered callback handlers |
| Running Callback Handlers | The number of active callback handlers. |
| initialDatabaseTestDelayMs | The time in MS to delay the initial database test. |
| periodicTestDelayWhenDBIsDownMs | The periodic time in MS to delay the database test when the database is down. |
| periodicTestDelayWhenDBIsUpMs | The periodic time in MS to delay the database test when the database is up. |
| dieWhenDatabaseComesUp | Determines if the Database Pulse Detector will die once the database comes up for the first time. |
| sessionName | DBPulseDetector |
| logger | com.cisco.hcs.apigw |
CHPA Diagnostic Report
CHPA Agent Properties
The following tables outlines the diagnostic report for the Cisco HCS Provisioning Adapter service.
| Property Name | Property Value Description |
|---|---|
| CHPA AgentRouteBuilder Status | Signifies the health of the agent; options are Red, Yellow, or Green. |
| Recommended Action | Recommended action to correct last failure. If "Unknown", then no failures to report. |
| Configured CHPA Agents | The number of CHPA Agents configured. |
| Device AgentInstanceMap Size | The number of application instances managed. |
| Property Name | Property Value Description |
|---|---|
| Agent Instance Id | Internal Id of the agent. |
| Agent Status | Signifies the health of the agent; options are Red, Yellow, or Green. |
| Creation Time | Date and time the agent was created. |
| # of App Instances Managed | Number of application instances that are managed by the agent. |
| Connection Table Size | The size of the connection table. |
| Total Success | Total number of requests sent to application instances that were successful. |
| Total Failures | Total number of requests sent to application instances that were un-successful. |
| Last Success Time | Date and time the last successful request was made to an application instance. |
| Last Failure Time | Date and time the last unsuccessful request was made to an application instance. If this time is equal to the agent's creation time, then no failures have occurred. |
| Last Failure Appinst | The last Application Instance that encountered a failure. If "Unknown", then no failures to report. |
| Last Failure Reason | The reason for the last failure. If "Unknown", then no failures to report. |
| Last Failure (Recommended Action) | Recommended action to correct last failure. If "Unknown", then no failures to report. |
CUCDMSync Diagnostic Report
Cisco HCS CUCDMSync
The following tables outline the diagnostic report for the Cisco HCS CUCDMSync service.
Note | Cisco recommends that you do not configure this manually. For customers on Cisco Unified Communications Domain Manager 8.1(x), please use CUCDMSync to configure. For customers on Cisco Unified Communications Domain Manager 10.1(x), the information will be pushed from the Cisco Unified Communications Domain Manager Server to the Cisco HCM-F server and does not require configuration. |
| Property Name | Property Value Description |
|---|---|
| CUCDMSync Status | Signifies the health of the CUCDMSync, options are Red, Yellow, or Green. |
| Status Info | Job status info for the CUCDMSync, field is empty if no job has started for this application. |
| Recommended Action | Job recommended action for the CUCDMSync, field is empty if no job has started for this application. |
| Sync Interval | The time between each CUCDMSync request. |
| Health Interval | A time interval used by the CUCDMSync service to calculate when to perform self diagnostics to detect and correct service-threatening events, such as unresponsive sync agents. This value can not be altered by the administrator. |
| Next Auto-Sync | The time until the next CUCDMSync request. (Only displayed in the diagnostics GUI if Auto-Sync is enabled. If the Sync Interval value shows "Disabled," then Next-Auto Sync will not be displayed.) |
| Number of attempted syncs | The number of attempted CUCDMSync requests. |
| Last Success Sync | The date and time of the last successful CUCDMSync request. |
| Last Error Sync | The date and time of the last error from the CUCDMSync request. |
| Last Error Reason | A description of the possible errors and a list of recommended actions to resolve the error. |
| Number of failed agents | The number of failed agents. |
| Time of last failed agents | The date and time of the last failed agent. |
| Property Name | Property Value Description |
|---|---|
| CUCDM Active Connections | The number of currently active Cisco Unified Communications Domain Manager connections. |
| CUCDM Idle Connections | The number of currently idle Cisco Unified Communications Domain Manager connections. |
| SDR Active Sessions | The number of currently active SDR connections. |
| SDR Idle Sessions | The number of currently idle SDR connections. |
| Property Name | Property Value Description |
|---|---|
| Agent Instance ID | The unique ID for the CUCDMSync agent. |
| Agent Status | Signifies the health of the CUCDMSync Agent, options are Red, Yellow, or Green. |
| Work done | The number of syncs performed. |
| Number of Errors | The number of errors for the CUCDMSync cluster agent. |
| SDR Session | The name of the SDR session. |
| CUCDM Connection | The connection of the Cisco Unified Communications Domain Manager. |
DMA-SA Diagnostic Report
DMA-SA (Domain Manager Adapter - Service Assurance)
The following table outlines the diagnostic reports for the DMA-SA service.
| Property Name | Property Value Description |
|---|---|
| Default | No service specific info available |
| Total devices | The total number of devices |
| Devices Provisioned Successfully | The total number of devices successfully provisioned |
| Devices Pending | The total number of devices in the process of being provisioned |
| DmReceiver Queue | The number of messages the dispatcher (an internal component of DMA-SA) has received and yet to process |
| SDR CNF in service | SDR CNF (Change Notification Framework) must be in service for this component to work. If the value is false, then something is wrong and new users cannot be added |
| Total Pushed Entities | The total number of users |
| Provisioned Successfully | The total number of users successfully provisioned |
| Pending | The total number of users in the process of being provisioned |
| Receiver Queue | The number of messages the dispatcher (an internal component of DMA-SA) has received and yet to process |
| Devices | The number of devices configured on the HCM-F to be monitored by this Prime Collab out of the maximum devices allowed to be monitored by a single Prime Collab |
| Customers | The number of customers configured on the HCM-F with devices to be monitored by this Prime Collab out of the maximum customers allowed for a single Prime Collab |
| Subscribers | is the number of registered end-user subscribers on all the call managers monitored by this Prime Collab out of the maximum allowed. |
| Items In Progress | is the number of devices that are currently in the process being added to or removed from this Prime Collab. |
Fulfillment Diagnostic Report
Fulfillment
The following tables outline the diagnostic report for the Cisco HCS Fulfillment service.
| Property Name | Property Value Description |
|---|---|
| Start Time | Provides a timestamp of when the service was started. |
| Up Time | The amount of time the web service has been running. |
| Session Name | The name of the session created for this pool. |
| Min Sessions | The minimum number of sessions for this pool. |
| Max Sessions | The maximum number of sessions for this pool. |
| Allocated Sessions | The number of sessions allocated for this pool. |
| Max Allocated Sessions | The maximum number of allocated sessions allowed for this pool. |
| Periodic Time to test DB (ms) | The time in milliseconds to retest the database connection. |
| Free Sessions | The number of free sessions in the pool. |
| Used Sessions | The number of used sessions in the pool. |
| Stale Sessions | The number of stale sessions in the pool. |
| Rebuild Session Pool count | The number of times the pool has been rebuilt. |
| Pool Starter last ran | The time and date that the pool starter was last ran. This indicates when the pool noticed the database was down. |
| Stale Session Reader last ran | The time and date that the stale session reader was last ran. This indicates when the pool noticed the database was down. |
| Property Name | Property Value Description |
|---|---|
| Derby Status | The current status of the Derby status seen by this agent. |
| SDR Status | The status of SDR seen by this agent. |
| CHPA Status | The status of the CHPA service seen by this agent. |
| DMASA Status | DMASA status monitored by Fulfillment. |
| SDRCNF Status | SDRCNF status monitored by Fulfillment. |
| Expected Number of Agents | The expected number of active agents in Fulfillment Service. |
| Number of active agents | The actual number of active agents in Fulfillment Service. |
| Property Name | Property Value Description |
|---|---|
| GREEN | The number of agents whose status is GREEN (no issues). |
| YELLOW | The number of agents whose status is YELLOW (minor issues encountered, but nothing alarming or show-stopping. |
| RED | The number of agents whose status is RED (major issues have been encountered). |
| Total Count | The total number of agents that exist in Fulfillment Service. |
| Property Name | Property Value Description |
|---|---|
| <current job status; field entry will vary. Example: NO JOB> | The number of agents whose job is in that state. |
| Total Count | A count of all agents, with or without jobs. |
| Property Name | Property Value Description |
|---|---|
| GREEN | Names of agents whose status is GREEN. |
| YELLOW | Names of agents whose status is YELLOW. |
| RED | Names of agents whose status is RED. |
| Property Name | Property Value Description |
|---|---|
| <current job status; field entry will vary. Example: NO JOB> | The list of agents whose job is in that state. |
The following tables outline the diagnostic report for Cisco HCS Fulfillment service SDR Link Agent Route Builder
| Property Name | Property Value Description |
|---|---|
| Status | Status of the application. |
| Number of Agents | Number of agents associated to the application. |
| Property Name | Property Value Description |
|---|---|
| Audit List Size | The number of links that the agent needs to retry. |
| Property Name | Property Value Description |
|---|---|
| Application Configured for Manual VM Link | The number of application instances and virtual machines that have been configured to be manually linked. |
| Application Configured for Auto-VM Link | The number of application instances and virtual machines that have been configured to be auto linked. |
| Application Auto Linked to VM | The number of application instances and virtual machines that have been auto linked. |
| Application NOT Auto Linked to VM | The number of application instances and virtual machines that could not be auto linked. |
| List of Applications Configured for Manual VM Link | The list of application instances and virtual machines that have been configured to be manually linked. |
| List of Applications Configured for Auto VM Link | The list of application instances and virtual machines that have been configured to be auto linked. |
| List of Applications Auto Linked to VM | The list of application instances and virtual machines that have been auto linked. |
| List of Applications NOT Auto Linked to VM | The list of application instances and virtual machines that could not be auto linked. |
HLM Diagnostic Report
Cisco HCS License Manager Service
The following tables outline the diagnostic report for the Cisco HCS License Manager service.
| Property Name | Property Value Description |
|---|---|
| Last Audit Performed | Date and time that the last audit was performed. |
| Property Name | Property Value Description |
|---|---|
| HCM-F Global Deployment Mode | The deployment mode of the HCM-F. |
| # of License Managers | The number of License Managers. |
| # of Assigned Clusters | The number of assigned clusters. |
NBI Diagnostic Report
Cisco HCS North Bound Interface Web Service
The following tables outline the diagnostic reports for the Cisco HCS North Bound Interface Web service.
| Property Name | Property Value Description |
|---|---|
| Start Time | Provides a timestamp of when the service was started. |
| Up Time | The amount of time the web service has been running. |
| Property Name | Property Value Description |
|---|---|
| Start Time | Provides a timestamp of when the service was started. |
| Up Time | The amount of time the web service has been running. |
| Session Name | The name of the session created for this pool. |
| Min Sessions | The minimum number of sessions for this pool. |
| Max Sessions | The maximum number of sessions for this pool. |
| Allocated Sessions | The number of sessions allocated for this pool. |
| Max Allocated Sessions | The maximum number of sessions allowed to be allocated for this pool. |
| Periodic Time to test DB (ms) | The time in milliseconds to retest the database connection. |
| Free Sessions | The number of free sessions in pool. |
| Used Sessions | The number of used sessions in pool. |
| Stale Sessions | The number of stale sessions in pool. |
| Pool Starter last ran | The time and date that the pool starter was last ran. This indicates when the pool noticed the database was down. |
| Stale Session Reader last ran | The time and date that the stale session reader was last ran. This indicates when the pool noticed the database was down. |
NBIRESTFF Diagnostic Report
North Bound Interface REST FF Diagnostic Report
The following table outlines the diagnostic report for the North Bound Interface REST FF web service.
| Property Name | Property Value Description |
|---|---|
| Start Time | Provides a timestamp of when the service was started. |
| Up Time | The amount of time the web service has been running. |
| Property Name | Property Value Description |
|---|---|
| Start Time | Provides a timestamp of when the service was started. |
| Up Time | The amount of time the web service has been running. |
| Session Name | The name of the session created for this pool. |
| Min Sessions | The minimum number of sessions for this pool. |
| Max Sessions | The maximum number of sessions for this pool. |
| Allocated Sessions | The number of sessions allocated for this pool. |
| Max Allocated Sessions | The maximum number of sessions allowed to be allocated for this pool. |
| Periodic Time to test DB (ms) | The time in milliseconds to retest the database connection. |
| Free Sessions | The number of free sessions in pool. |
| Used Sessions | The number of used sessions in pool. |
| Stale Sessions | The number of stale sessions in pool. |
| Pool Starter last ran | The time and date that the pool starter was last ran. This indicates when the pool noticed the database was down. |
| Stale Session Reader last ran | The time and date that the stale session reader was last ran. This indicates when the pool noticed the database was down. |
NBIRESTSDR Diagnostic Report
North Bound Interface REST SDR Diagnostic Report
The following table outlines the diagnostic report for the North Bound Interface REST SDR web service.
| Property Name | Property Value Description |
|---|---|
| Start Time | Provides a timestamp of when the service was started. |
| Up Time | The amount of time the web service has been running. |
| Property Name | Property Value Description |
|---|---|
| Start Time | Provides a timestamp of when the service was started. |
| Up Time | The amount of time the web service has been running. |
| Session Name | The name of the session created for this pool. |
| Min Sessions | The minimum number of sessions for this pool. |
| Max Sessions | The maximum number of sessions for this pool. |
| Allocated Sessions | The number of sessions allocated for this pool. |
| Max Allocated Sessions | The maximum number of sessions allowed to be allocated for this pool. |
| Periodic Time to test DB (ms) | The time in milliseconds to retest the database connection. |
| Free Sessions | The number of free sessions in pool. |
| Used Sessions | The number of used sessions in pool. |
| Stale Sessions | The number of stale sessions in pool. |
| Pool Starter last ran | The time and date that the pool starter was last ran. This indicates when the pool noticed the database was down. |
| Stale Session Reader last ran | The time and date that the stale session reader was last ran. This indicates when the pool noticed the database was down. |
SDRCNF Diagnostic Report
SDRCNF AgentRouteBuilder Properties
The following tables outline the diagnostic reports for the Cisco HCS SDR Change Notification service
| Property Name | Property Value Description |
|---|---|
| SDRCNF AgentRouteBuilder Status | The current health of the service (Red, Yellow, or Green) based on its ability to produce and send notifications. |
| Recommended Action | The action recommended to repair the service if the status is Yellow or Red. This is based on the results of service initialization, checking the SDR status, and automatically auditing the service. |
| Start Time | Provides a timestamp of when the service was started. |
| Up Time | The amount of time the service has been running. |
| Configured SDRCNF Agents | The number of agents configured to handle incoming subscription requests. |
| Device AgentInstanceMap Size | The number of SDRCNF agents in operation. |
| SDR Status | The status of SDR. If not healthy, the service will not be able to produce notifications and will be placed in the RED state. |
| Last Audit Time | Provides a timestamp of when the last service audit was executed. |
| Last Audit Result | Provides the result of the last audit (success or failure). |
| Last Audit Error | Details the error if the last audit failed. |
| Property Name | Property Value Description |
|---|---|
| Sessions | The number of SDR sessions used to create subscriptions. |
| Subscriptions | The number of independent subscriptions to change notifications. |
| Subscription Specifications | The number of unique sets of subscriptions. Many subscriptions can share the same specification. |
| Triggers | The number of database triggers currently active for the service. |
| Dynamic Topics | The number of messaging topics created to send change notifications to the subscribers. |
| Property Name | Property Value Description |
|---|---|
| Transaction Chunks | The number of transaction chunks from the database waiting to be processed. |
| Ready Transactions | The number of ready transactions waiting to be processed. |
| Ready Notifications | The number of notifications waiting to be sent to subscribers. |
| Property Name | Property Value Description |
|---|---|
| Agent Instance ID | Internal Id of the agent. |
| Agent Status | Signifies the health of the agent; options are Red, Yellow, or Green. |
| Creation Time | Provides a timestamp of when the agent was configured. |
| Total Success | The total number of successful subscription requests handled by this agent. |
| Total Failures | The total number of failed subscription requests handled by this agent. |
| Last Success Time | Date and time of the last failed subscription request. |
| Last Failure Time | Date and time of the last failed subscription request. |
| Last Failure Reason | The reason for the last failure subscription request. |
| Last Failure (Recommended Action) | The recommended action to repair the last failed subscription request. |
SI Diagnostic Report
Cisco HCS Service Inventory
The following tables outline the diagnostic report for the Cisco HCS Service Inventory services.
| Property Name | Property Value Description |
|---|---|
| Date of Last Report | The day and time of the last report. Also shows if the report has not been run yet. |
| Status of Last Report | Whether the report succeeded or failed. |
| Alarm Code | The type of failure/alarm if the report failed. |
| Property Name | Property Value Description |
|---|---|
| Start Time | The day and time that the SI Agent Route Builder started. |
| Up Time | The total time (hh:mm:ss) that SI Agent Route Builder has been up. |
| Property Name | Property Value Description |
|---|---|
| Agent Status | Agent Status options are Green or Red. |
| Start Time | The day and time that the SI General Agent started. |
| Up Time | The total time (hh:mm:ss) that SI General Agent has been up. |
| Property Name | Property Value Description |
|---|---|
| Scheduler Enabled | Whether or not the scheduler is enabled. |
| Current State | The current state may be Idle or Active. |
| Report Execution Time | The time the report ran (24-hour mode). |
| Report End Time | SI reports on provisioning up until this time. |
| Report Version | The software version for which the report is run. |
| Property Name | Property Value Description |
|---|---|
| Number of Backup Days | The number of days for which Backup occurs. |
| Custom Report Enabled | Whether or not Custom Report is enabled. |
| Backup File Count | The number of backup files created. |
| Property Name | Property Value Description |
|---|---|
| SI Host | The name of the SI Host. |
| SI Port | The number of the SI port in use. |
| SI User | The name of the SI user. |
| Property Name | Property Value Description |
|---|---|
| SFTP Host | The name of the SFTP Host. |
| SFTP Port | The number of the SFTP port in use. |
| SFTP User | The name of the SFTP user. |
| SFTP Destination Path | The SFTP Destination Path. |
| SFTP Max File Size | The maximum SFTP file size allowed. |
| SFTP Retry Count | A count of the number of SFTP retries. |
| Property Name | Property Value Description |
|---|---|
| Total Customers to Process | The total number of UC Customers the UCDCM is processing. |
| Number Message Managers | The number of Message Managers available for processing. |
| Number Messages per Manager | The number of messages a Message Manager can handle at a time. |
UCPA Diagnostic Report
UCPA Agent Properties
The following tables outline the diagnostic report for the Cisco HCS Unity Connection Provisioning Adapter service.
| Property Name | Property Value Description |
|---|---|
| ucpa AgentRouteBuilder Status | Signifies the health of the agent; options are Red, Yellow, or Green. |
| Recommended Action | Recommended action to correct last failure. If "Unknown," then no failures to report. |
| Configured ucpa Agents | The number of UCPA Agents configured. |
| Device AgentInstanceMap Size | The number of application instances managed. |
| Property Name | Property Value Description |
|---|---|
| Agent Instance Id | Internal Id of the agent. |
| Agent Status | Signifies the health of the agent; options are Red, Yellow, or Green. |
| Creation Time | Date and time the agent was created. |
| Total Success | Total number of requests sent to application instances that were successful. |
| Total Failures | Total number of requests sent to application instances that were un-successful. |
| Last Success Time | Date and time the last successful request was made to an application instance. |
| Last Failure Time | Date and time the last unsuccessful request was made to an application instance. If this time is equal to the agent's creation time, then no failures have occurred. |
| Last Failure Reason | The reason for the last failure. If "Unknown," then no failures to report. |
| Last Failure (Recommended Action) | Recommended action to correct last failure. If "Unknown," then no failures to report. |
UCSMSync Diagnostic Report
Cisco HCS UCSMSync
The following table outlines the diagnostic report for the Cisco HCS UCSMSync service.
| Property Name | Property Value Description |
|---|---|
| Name | The name of the Cisco Unified Communications Manager. |
| Auto-sync | Signifies if the status of Cisco Unified Communications Manager auto-sync, options are Enabled or Disabled. |
| Overall Status | Signifies the health of the UCSMSync, options are Red, Yellow, or Green. |
| Status Info | Job status information for the UCSMSync, field is empty if no job has started for this application. |
| Recommended Action | Job recommended action for the UCSMSync, field is empty if no job has started for this application. |
| Status Details | Displays any status details, field is empty if no job has started for this application. |
| FSM State | Displays the state of the FSM. |
| Retry timer | Displays the state of the retry timer. |
| ConnectionCheck timer | Displays the state of the connection check timer. |
| UCSManager Connection | The URL used to connect to the UCS manager. |
| SDR Connection | The URL used to connect to the database. |
| Messages received | Number of messages received. |
| Diag Level | The diag level for the report. |
VcenterSync Diagnostic Report
Cisco HCS VCenterSync
The following table outlines the diagnostic report for the Cisco HCS VCenterSync service.
| Property Name | Property Value Description |
|---|---|
| Name | The name of the vCenter. |
| Auto-sync | Signifies if the status of vCenter auto-sync, options are Enabled or Disabled. |
| Overall Status | Signifies the health of the VCenterSync, options are Red, Yellow, or Green. |
| Status Info | Job status info for the VCenterSync, field is empty if no job has started for this application. |
| Recommended Action | Job recommended action for the VCenter Sync, field is empty if no job has started for this application. |
| Status Details | Displays any status details, field is empty if no job has started for this application. |
| FSM State | Displays the state of the FSM. |
| Retry timer | Displays the state of the retry timer. |
| ConnectionCheck timer | Displays the state of the connection check timer. |
| VCenter Connection | The URL used to connect to the vCenter. |
| SDR Connection | The URL used to connect to the database. |
| Messages received | Number of messages received. |
| Diag Level | The diag level for the report. |
HCS License Manager for Cisco HCM-F
Software Requirements
Cisco HCS License Manager requires the following software to perform licensing management:
-
Cisco Hosted Collaboration Mediation Fulfillment 10.1(1) or later release
-
Enterprise License Manager 9.x
-
Prime License Manager 10.0 or later release
-
Cisco Unified Communications Manager 9x or later release
-
Cisco Unity Connection 9x or later release
Note | Cisco Unified Communications Domain Manager is not required. However it is convenient for the users to sync all of the provisioned customers and UC clusters from Cisco Unified Communications Domain Manager to SDR before performing any Cisco HCS license operation. |
License Management Overview
Note | In this document, the term License Manager refers to both Enterprise License Manager and Prime License Manager. |
HLM runs as a stand-alone Java application on the Hosted Collaboration Mediation Fulfillment platform, utilizing Cisco Hosted Collaboration Mediation Fulfillment service infrastructure and message framework. There is one HLM per install of Cisco HCS. HLM and its associated License Manager manage licenses for Cisco Unified Communications Manager, Cisco Unity Connection, and TelePresence Room.
Note | There is no licensing requirement for Presence Service and Cisco Unified Communications Manager IM. |
HLM requires that you set the Cisco HCS global deployment mode before you can create a License Manager instance in the Cisco HCS space. The Cisco HCS global deployment mode must be either Cisco HCS, Cisco HCS-Large Enterprise (HCS-LE) or Enterprise for Enterprise Agreement. The global deployment mode enforces that every assigned License Manager instance and assigned cluster must have the same deployment mode. You cannot change the global deployment mode if there is still a License Manager instance in the Cisco HCS space.
Through the Cisco Hosted Collaboration Mediation Fulfillment NBI or GUI, an administrator can create, read, or delete a License Manager instance in Cisco HCS. A Cisco Hosted Collaboration Mediation Fulfillment administrator cannot perform any licensing management function until HLM validates its connection to the installed License Manager and its license file is uploaded. HLM exposes an interface to list all of the License Manager instances.
After the administrator successfully adds and validates a License Manager instance to the HLM, one can assign a customer to the License Manager. This action does not make all CUCM and CUC 9.x clusters within this customer to be assigned to that License Manager automatically. The administrator must assign each of the customer's CUCM or CUC 9.x cluster to an License Manager after the associated customer is assigned to that License Manager. If the customer is not assigned to any License Manager, the cluster assign fails, and the user is advised to associate the customer with an License Manager first.
The administrator can unassign a UC cluster from a License Manager through the HLM NBI or GUI.
For more information about Prime License Manager see Cisco Prime License Manager User Guide.
Note | Customers that are assigned to Enterprise Licensing Manager 9.0 are not reported. The license usage of 9.0 clusters that are assigned to Enterprise Licensing Manager 9.1 is not counted in the report either. |
The Administrator requests the system-level Cisco HCS license report through the HLM GUI or NBI. The report request generates two files: csv, and xlsx format. Both files are saved into the HLM license report repository (/opt/hcs/hlm/reports/system) for future download. The retention period of the report is set to 60 days by default.
Inter-Component Relationships
Note | Ensure you sync the customer and cluster data into the SDR before performing any license operations. |
CUCDM Sync
HLM retrieves customer and UC cluster information from the SDR. The cluster version must be 9.0.1 or higher for HLM to import that cluster. You can update this data by a scheduled CUCDM-sync (highly recommended), a manual CUCDM-sync, or through manual provisioning using the Cisco Hosted Collaboration Mediation Fulfillment GUI or NBIs.
Restrictions
The following restrictions apply:
-
Only stand-alone License Manager is supported. Co-resident License Manager is not supported in HCS.
-
The maximum cluster capacity of an Enterprise License Manager is 200.
-
The maximum cluster capacity of a Prime License Manager is 1000.
-
A License Manager instance cannot be created in the Cisco HCS space without a valid connection to the installed License Manager.
-
A License Manager instance cannot be created in Cisco HCS if the installed License Manager has a demo license installed.
-
A Cisco Unified Communication IM and Presence Service cluster cannot be assigned to a License Manager.
-
An 8.x UC cluster cannot be assigned to a License Manager.
-
Unity Connection 9.0(1) FCS is not supported with HLM. The user should install Cisco Unity Connection 9.0(1)ES1 or later release.
-
The Cisco HCS license report retention period is set to 60 days by default. The value can be set through CLI with minimum = 1 and maximum = 120.
-
The audit interval is set to four hours by default. The value can be changed through CLI with minimum = 4 and maximum = 24.
-
The license report does not display the license usage of a customer that is associated with a 9.0 Enterprise License Manager. The report does not count the license usage of a customer's 9.0 clusters that are assigned to an Enterprise License Manager 9.1.
UC Solution Impacts and Dependencies
CUCM Interactions
-
Verify and start, if necessary, the Platform Administrative Web Service in the CUCM cluster publisher.
-
Configure the platform credential of the publisher.
Note
Platform credentials are equal to the CUCM OS admin user credentials.
-
If the cluster's platform credential is not found, HLM uses the default credential if one is configured.
Unity Connection Interactions
-
Verify and start, if necessary, the Platform Administrative Web Service in the CUC cluster publisher.
-
Configure the platform credential of the publisher.
Note
Platform credentials are equal to the CUC OS admin user credentials.
-
If the cluster's platform credential is not found, HLM uses the default credential if one is configured.
Limitations
-
Changing an License Manager hostname or IP Address is not supported in HLM. The user is required to remove all of the clusters of the License Manager, delete the License Manager from the Cisco HCS space, then recreate a License Manager with the correct hostname or IP address.
-
HLM auditing validates the connection between the License Manager instance and the installed License Manager. However, it is the Cisco Hosted Collaboration Mediation Fulfillment Administrator's responsibility to remove the License Manager instance from HLM after uninstalling the actual License Manager.
HCS Licensing Operations
The following are the licensing operations that a user performs through HLM:
Get/Set HCS Global Deployment Mode
Cisco HCS Global Deployment mode must be set before any HLM licensing operation is performed. The value can be either HCS, HCSLE or Enterprise. You can set the global deployment mode through either HLM NBI setHLMGlobalDeploymentMode or Cisco Hosted Collaboration Mediation Fulfillment License Management Setting page. The global deployment mode cannot be changed if there is still an License Manager in Cisco HCS space.
Prime License Manager Related Operations
You can add a new License Manager instance by specifying its name, hostname, OS Administration ID, and password through either HLM NBI createPLM or License Management >License Management Summary page. The creation is not allowed if the connection test to the actual installed License Manager fails or the license file is still not uploaded (demo licensing). This create operation enforces the installed License Manager having the same deployment mode to Cisco HCS global deployment mode.
You can edit the version from the drop-down menu on the GUI or through NBI updatePLM to sync with the installed License Manager version.
You can remove an License Manager through either the HLM NBI deletePLM or License Management >License Management Summary page. You must unassign all of the clusters within an License Manager before the License Manager can be deleted. The delete operation removes the License Manager instance in Cisco HCS space, and resets the installed License Manager deployment mode to Enterprise.
Cluster Assign/Un-Assign Operations
The Administrator can assign an eligible UC cluster to an License Manager through the HLM NBI assignCluster by specifying the cluster name and License Manager name, or by using the Cisco Hosted Collaboration Mediation Fulfillment GUI.
After the Administrator successfully assigns a cluster to an License Manager, the corresponding job is updated with status = Succeeded and a description like assigning cluster abc-cluster to License Manager xyz-plm succeeded. The assigned UC cluster's deployment mode is set to Cisco HCS global deployment mode and a new product instance is created in the License Manager inventory section. For failed assigning operations, the job is updated with status = Failed and a description like Assigning cluster abc-cluster to License Manager xyz-plm failed: fail reason.
The Administrator can unassign a cluster from an License Manager through either the HLM NBI or GUI.
After the Administrator successfully unassigns a cluster from a License Manager, the corresponding job is updated with status = Succeeded and a description like Unassigning cluster abc-cluster from License Manager xyz-plm succeeded. The unassigned UC cluster's deployment mode is reset to Enterprise and its product instance is removed from the License Manager inventory section. For failed operations, the job is updated with status = Failed and a description like Unassigning cluster abc-cluster from License Manager xyz-plm failed: fail reason.
Note | Cluster assign and unassign operations are considered asynchronous. After receiving the request, HLM responds with a job ID before performing any licensing function. After the job is complete, HLM updates the job table in SDR with the result, such as Succeeded or Failed, and a detailed description of the operation. It usually takes about 30 to 40 minutes to complete a UC cluster assign/unassign operation. Due to the longevity of each cluster assign/unassign operation, you should not run more than 5 parallel jobs at any time to avoid potential deployment mode mismatch between UC clusters and Prime License Managers. |
Update an Assigned Cluster's Credential
If the OS Admin credential of an assigned cluster is changed, you should reflect this change in both HLM and License Manager through the HLM NBI updateAssignedCluster with the cluster name, License Manager name, and the changed credential.
Or go into Cisco Hosted Collaboration Mediation Fulfillment GUI, locate the assigned cluster's publisher in Application Management >Cluster Application, then change its platform credential. Log into License Manager, find the assigned cluster in inventory, then change the credential.
Sync License Manager Operation
You can sync a License Manager version in HLM after the installed License Manager version is successfully switched. Go to the PLM Edit and click sync to retrieve the currently installed License Manager version.
Customer Deal ID
You can add, update, or delete the Deal IDs by editing the Deal IDs field in the GUI.
Generate HCS License Reports
Click Request New Report to create two HCS system-level license reports in csv and xslx format. The files should be saved to the HCS license report directory.
List and Download HCS License Reports
All of the Cisco HCS license reports in the repository are displayed with file name, date, and size. You can select one file at a time to download to your desktop.
HCS License Report
HCS License Reports
In HLM 10.x,, license reports displays 9.x and 10.x license versions. HLM supports system level license report generation. The report includes all customers on the system with aggregate license consumption at customer level. It supports deployment with one or multiple UC clusters and License Managers. Optional field "Deal ID" at the customer level is included in the report. Each customer has zero to multiple Deal IDs that can be configured through the Cisco Hosted Collaboration Mediation Fulfillment GUI. The Deal ID field is free text format. Deal ID(s) come from a Cisco Account Manager who works with the service provider to develop Cisco HCS business with the specific customer. Entering the Deal IDs makes this report more useful to the service provider's business personnel responsible for monthly POS reporting to Cisco.
Request the Cisco HCS license report through the Cisco Hosted Collaboration Mediation Fulfillment GUI. The report request will generate two files: one is in csv, the other one is in xlsx format. Both files will be saved into the HLM license report repository for future download. The retention period of the report is set to 60 days by default.
The naming convention of a system level Cisco HCS license report is LicenseReport_ALL_YYYYMMDD_hhmmss.csv/xlsx , see the following examples:
Audit
HLM auditing is run every four hours by default to check to see if the clusters in SDR match the clusters found in an associated License Manager. There are three scenarios that can occur from this check:
- The clusters in License Manager and SDR match and no further action needs to be taken.
- SDR reports an additional cluster assigned to a License Manager that the License Manager does not have provisioned. In this case, HLM sends out a HLMAuditWarning alarm and adds the missing cluster(s) to the License Manager.
- License Manager reports an additional cluster assigned to it, yet this cluster is not assigned by SDR. In this case HLM sends out a HLMAuditWarning alarm and informs the administrator to manually remove the cluster from the License Manager and to assign it through the HLM service.
After HLM auditing finishes checking for Cluster List matching, it verifies credentials for every assigned cluster provisioned in SDR and ensures that the credentials for the cluster provisioned in License Manager match.
If a mismatch is detected, HLM auditing updates the cluster credentials in License Manager to match those of SDR, keep SDR the master record. It then sends out a HLMAuditingWarning alarm noting the disparity. This happens if the username, password, or both mismatch.
This also covers the case where the Cisco HCS administrator updates the cluster credentials in SDR but does not update the assigned cluster's credentials through HLM. HLM auditing eventually detects the disparity and corrects this automatically after the auditing has run.
HLM auditing compares the version of the installed License Managers to the Prime License Manager instances in SDR. If a version mismatch is detected, HLM updates the License Manager version in SDR according to the version value of the installed Prime License Manager.
The auditing interval is set through the CLI with a value between 4 and 24 hours. The new audit interval value will be effective immediately once HLM receives the corresponding change notification. No service restart is needed to make the new interval value become effective. HLM auditing also adds a new function to check license report disk space usage. If the report repository disk space exceeds the configured value, a warning alarm HLMDiskSpaceAllotmentExceeded is sent out.
Cisco HCM-F Real-Time Monitoring Tool
Cisco Hosted Collaboration Mediation Fulfillment (Cisco HCM-F) Real-Time Monitoring Tool (RTMT) runs as a client-side application and uses HTTPS to monitor system performance. Real-Time Monitoring Tool can connect directly to a device through HTTPS to troubleshoot system problems. Tasks such as alarm and performance monitoring updates continue to run on the server in the background even when RTMT is not connected to the server.
The Cisco Hosted Collaboration Mediation Fulfillment installation consists of one application server and may contain one or more Web Services (WS) servers. While the Real-Time Monitoring Tool can provide troubleshooting support for more than one server, you can monitor only one server in each Real-Time Monitoring Tool session
Note | It is possible to launch more than one Real-Time Monitoring Tool session (for example, one session is connected to the Cisco Hosted Collaboration Mediation Fulfillment application server and another session is connected to an Cisco Hosted Collaboration Mediation Fulfillment Web Services server). However, multiple Real-Time Monitoring Tool sessions are not recommended by Cisco. |
Real-Time Monitoring Tool allows you to perform the following tasks:
-
Monitor a set of predefined management objects and performance counters that monitor the health of the server to which the Real-Time Monitoring Tool is connected.
-
Configure and update alert settings for the management objects and performance counters (in the form of email messages).
The Cisco Hosted Collaboration Mediation Fulfillment server monitors the alert conditions and generates alerts when values exceed the range defined by user-configured thresholds. The Real-Time Monitoring Tool does not need to be running on your computer in order for alerts to be generated by the server. Alerts are displayed in the Real-Time Monitoring Tool in the form of alert logs and in Alert Central.
-
Collect and download or view traces and logs.
-
View syslog messages in SysLog Viewer.
Performance Monitoring
Cisco Hosted Collaboration Mediation Fulfillment updates performance monitor (perfmon) counters which contain simple, useful information about the system. You can use RTMT to monitor the performance of system components and applications by selecting, for any object, the counters to monitor. The counters available for each object are shown when you expand the object folder. RTMT periodically polls the selected counters to display data for those counters. RTMT also provides alert notifications for troubleshooting performance.
RTMT allows you to perform the following performance monitoring tasks:
-
Continuously monitor a set of preconfigured objects.
-
Associate counter threshold settings to alert notification. An email or popup message provides notification to the administrator.
-
Save and restore settings, such as counters being monitored, threshold settings, and alert notifications, for customized troubleshooting tasks.
-
Display up to six perfmon counters in one chart for performance comparisons.
-
Group perfmon counters into categories, to help you troubleshoot specific performance, system, or device problems.
-
Log perfmon counters locally on your computer.
-
View the local or server-based performance logs.
Performance Counter Interface
RTMT contains ready-to-view, predefined performance counters. You can also select and add counters to monitor in RTMT using performance queries.
RTMT displays performance counters in chart or table format. Chart format presents a miniature window of information. You can display a particular counter by double-clicking the counter in the perfmon monitoring pane.
Attributes for predefined performance counters, such as format and category, remain fixed. You can define attributes for counters that you configure in RTMT. Because chart view represents the default, you can configure the performance counters to display in table format when you create a category.
- Category Tabs
- Sample Rate
- Zoom In on Perfmon Counter
- Highlight Charts and Graphs
- Counter Properties
- Alert Notification for Counters
Category Tabs
A category comprises a group of monitored performance counters. A tab in the RTMT monitoring pane contains the category name. All performance counters that are monitored in this tab belong to a category. RTMT displays any categories that you access during a RTMT session in the bottom toolbar.
The system polls the performance counters in the tab at the same rate, with each category configured to have its own polling rate.
You can create custom categories in the RTMT monitoring pane to view information that helps you troubleshoot specific performance, system, or device problems. If your system is experiencing performance problems with specific objects, create custom categories to monitor the performance of the counters within the object. If the system is experiencing problems with specific devices, create custom categories to monitor the devices in your system. In addition, you can create alert notifications for counters and gateways in these custom categories. To create custom categories, you add a new category tab. When the tab is created, you specify the specific performance counters, devices, and alerts within that tab and then save your custom category by using Profile.
Sample Rate
The application polls the counters, devices, and gateway ports to gather status information.
The polling rate in each precanned monitoring window remains fixed, and the default value specifies 30 seconds. If the collecting rate for the AMC (Alert Manager and Collector) service parameter changes, the polling rate in the precanned window also updates. In addition, the local time of the RTMT client application and not the backend server time, provides the basis for the time stamp in each chart. For more information on Service Parameters, refer to System Configuration Guide for Cisco Unified Communications Manager or Cisco Unity Connection System Administration Guide.
In the RTMT monitoring pane, you configure the polling intervals for the applicable performance counters, devices, and gateway ports for each category tab that you create.
Note | High-frequency polling rate affects the performance on the server. The minimum polling rate for monitoring a performance counter in chart view equals 5 seconds; the minimum rate for monitoring a performance counter in table view equals 1 second. The default for both specifies 10 seconds. |
Zoom In on Perfmon Counter
To get a closer look at perfmon counters, you can zoom in on a perfmon monitor counter in the RTMT.
| Step 1 | To zoom in on a
counter, perform one of the following tasks:
|
| Step 2 | To zoom out a counter, perform one of the following actions: |
Highlight Charts and Graphs
The highlight feature helps to distinguish hosts and counters when multiple nodes or counters display on color-coded graphs. This feature is active in the System Summary, CPU and Memory, Disk Usage, and Performance Log Viewer windows.
| Step 1 | To highlight
charts and graphs, perform one of the following tasks:
|
| Step 2 | To return a highlighted item to its original appearance in the Performance Log Viewer, select another item to highlight. |
Counter Properties
Counter properties allow you to display a description of the counter and configure data-sampling parameters.
The Counter Property window contains the option to configure data samples for a counter. The performance counters that display in the Unified RTMT performance monitoring pane contain green dots that represent samples of data over time. You can configure the number of data samples to collect and the number of data points to show in the chart. After the data sample is configured, view the information by using the View All Data/View Current Data menu option to view the data that a perfmon counter collected.
Alert Notification for Counters
When you activate the Alert Notification feature, the application notifies you of system problems. Perform the following configuration setup to activate alert notifications for a system counter:
From the RTMT Perfmon Monitoring pane, choose the system perfmon counter.
Set up an email or a message popup window for alert notification.
Determine the threshold for the alert (for example, an alert activates when calls in progress exceed the threshold of over 100 calls or under 50 calls).
Determine the frequency of the alert notification (for example, the alert occurs once or every hour).
Determine the schedule for when the alert activates (for example, on a daily basis or at certain times of the day).
Alerts for Cisco HCM-F
RTMT Alerts
The system generates alert messages to notify the administrator when a predefined condition is met, such as when an activated service goes from up to down. The system can send alerts by email or e-page.
RTMT, which supports alert defining, setting, and viewing, contains preconfigured and user-defined alerts. Although you can perform configuration tasks for both types, you cannot delete preconfigured alerts (whereas you can add and delete user-defined alerts). The Alert menu comprises the following menu options:
-
Alert Central: This option comprises the history and current status of every alert in the system.
Note
You can also access Alert Central in the QuickLaunch Channel by clicking .
-
Set Alert/Properties: This option allows you to create or modify alerts and alert properties.
-
Remove Alert
-
Enable Alert
-
Disable Alert
-
Suspend Cluster/Node Alerts: This option allows you to temporarily suspend alerts on a particular server.
-
Clear Alert: This option allows you to reset an alert (change the color of an alert item to black) to signal that the alert has been handled. After an alert is raised, its color automatically changes in RTMT and stays that way until you manually clear the alert.
Note
The manual clear alert action does not update the System Cleared Timestamp column in Alert Central. The column is updated only if the alert condition is automatically cleared.
-
Clear all Alerts
-
Reset All Alerts to Default Config: This option allows you to reset all the alerts to the default configuration.
-
Alert Detail: This option allows you to view detailed information for alert events.
-
Config Email Server: In this category, you can configure the email server to enable alerts.
Note | To configure RTMT to send alerts using email, you must configure DNS. |
-
Config Alert Action: This option allows you to define the actions for specific alerts; you can configure the actions to send the alerts to specific email addresses.
In RTMT, you configure alert notification for performance monitor counter value thresholds and set alert properties such as the threshold, duration and frequency. RTMT predefined alerts are configured for performance monitor counter thresholds as well as event (alarm) notifications.
Alert Central Displays
RTMT displays both preconfigured alerts and custom alerts in Alert Central. RTMT organizes the alerts under the System, HCS, and Custom tabs.
You can enable or disable preconfigured and custom alerts in Alert Central; however, you cannot delete preconfigured alerts.
Alert Fields
You can configure both preconfigured and user-defined alerts in RTMT. You can also disable both preconfigured and user-defined alerts. You can add and delete user-defined alerts; however, you cannot delete preconfigured alerts.
Note | Severity levels for syslog entries match the severity level for all RTMT alerts. If RTMT issues a critical alert, RTMT identifies the corresponding syslog entry as critical. |
The following table describes the fields that you can configure for each alert; users can modify preconfigured fields, unless otherwise noted.
|
High-level name of the monitor item with which RTMT associates an alert |
Descriptive name. For preconfigured alerts, you cannot modify this field. See topics related to Alert Central displays for a list of preconfigured alerts. |
|
|
You cannot modify this field for preconfigured alerts. For a list of preconfigured alerts, See topics related to Alert Central. |
||
|
You cannot modify this field. You can associate only one instance of the performance counter with an alert. |
||
|
Specify up < - > down, less than #, %, rate greater than #, %, rate. This field is applicable only for alerts based on performance counters. |
||
|
Specify value to be evaluated as absolute, delta (present - previous), or % delta. This field is applicable only for alerts that are based on performance counters. |
||
|
Condition to raise alert (how long value threshold must persist before the system raises an alert) |
Options include the system sending the alert immediately or after a specified time that the alert has persisted. This field is applicable only for alerts that are based on performance counters. |
|
|
Raise alert only when a configurable number of events exceeds a configurable time interval (in minutes) |
For ExcessiveVoiceQualityReports, the default thresholds are 10 to 60 minutes. For RouteListExhausted and MediaListExhausted, the defaults are 0 to 60 minutes. This field is applicable only for event-based alerts. |
|
|
ID of alert action to take (system always logs alerts regardless of the alert action) |
Alert action gets defined first. A blank field indicates that email is disabled. |
|
|
Resets alert (change the color of an alert item to black) to signal that the alert has been resolved |
After an alert has been raised, its color automatically changes and stays that way until you manually clear the alert. Use Clear All to clear all alerts. |
|
|
How often to generate an alert when alert condition persists |
Specify every X minutes. (Raise alert once every X minutes if condition persists.) Specify every X minutes up to Y times. (Raise alert Y times every X minutes if condition persists.) |
|
|
Administrator to append text on top of predefined alert text |
||
|
For viewing purposes (for example, show only Severity 1 alerts) |
Specify defaults that are provided for predefined (for example, Error, Warning, Information) alerts. |
Alert Action Setup
In RTMT, you can configure alert actions for each alert that is generated and to send the alert action sent to email recipients that you specify in the alert action list.
The following table provides a list of fields that you use to configure alert actions. You can configure all fields, unless otherwise marked.
|
List of email addresses. You can selectively enable or disable an individual email address in the list. |
Automatic Trace Download Activation
Some preconfigured alerts allow you to initiate a trace download based on the occurrence of an event. You can automatically capture traces when a particular event occurs by checking the Enable Trace Download check box in Set Alert/Properties for the following alerts:
-
CriticalServiceDown: This alert is generated when any service is down. The CriticalServiceDown alert monitors only those services that are listed in RTMT Critical Services.
Note
The RTMT back-end service checks status (by default) every 30 seconds. If service goes down and comes back up within that period, the CriticalServiceDown alert may not be generated.
-
CoreDumpFileFound: This alert is generated when RTMT back-end service detects a new Core Dump file.
Note | You can configure both CriticalServiceDown and CoreDumpFileFound alerts to download corresponding trace files for troubleshooting purposes. This helps preserve trace files at the time of crash. |
 Caution | Enabling Trace Download may affect services on the server. Configuring a high number of downloads will adversely affect quality of service on the server. |
Alert Logs
The alert log stores the alert, which is also stored in memory. The memory is cleared at regular intervals, leaving the last 30 minutes of data in memory. When the service starts/restarts, the system loads the last 30 minutes of the alert data into memory by reading from the alert logs on the server. The system sends alert data in the memory to the RTMT client on request.
Upon RTMT startup, RTMT shows all logs that occurred in the last 30 minutes (on just the server to which RTMT is connected) in the Alert History section of the Alert Central pane. The system updates the alert log periodically, and inserts new logs into the Alert History section. When the number of logs reaches 100, RTMT removes the oldest 40 logs.
The following file name format for the alert log applies: AlertLog_MM_DD_YYYY_hh_mm.csv.
The alert log includes the following attributes:
-
Time Stamp: The time when RTMT logs the data
-
Node: Server name for where RTMT raised the alert
-
Alert Name: Descriptive name of the alert
-
Severity: Severity of the alert
-
Sent to: E-mail address to which the alert was sent
-
Description: Description of the monitored object
-
Alert Message: Detailed description about the alert
-
Type: Type of the alert
-
PollValue: Value of the monitored object where the alert condition occurred
-
Action: Alert action taken
-
Group ID: Identifies the source of the alert
The first line of each log file comprises the header. Details of each alert are written in a single line, separated by a comma.
Log Partition Monitoring Tool Service
The Cisco Log Partition Monitoring Tool service, which is installed automatically with the system, uses configurable thresholds to monitor log partition disk usage on a server. The service starts automatically after system installation.
Every 5 minutes, the service uses the following configured thresholds to monitor log partition disk usage and the spare log partition on a server:
-
LogPartitionLowWaterMarkExceeded (% disk space): When disk usage is above the percentage that you specify, the service sends an alarm message to syslog and an alert to RTMT Alert Central. To save the log files and regain disk space, you can use Trace & Log Central in RTMT.
-
LogPartitionHighWaterMarkExceeded (% disk space): When disk usage is above the percentage that you specify, the service sends an alarm message to syslog and an alert to RTMT Alert Central.
-
SparePartitionLowWaterMarkExceeded (% disk space): When disk usage is above the percentage that you specify, the service sends an alarm message to syslog and an alert to RTMT Alert Central. To save the log files and regain disk space, you can use Trace & Log Central in RTMT.
-
SparePartitionHighWaterMarkExceeded (% disk space): When disk usage is above the percentage that you specify, the service sends an alarm message to syslog and an alert to RTMT Alert Central.
In addition, the Cisco Log Partition Monitoring Tool service checks the server every 5 seconds for newly created core dump files. If new core dump files exist, the service sends a CoreDumpFileFound alarm and an alert to Alert Central with information on each new core file.
To monitor the log partition, verify that the Cisco Log Partitioning Monitoring Tool service (a network service) is running on the Cisco HCM-F server. Stopping the service causes a loss of feature functionality.
When the service starts at system startup, the service checks the current disk space usage. If the percentage of disk usage is above the low-water mark, but below the high-water mark, the service sends an alarm message to syslog and generates a corresponding alert in RTMT Alert Central.
To configure the Cisco Log Partition Monitoring Tool service, set the alert properties for the LogPartitionLowWaterMarkExceeded and LogPartitionHighWaterMarkExceeded alerts in Alert Central.
To offload the log files and regain disk space on the server, use RTMT to collect the traces that you want to save.
If the percentage of disk usage is above the configured high-water mark, the system sends an alarm message to syslog, generates a corresponding alert in RTMT Alert Central, and automatically purges log files until the value reaches the low water mark.
Note | The Cisco Log Partition Monitoring Tool service automatically identifies the common partition that contains an active directory and an inactive directory. The active directory contains the log files for the current installed version of the software and the inactive directory contains the log files for the previous installed version of the software. If necessary, the service deletes log files in the inactive directory first. It then deletes log files in the active directory, starting with the oldest log file for every application until the disk space percentage drops below the configured low-water mark. The Cisco Log Partition Monitoring Tool service does not send an email when log partition monitoring purges the log files. |
After the system determines the disk usage and performs the necessary tasks (sending alarms, generating alerts, or purging logs), log partition monitoring occurs at regular 5-minute intervals.
Traces and Logs
About Trace & Log Central
Collect trace files that contain search criteria that you specify and save the trace collection criteria for later use.
Schedule a recurring trace collection and download the trace files to an SFTP or FTP server on your network.
Collect a crash dump file.
Edit the settings for traces on the server that you specify.
Note
Enabling trace settings decreases system performance; therefore, enable traces for troubleshooting purposes only.View the trace files in the appropriate viewer within RTMT or by using an external viewer.
You can also view traces on the server without downloading the trace files by using the Remote Browse feature.
Note | To use Trace & Log Central, ensure that RTMT can directly access the server without Network Access Translation (NAT). If NAT is set up to access devices, configure the servers with a hostname instead of an IP address and ensure that the hostnames and their routable IP addresses are in the DNS server or host file. For devices that support encryption, the SRTP keying material does not appear in the trace file. |
Display RTMT Trace & Log Central Options
To import the security certificates, select and then click OK.
After you display Trace & Log Central in RTMT, you can perform the following tasks:
- Use Collect Files to download services and application traces from the server.
- Use Query Wizard to collect and download trace files that contain search criteria that you specify. You can save your trace collection query for later use.
- Use Schedule Collection to create recurring trace collection. You can download the trace files to an SFTP or FTP server on your network.
Use Real Time Trace to view service trace data or to view event trace data as it is collected in real time. For events, you can perform a specified action when a string matching your search criteria appears in the trace file.
- Use Collect Crash Dump to download a crash dump file from the server.
- Use Collect Install Logs to download the install logs from the server.
- Use Audit Logs to browse the audit logs, download the audit logs, or schedule a download of the audit logs. You can download the audit logs to an SFTP or FTP server on your network.
- Use Remote Browse to view the collected trace files on the server.
- Use Local Browse to view the trace files that you downloaded.
Trace File Collection, Throttling, and Compression
The Collect Files option in Trace & Log Central is used to collect traces for services, applications, and system logs on the server.
Note | The services that you have not activated are also shown, so you can collect traces for those services. |
RTMT Trace & Log Central disk I/O and CPU throttling
RTMT supports the throttling of critical Trace & Log Central operations and jobs, whether they are running on-demand, scheduled, or automatic. Throttling slows the operations when I/O utilization is in high demand for call processing, so call processing can take precedence.
When you make a request for an on-demand operation when the call processing node is running under high I/O conditions, the system displays a warning that gives you opportunity to cancel the operation. You can configure the I/O rate threshold values that control when the warning displays with the following service parameters (in Cisco RIS Data Collector service):
The system compares the values of these parameters against the actual system CPU and I/OWait values. If the goal (the value of the service parameter) is lower than the actual value, the system displays the warning.
Trace compression support
The Recoverable Outstream (ROS) library supports compressed output of trace files. Files are compressed as they are generated. The benefits of trace file compression include the following:
Compression reduces the capacity that is required to store trace files.
Compression reduces the disk head movement, which results in significantly improved disk I/O wait. This may prove of value when trace file demand is high.
Use the enterprise parameter Trace Compression to enable or disable trace compression. The default value for this parameter is Disabled.
Note | File compression adds additional CPU cycles. Enabling the Trace Compression enterprise parameter can negatively affect overall call throughput by as much as 10 percent. |
Using Maintenance Tools and Utilities
Service Inventory Tasks
UC Application Provisioning
Service Inventory report generation for UC Applications requires some additional steps after adding a cluster in Infrastructure Manager. After the cluster application is saved in Infrastructure Manager, perform the following steps:
| Step 1 | Click Add New on the Credentials Tab. | ||
| Step 2 | Select the
Credential Type.
| ||
| Step 3 | Enter User ID, Password and Re-enter Password and click Save. | ||
| Step 4 | Repeat to add the next Credential Type. | ||
| Step 5 | Click on the Network Address Tab and Click Add New. | ||
| Step 6 | Select the
Network Space : Service Provider Space.
| ||
| Step 7 | Enter
IPV4
Address and click
Save.
| ||
| Step 8 | Repeat all for the next cluster application. |
Set up Schedule for Daily Report Generation
The Overview page in the Service Inventory administrative interface displays the current status for Service Inventory and any events that you scheduled.
Tip | If you do not configure the required options on the Configuration page in the Service Inventory administrative interface, the report generation fails. |
If the Enable Schedule check box is unchecked, the report does not get generated at the specified time. Keep the Enable Schedule check box unchecked until you are ready to send billing files. If the Configuration page is not configured correctly, the report generation fails.
To schedule the generation of daily reports, perform the following procedure.
Service Inventory can generate reports only from a Cisco Unified Communications Manager and Cisco Unity Connection running UC Application Software Version 8.6(2) or later.
Note | Reports are generated differently, depending on your configuration:
|
| Step 1 | Check Enable Schedule. | ||||
| Step 2 | Select Refresh to get the most up-to-date time on the server. | ||||
| Step 3 | Set a time to
begin the report daily using the format HH:MM:SS (HH = hours, MM = minutes, SS
= seconds).
| ||||
| Step 4 | Set the time that you want the reporting period to end using the format HH:MM:SS. The generated report contains data from 24 hours before the set time up to and including the set time. | ||||
| Step 5 | Select the
report format version that you want the SI application to deliver.
From the page, be sure to select the Unified Communications Domain Manager software versions 8.0 or 8.1 for 9.0(1) and 8.6(2) HCS report formats to generate properly.
Service Inventory Unified Communications Domain Manager report To ensure that 9.1(1) and 9.0(1) HCS report formats are generated properly, from the page, be sure to select the Unified Communications Domain Manager Software Version 8.0 or 8.1. Service Inventory UC Application report If a customer is provisioned in Unified Communications Domain Manager, that customer cannot be manually provisioned in Cisco HCM-F. Customers must be provisioned either in Unified Communications Domain Manager or in Cisco HCM-F. The UC Applications report is generated with report format version 9.1(1) or later. Service Inventory 10.0.1 Report If Unified Communications Domain Manager 10.x is configured, the report format version will list 10.0.1. Reports will be generated in the 10.0.1 format. Co-existence and Service Inventory Reports In a co-existing deployment, Cisco Hosted Collaboration Mediation Fulfillment can be configured to have Unified Communications Domain Manager 8.x, 10.x and UC applications. In this scenario, based on the report format selected, multiple reports will be generated. For more information on generated reports, see the Report Combinations. | ||||
| Step 6 | Click Save. |
On-Demand Reports
On-Demand reports allows you to generate Inventory and Location reports immediately.
Note | You must generate an inventory report before you can generate a location report. If you try and generate a location report first, you will receive an error. |
Creating on-demand reports
| Step 1 | Select the type of report you want to generate. | ||||
| Step 2 | Select the
Report Source as
CUCDM,
UCAPP, or
CUCDM&UCAPP.
| ||||
| Step 3 | Select the
Report Format Version from the drop-down box.
| ||||
| Step 4 | Enter the GMT time the report must include information up to, using the format HH:MM:SS. | ||||
| Step 5 | Select
Each
reseller and customer or
Generate XLS Report .
| ||||
| Step 6 | Click Save. |
Transfer Report to Remote SFTP Server
You can transfer a report to the remote SFTP server that you configured on the Configuration page in the Service Inventory administrative interface. To transfer a report, perform the following procedure:
| Step 1 | In the Service Inventory administrative interface, click Backup. |
| Step 2 | The list of generated reports appear. Locate and select the files that you want to transfer to the remote SFTP server. |
| Step 3 | Click Transfer Selected Files. |
| Step 4 | To view the file backup job status in the Infrastructure Manager administrative interface, select . |
General Tasks for Infrastructure Manager
The following section contains the general procedures related to Infrastructure Manager.
- Edit Component
- Delete Component
- Perform Manual Sync
- Edit Service Provider Information
- Display Diagnostic Reports
- License Management Tasks
Edit Component
Follow this procedure to view and edit components in Infrastructure Manager.
Delete Component
Deleting components follows a hierarchical structure that correlates to the menu structure of Infrastructure Manager. For example, when you delete a vCenter the vCenter and associated VMware Data Centers, VMware clusters, Virtual Machines and ESXi hosts are deleted.
Follow this procedure to delete an element in Infrastructure Manager.
Note | You cannot delete a component added through a sync service unless you disable the sync service for that component. |
Perform Manual Sync
Follow this procedure to perform a manual sync.
Edit Service Provider Information
Follow this procedure to edit the service provider information.
| Step 1 | From the side menu, select . | ||||||
| Step 2 | Enter the following information:
| ||||||
| Step 3 | Click Address and Contact Information. | ||||||
| Step 4 | Enter the optional information for the Address 1, Address 2, City, State, Country, Zip Code, Contact Name, Contact Telephone Number, and Contact Email fields. | ||||||
| Step 5 | Click Save. |
Display Diagnostic Reports
utils diagnose hcs
This command enables you to diagnose problems for Cisco HCS services. The information is helpful for debugging purposes.
This command can be executed from any node in the cluster.
agp
chpa
cucdmsync
dmasa
fulfillment
hlm
nbi
si
sdrcnf
ucpa
ucsmsync
vcentersync
-
agp displays the diagnostics information for the API Gateway Proxy service.
-
chpa displays the diagnostics information for the Provisioning Adapter Service.
-
cucdmsync displays the diagnostics information for the CUCDMSync Service.
-
dmaim displays the diagnostics information for the DMA-IM.
-
fulfillment displays the diagnostics information for the fulfillment Service.
-
hlm displays the diagnostics information for the HCS License Manager Service.
-
nbi displays the diagnostics information for the North Bound Interface Service.
-
si displays the diagnostics information for the Service Inventory Service.
-
sdrcnf displays the diagnostics information for the SDR Change Notification Service.
-
ucpa displays the diagnostic information for the Unity Connection Provisioning Adapter. It used by Service Inventory.
-
ucsmsync displays the diagnostics information for the UCSMSync Service.
-
vcentersync displays the diagnostics information for the VCenterSync Service.
Using Infrastructure Manager Administration GUI
License Management Tasks
Edit a License Manager
Follow this procedure to edit a License Manager.
Note | You can only sync the License Manager version by retrieving the version of the installed License Manager. |
Prime License Manager Customers Summary Page
Unassign License Manager Clusters
Follow this procedure to unassign clusters from License Manager using License Management.
| Step 1 | From the side menu, select . |
| Step 2 | Click the customer name. |
| Step 3 | Click the Clusters Managed by dropdown. |
| Step 4 | Expand Unassign Clusters. |
| Step 5 | Select the cluster name and click Unassign. |
| Step 6 | From the side menu, select . |
| Step 7 | Click the customer name. |
| Step 8 | Expand Assign Customer. |
| Step 9 | Select None from the drop down menu and click Save to unassign the customer from the License Manager. |
Request/Download a HCS License Report
Note |
Follow this procedure to generate and download license reports using License Management.
Cisco HCM-F Real-Time Monitoring Tool
Launch RTMT
The RTMT application launches when you double click on the application icon or open the application, but does not work properly unless you log in on the proper type of server. In this case, a Cisco Hosted Collaboration Mediation Fulfillment (Cisco HCM-F) server.
You can connect to either the HCM-F application server or the HCM-F Web Services server. The RTMT session does not provide monitoring support for all the servers in HCM-F cluster.
Note | You can launch more than one RTMT session, with each session connecting to a different server (for example, one session connection to the HCM-F application server and another session connection to an HCM-F Web Services server). However, multiple RTMT sessions are not recommended by Cisco. |
Ensure that a Cisco CDM Database service is running on the Cisco HCM-F server to which you want to establish the RTMT connection.
| Step 1 | To launch
RTMT, perform one of the following tasks:
The Real-Time Monitoring Tool Login dialog appears. | ||
| Step 2 | In the Host IP Address field, enter either the IP address or the hostname of the Cisco HCM-F server. | ||
| Step 3 | Enter the port
that the application will use to listen to the server.
The default port is 8443. | ||
| Step 4 | Check the Secure Connection check box. | ||
| Step 5 | Click
OK.
If the Add Certificate to Store dialog appears, click Accept to continue. The Authentication Required dialog appears. | ||
| Step 6 | In the User Name field, enter the Administrator username for the application. | ||
| Step 7 | In the
Password field, enter the password for the Administrator username.
If the authentication fails or if the server is unreachable, RTMT prompts you to reenter the server and authentication details, or you can click Cancel to exit the application. If authentication succeeds, RTMT launches the monitoring module from local cache or from a remote server, if the local cache does not contain a monitoring module that matches the back-end version. The Cisco HCM-F Real-Time Monitoring Tool window and the Select Configuration dialog box appear. | ||
| Step 8 | Select a profile, and then click OK. |
Profiles
Add Configuration Profile
With RTMT, you can customize your monitoring window by monitoring different performance counters and then create your own configuration profiles. You can restore these monitoring windows in a single step rather than opening each window again.
You can switch between different profiles during the same RTMT session or use the configuration profile in subsequent RTMT sessions.
| Step 1 | Choose
.
The Preferences dialog box appears. | ||
| Step 2 | Click
Save.
The Save Current Configuration dialog box appears. | ||
| Step 3 | In the Configuration name field, enter a name for this particular configuration profile. | ||
| Step 4 | In the
Configuration description field, enter a description of this particular
configuration profile.
The system creates the new configuration profile. |
Restore Configuration Profile
Perform the following procedure to restore a profile that you configured:
Delete Configuration Profile
Perform the following procedure to delete a profile that you configured:
Categories
Categories allow you to organize objects in RTMT, such as performance monitor counters and devices. For example, the default category, Perfmon Counters, allows you to monitor up to six performance monitor counters in graph format. If you want to monitor more than six counters, you must create a new category and display the data in table format.
Create Category
To create a category, perform the following procedure.
| Step 1 | Perform one of the following tasks: | ||
| Step 2 | On the menu
bar, choose
| ||
| Step 3 | Enter the name of the category. | ||
| Step 4 | If you want to display counters on this tab in table view (instead of in chart view), check the Present Data in Table View check box. | ||
| Step 5 | Click
OK.
The category tab appears at the bottom of the Performance pane. | ||
| Step 6 | To save the
category tab for use in a future RTMT session, on the menu bar, choose
.
The Profile dialog box appears. | ||
| Step 7 | Click
Save.
The Save Current Configuration dialog box appears. | ||
| Step 8 | Enter a name
and description for this configuration and then click
OK to close the Save Current Configuration dialog
box.
| ||
| Step 9 | Click
Close to close the Profile dialog box.
The new categories are saved in the RTMT profile. To view them in each future RTMT session, on the menu bar, choose , choose the configuration and then click Restore. |
Rename Category
Delete Category
Using the HCM-F RTMT Performance Counter Monitoring
Add Counter Using Performance Queries
You can use queries to select and display perfmon counters. You can organize the perfmon counters to display a set of feature-based counters and save it in a category. After you save your Unified RTMT profile, you can quickly access the counters in which you are interested.
Unified RTMT displays perfmon counters in chart or table format. The chart format displays the perfmon counter information by using line charts. For each category tab that you create, you can display up to six charts in the Perfmon Monitoring pane with up to three counters in one chart. After you create a category, you cannot change the display from a chart format to a table format, or vice versa.
Tip | You can display up to three counters in one chart in the Perfmon Monitoring pane. To add another counter in a chart, click the counter and drag it to the Perfmon Monitoring pane. Repeat again to add up to three counters. |
By default, Unified RTMT displays perfmon counters in a chart format. You can also choose to display the perfmon counters in a table format. To display the perfmon counters in table format, you need to check the Present Data in Table View check box when you create a new category.
| Step 1 | Choose . | ||
| Step 2 | Click the name
of the server where you want to add a counter to monitor.
The tree hierarchy expands and displays all the perfmon objects. | ||
| Step 3 | To monitor a counter in table format, continue to step 4. To monitor a counter in chart format, skip to step 9. | ||
| Step 4 | Choose . | ||
| Step 5 | In the Enter Name field, enter a name for the tab. | ||
| Step 6 | To display the perfmon counters in table format, check the Present Data in Table View check box. | ||
| Step 7 | Click
OK.
A new tab with the name that you entered appears at the bottom of the pane. | ||
| Step 8 | Perform one of
the following actions to select one or more counters with one or more instances
for monitoring in table format (skip the remaining step in this procedure):
| ||
| Step 9 | To monitor a
counter in chart format, perform the following tasks:
|
Remove Counter From Performance Monitoring Pane
You can remove a counter chart (table entry) with the Remove Chart/Table Entry menu item in the Perfmon menu in the menu bar.
You can remove counters from the RTMT Perfmon Monitoring pane when you no longer need them. Follow this procedure to remove a counter from the pane.
Add Counter Instance
Set Up Counter Alert Notification
Follow this procedure to configure alert notification for a counter.
Tip | To remove the alert for the counter, right-click the counter and choose Remove Alert. The option appears gray after you remove the alert. |
| Step 1 | Find and display the performance counter. | ||
| Step 2 | From the counter chart or table, right-click the counter for which you want to configure the alert notification, and choose Set Alert/Properties. | ||
| Step 3 | Check the Enable Alert check box. | ||
| Step 4 | In the Severity drop-down list box, choose the severity level at which you want to be notified. | ||
| Step 5 | In the Description pane, enter a description of the alert and click Next. | ||
| Step 6 | Configure the settings in the Threshold, Value Calculated As, Duration, Frequency, and Schedule panes. After you enter the settings in the window, click Next to proceed to the next panes. | ||
| Step 7 | To configure the system to send an e-mail message for the alert, check the Enable Email check box. | ||
| Step 8 | To trigger an alert action that is already configured, choose the alert action that you want from the Trigger Alert Action drop-down list box. | ||
| Step 9 | To configure a
new alert action for the alert, click
Configure.
The Alert Action dialog box appears. | ||
| Step 10 | To add a new
alert action, click
Add.
The Action Configuration dialog box appears. | ||
| Step 11 | In the Name field, enter a name for the alert action. | ||
| Step 12 | In the Description field, enter a description for the alert action. | ||
| Step 13 | Click
Add to add a new e-mail recipient for the alert
action.
The Input dialog box appears. | ||
| Step 14 | Enter either the e-mail or e-page address of the recipient that you want to receive the alert action notification and click OK | ||
| Step 15 | In the User-defined email text box, enter the text that you want to display in the e-mail message and click Activate. |
Counter Alert Configuration Parameters
Display Counter Description
The following shows how to obtain a description of the counter:
Start Perfmon Counter Logging
To start logging perfmon counter data into a CSV log file, perform the following procedure:
| Step 1 | Find and display the performance monitoring counters. |
| Step 2 | If you are
displaying perfmon counters in the chart format, right-click the graph for
which you want data sample information and choose
Start
Counter(s) Logging.
The Counter Logging Configuration dialog box appears. |
| Step 3 | If you want to
log all counters in a screen (both chart and table view format), you can
right-click the category name tab at the bottom of the window and choose
Start
Counter(s) Logging.
The Counter Logging Configuration dialog box appears. |
| Step 4 | In the Logger
File Name field, enter a filename and click
OK.
RTMT saves the CSV log files in the log folder in the .jrtmt directory under the user home directory. For example, in Windows, the path specifies D:\Documents and Settings\userA\.jrtmt\log, or in Linux, the path specifies /users/home/.jrtmt/log. To limit the number and size of the files, configure the maximum file size and maximum number of files parameter in the trace output setting for the specific service in the Trace Configuration window of Cisco Unified Serviceability. See Cisco Unified Serviceability Administration Guide. |
Stop Perfmon Counter Logging
To stop logging perfmon counter data, perform the following procedure:
| Step 1 | Find and display the performance monitoring counters. |
| Step 2 | If you are displaying perfmon counters in the chart format, right-click the graph for which counter logging is started and choose Stop Counter(s) Logging. If you want to stop logging of all counters in a screen (both chart and table view format), you can right-click the category name tab at the bottom of the window and choose Stop Counter(s) Logging. |
Configure Data Sample
The Counter Property window contains the option to configure data samples for a counter. The perfmon counters that display in the RTMT Perfmon Monitoring pane contain green dots that represent samples of data over time. You can configure the number of data samples to collect and the number of data points to show in the chart. After the data sample is configured, view the information by using the View All Data/View Current Data menu option.
Follow this procedure to configure the number of data samples to collect for a counter.
| Step 1 | Find and display the counter. |
| Step 2 | Click the
counter for which you want data sample information and choose
.
The Counter Property window displays the description of the counter, as well as the tab for configuring data samples. The description includes the host address, the object to which the counter belongs, the counter name, and a brief overview of what the counter does. |
| Step 3 | To configure the number of data samples for the counter, click the Data Sample tab. |
| Step 4 | From the
No. of
data samples drop-down list box, choose the number of samples
(between 100 and 1000).
The default specifies 100. |
| Step 5 | From the
No. of
data points shown on chart drop-down list box, choose the number of
data points to display on the chart (between 10 and 50).
The default specifies 20. |
| Step 6 | Click one of the
following parameters:
|
| Step 7 | To close the Counter Property window and return to the RTMT Perfmon Monitoring pane, click OK. |
View Counter Data
Follow this procedure to view the data that is collected for a performance counter.
| Step 1 | In the RTMT Perfmon Monitoring pane, right-click the counter chart for the counter for which you want to view data samples. |
| Step 2 | Choose
View All
Data.
The counter chart displays all data that has been sampled. The green dots display close together. |
| Step 3 | Right-click the counter that currently appears. |
| Step 4 | Choose
View
Current.
The counter chart displays the last configured data samples that were collected. |
View Performance Monitor Log Files
You can view data in the performance monitor CSV log file by using Performance Log Viewer in RTMT or by using Performance Monitor in Windows.
You can only view log files on the server to which RTMT is connected. To view the log files on a different server, you must log out and establish a new RTMT connection to that server.
View Log Files on Perfmon Log Viewer
The Performance Log Viewer displays data for counters from perfmon CSV log files in a graphical format. You can use the performance log viewer to display data from the local perfmon logs that you collected, or you can display the data from the Real-time Information Server Data Collection (RISDC) perfmon logs.
The local perfmon logs consist of data from counters that you select and store locally on your computer.
| Step 1 | Select . |
| Step 2 | Select the type of perfmon logs that you want to view: |
| Step 3 | Select the counters that you want to display. |
| Step 4 | Select
OK.
|
View Perfmon Log Files with Microsoft Performance Tool
Note | The method for accessing Performance may vary depending on the version of windows you install on your computer. |
| Step 1 | Select . |
| Step 2 | Perform the following actions in the application window: |
| Step 3 | Select the Source tab in the System Monitor Properties dialog box. |
| Step 4 | Browse to the directory where you downloaded the perfmon log file and select the perfmon csv file. The log file includes the following naming convention: PerfMon_<node>_<month>_<day>_<year>_<hour>_<minute>.csv; for example, PerfMon_172.19.240.80_06_15_2005_11_25.csv. |
| Step 5 | Select Apply. |
| Step 6 | Select Time Range. To specify the time range in the perfmon log file that you want to view, drag the bar to the appropriate starting and ending times. |
| Step 7 | To open the Add Counters dialog box, select the Data tab and select Add. |
| Step 8 | Select the perfmon object from the Performance Object drop-down list box. If an object has multiple instances, you may select All instances or select only the instances that you are interested in viewing. |
| Step 9 | You can select All Counters or select only the counters that you are interested in viewing. |
| Step 10 | Select Add to add the selected counters. |
| Step 11 | Select Close when you finish selecting counters. |
Setting up Alerts
Access Alert Central and Setup Alerts
| Step 1 | Perform one of
the following tasks:
The Alert Central pane displays the alert status and history of the alerts that are generated by the system. | ||
| Step 2 | Perform one
of the following tasks:
| ||
| Step 3 | To sort the
alert and alert history information, click a column heading.
An up or down arrow appears in the column heading to indicate that sorting is based on that column, and that sorting is ascending (up arrow) or descending (down arrow). To see alert history that is out of view in the pane, use the scroll bar on the right side of the Alert History pane. | ||
| Step 4 | To enable,
disable, or remove an alert, perform one of the following tasks:
| ||
| Step 5 | To clear
either individual or collective alerts after they are resolved, perform one of
the following tasks:
After you clear an alert, the color changes from red to black. | ||
| Step 6 | To reset alerts to default configuration, perform one of the following tasks: | ||
| Step 7 | To view alert
details, perform one of the following tasks:
After you have finished viewing the alert details, click OK. |
Setup Alert Properties
| Step 1 | Perform one of the following tasks: | ||
| Step 2 | Select the alert you want to configure. | ||
| Step 3 | Perform one
of the following tasks:
The Alert Properties: General dialog box appears. | ||
| Step 4 | To enable the alert, check the Enable Alert check box. | ||
| Step 5 | In the Severity list box, choose the severity for the alert. | ||
| Step 6 | In the
Enable/Disable this alert on following server(s) section (if it appears), check
the
Enable check box for the servers on which you want
this alert to be enabled.
For preconfigured alerts, the Description field contains a description of the alert. The Recommended Action field describes what should be done after the alert is received. You cannot change these fields. | ||
| Step 7 | Click
Next.
| ||
| Step 8 | In the
Threshold section, enter the conditions that trigger the alert.
| ||
| Step 9 | In the
Duration section (if it is shown), click one of the following radio buttons:
| ||
| Step 10 | Click
Next.
The Alert Properties: Frequency & Schedule dialog box appears. | ||
| Step 11 | In the Frequency section, click one of the following radio buttons (if they appear): | ||
| Step 12 | In the Schedule section, click one of the following radio buttons: | ||
| Step 13 | Click Next. | ||
| Step 14 | For alerts
such as CriticalServiceDown and CodeYellow that allow trace download, perform
the following tasks in the Alert Properties: Trace Download dialog box (if it
appears); otherwise, go to
Step 15.
| ||
| Step 15 | In the Alert Properties: Email Notification dialog box: If you want to enable email notification for this alert, check the Enable Email check box. | ||
| Step 16 | To trigger
an alert action with this alert, in the Trigger Alert Action list, choose the
action that you want to send.
For information about configuring alert actions, see Setup Alert Actions. | ||
| Step 17 | Enter descriptive information about the alert in the User-defined email text box. | ||
| Step 18 | Click Save to save the alert configuration and close the Alert Properties dialog box. |
Suspend Alerts
You may want to temporarily suspend some or all alerts on a particular server. For example, if you are upgrading Cisco HCM-F to a newer release, you may want to suspend all alerts until the upgrade completes, so you do not receive emails or e-pages during the upgrade. The following procedure describes how to suspend alerts in Alert Central.
| Step 1 | Perform one of the following tasks: | ||
| Step 2 | Choose . | ||
| Step 3 | Perform one of
the following tasks:
| ||
| Step 4 | Click
OK.
|
Configure Mail Server for Alert Notification
Perform the following procedure to configure email information for alert notification.
Note | To configure RTMT to send alerts using email, you must configure DNS. For information on configuring the primary and secondary DNS IP addresses and the domain name in Cisco HCM-F, see Administration Guide for Cisco Hosted Collaboration Mediation Fulfillment. |
| Step 1 | Perform one of the following tasks: |
| Step 2 | Choose
.
The Mail Server Configuration window appears. |
| Step 3 | In the Mail Server field, enter the address of the mail server. |
| Step 4 | In the Port field, enter the port number on the mail server. |
| Step 5 | In the Sender
User Id field, enter the email address for the intended recipient.
By default, RTMT_Admin@domain is used, where domain is the domain of the host server. |
| Step 6 | Click OK. |
Setup Alert Actions
The following procedure describes how to create, modify, or delete alert actions.
| Step 1 | If you came to
this procedure while configuring the Alert Properties: Email Configuration
dialog box, click
Configure.
The Alert Action dialog box appears. Go to Step 4. Otherwise, go to Step 2. | ||
| Step 2 | Perform one of the following tasks: | ||
| Step 3 | Choose
.
The Alert Action dialog box appears. | ||
| Step 4 | Perform one of
the following steps:
| ||
| Step 5 | If you are
adding a new alert action: In the Name field, enter a name for the alert
action.
| ||
| Step 6 | In the Description field, enter (or modify) the description of the alert action. | ||
| Step 7 | To add an
email recipient, click
Add.
The Info dialog box appears. | ||
| Step 8 | In the Enter
email/epage address field, enter an email or e-page address of the recipient
that you want to receive the alert action and click
OK.
The Action Configuration dialog box shows the recipient that you added, and the Enable check box is automatically checked.
| ||
| Step 9 | When you finish adding recipients, click OK to close the Action Configuration dialog box. | ||
| Step 10 | Click Close to save and close the Alert Action dialog box. |
Setup the Global Email List for Alert Notifications
The following procedure describes how to configure all predefined alerts to send email to one or more email destinations. This procedure uses "Default," the action that is assigned to all alerts during installation.
Follow this procedure to configure a recipient list for all predefined alerts without needing to set an action for each alert. When you add email destinations to the "Default" alert action recipient list, all predefined alerts are sent to those recipients, as long as all alerts continue to use the "Default" alert action.
To configure a new action for a specific alert, to reconfigure existing alert actions, or to disable emails for an alert, use the Set Alerts/Properties option, which appears when you right-click an alert. For more information, see Setup Alert Properties.
Each time you update an alert action, the changes apply to all alerts that are configured with that alert action. For example, if all alerts use the "Default" alert action, updating the "Default" alert action automatically updates all alerts.
You cannot delete the "Default" alert action. For other alert actions, you can delete them only if they are not associated with other alerts. If an action is associated with multiple alerts, you must reassign a new action to those alerts before you can delete the alert action.
| Step 1 | Perform one of
the following tasks:
The Alert Central monitor pane appears. | ||
| Step 2 | Click
.
The Alert Action dialog box appears. | ||
| Step 3 | In the Alert
Action list, select
Default and click
Edit.
The Action Configuration dialog box appears. | ||
| Step 4 | If required, enter or modify the description for the "Default" action. | ||
| Step 5 | Click
Add to add a recipient.
The Input dialog box appears. | ||
| Step 6 | Enter the
email address that is to receive all alerts and click
OK.
The email address appears in the Recipients list in the Action Configuration dialog box; the Enable check box for the recipient is checked by default.
| ||
| Step 7 | Return to Step 5 to add additional email recipients, if required. | ||
| Step 8 | Click OK to close the Action Configuration dialog box. | ||
| Step 9 | Click Close to close the Alert Action dialog box. |
Settings up Traces and Logs
Collect Trace Files
Use the Collect Files object in Trace & Log Central to collect traces for services, applications, and system logs on the server. You specify the date and time range for which you want to collect traces, the directory in which to download the trace files, whether to delete the collected files from the server, and so on. The following procedure describes how to use Trace & Log Central to collect traces.
Note | The services that you have not activated are also shown, so you can collect traces for those services. |
Use Query Wizard if you want to collect trace files that contain search criteria that you specify or you want to use trace collection criteria that you saved for later use.
Perform one or more of the following tasks:
- Configure the throttling of critical Trace & Log Central operations and jobs by setting the values of the TLC Throttling CPU Goal and TLC Throttling IOWait Goal service parameters (Cisco RIS Data Collector service).
- Enable trace compression by setting the value of the Trace Compression enterprise parameter to Enabled.
| Step 1 | Perform one of the following actions: | ||
| Step 2 | In the Trace
& Log Central list, double-click
Collect Files.
The Collect Files window appears. The services that you have not activated are also shown, so you can collect traces for those services. | ||
| Step 3 | On the
Select HCS Services/Application tab, perform one of the following tasks:
| ||
| Step 4 | On the
Select System Services/Application tab, perform one of the following tasks:
| ||
| Step 5 | In the
Collection Time section, specify the time range for which you want to collect
traces. Choose one of the following options:
| ||
| Step 6 | In the
Download File Options section, in the Select Partition list box, select the
partition that contains the logs for which you want to collect traces.
For example, if you upgrade from a version of Cisco HCM-F that is running on an application server to another version, and you restart the server with the new version, Cisco Unified Serviceability moves the logs of the previous version to the inactive partition and stores logs for the newer version in the active partition. If you log back in to the older version, Cisco Unified Serviceability moves the logs for the newer version to the inactive partition and stores the logs for the older version in the active directory. | ||
| Step 7 | To specify
the directory in which to download the trace files, click
Browse, navigate to the directory, and click
Open.
The default path is <rtmt_install_directory>\<server name or server IP address>\<download time> where <rtmt_install_directory> is the directory in which RTMT is installed. | ||
| Step 8 | Perform one of the following steps: | ||
| Step 9 | To delete collected log files from the server, check the Delete Collected Log Files from Server check box. | ||
| Step 10 | Click
Finish, or to cancel the settings, click
Cancel.
If you click Finish, RTMT displays the status of the trace file downloads in the Trace & Log Central pane as well as in the status bar at the bottom. When the collection process is complete, the message "Completed downloading for node <Server name or IP address>" appears in the status bar at the bottom of the window. | ||
| Step 11 | To view the
trace files that you collected, use Local Browse.
For more information, see Display Downloaded Trace Files using Local Browse.
|
Collect Installation Logs
The following procedure describes how to collect installation and upgrade logs in Trace & Log Central.
| Step 1 | Perform one of
the following tasks:
The Trace & Log Central pane appears. |
| Step 2 | In the Trace
& Log Central list, double-click
Collect Install Logs.
The Collect Install Logs dialog box appears. |
| Step 3 | In the Select
Servers Options section, specify from which server you want to collect the
install logs.
To collect the install logs for a particular server, check the check box beside the server name. To collect the install logs for all servers, check the Select All Servers check box. |
| Step 4 | In the
Download File Options section, specify the directory where you want to download
the log file.
To specify the directory in which you want to download the log files, click Browse, navigate to the directory, and click Open. The default path is <rtmt_install_directory> where <rtmt_install_directory> is the directory where RTMT is installed. |
| Step 5 | Click Finish. |
Collect and Download Trace Files Using Query Wizard
The Query Wizard in Trace & Log Central allows you to collect and download trace files that contain search criteria that you specify. You can save the trace collection criteria for later use. To use the trace collection Query Wizard, perform the following procedure.
Note | You can open a maximum of five concurrent files for viewing within Trace & Log Central. This includes using the Query Wizard, Local Browse, and Remote Browse features. |
If you want alarms to be sent to a trace file, choose an SDI or SDL trace file as the alarm destination in the Alarm Configuration window.
| Step 1 | Perform one of the following tasks: | ||
| Step 2 | In the Trace
& Log Central list, double-click
Query Wizard.
The Query Wizard dialog box appears. | ||
| Step 3 | On the Query
Wizard Options page, perform one of the following actions:
| ||
| Step 4 | Perform one
of the following tasks:
| ||
| Step 5 | Perform one
of the following tasks:
| ||
| Step 6 | Click
Next.
The Select System Services/Applications tab appears. | ||
| Step 7 | Perform one
of the following tasks:
| ||
| Step 8 | Click
Next.
The Query File Options page appears. | ||
| Step 9 | In the Query
Time Options section, specify the time range for which you want to collect
traces. Choose one of the following options:
| ||
| Step 10 | To search by phrases or words that exist in the trace file, enter the word or phrase in the Search String field. | ||
| Step 11 | If you want to search for an exact match to the word or phrase that you entered, check the Case Sensitive check box. | ||
| Step 12 | In the Call
Processing Impact Options section, in the Select Impact Level list box, select
the maximum level of impact the string search activity should have on call
processing.
Your choices are Low, Medium, or High. Low causes the least impact on call processing but yields slower results. High causes the most impact on call processing but yields faster results. | ||
| Step 13 | Click
Next.
The Action Options dialog box appears. | ||
| Step 14 | Click one of
the following radio buttons:
When you are finished, click OK to close the Trace Download Configuration dialog box. | ||
| Step 15 | Perform one
of the following tasks:
| ||
| Step 16 | In the Save
options dialog box, perform one of the following tasks:
| ||
| Step 17 | Click Finish to save the trace collection query. | ||
| Step 18 | Browse to the folder where you want to store the query, enter a name for the query in the File Name field, and then click Save. | ||
| Step 19 | After the Run Query execution completes, in the Query Result tree list, navigate to the collected trace file: | ||
| Step 20 | Perform one of the following tasks: | ||
| Step 21 | To open the
file in a viewer, perform the following tasks:
| ||
| Step 22 | To download
the trace files, perform the following tasks:
After you download the trace files, you can view them by using Local Browse in Trace & Log Central. For more information, see Display Downloaded Trace Files using Local Browse. |
Schedule Trace Collection
You can use the Schedule Collection option in Trace & Log Central to schedule up to six concurrent trace collections and to download the trace files to an SFTP or FTP server on your network, run another saved query, or generate a syslog file. To change a scheduled collection after you have entered it in the system, you must delete the scheduled collection and add a new collection event. To schedule trace collection, perform the following procedure.
Note | You can schedule up to ten trace collection jobs, but only six trace collection jobs can be concurrent. That is, only six jobs can be in a running state at the same time. |
If you want alarms to be sent to a trace file, choose an SDI or SDL trace file as the alarm destination in the Alarm Configuration window.
| Step 1 | Perform one of the following tasks: | ||
| Step 2 | In the Trace
& Log Central list, double-click
Schedule Collection.
The Select HCS Services/Applications tab appears.
| ||
| Step 3 | Perform one
of the following tasks:
| ||
| Step 4 | Click
Next.
The Select System Services/Applications tab appears. | ||
| Step 5 | Perform one
of the following tasks:
| ||
| Step 6 | Click
Next.
The Schedule Options page appears. | ||
| Step 7 | Select the
time zone and the start and end dates and time for which you want to collect
traces.
By default, the default selection in the Select Reference Server Time Zone list box is the time zone on the RTMT client computer. Your alternate choice is the server time zone.
| ||
| Step 8 | In the Scheduler Frequency list box, choose how often you want to run the configured trace collection. | ||
| Step 9 | In the Collect Files generated in the last list boxes, specify the time before the current time (in minutes, hours, days, weeks, or months) for which you want to collect traces. | ||
| Step 10 | To search by phrases or words that exist in the trace file, enter the word or phrase in the Search String field. | ||
| Step 11 | If you want to search for an exact match to the word or phrase that you entered, check the Case Sensitive check box. | ||
| Step 12 | To create a zip file of the trace files that are collected, check the Zip File check box. | ||
| Step 13 | To delete collected log files from the server, check the Delete Collected Log Files from Server check box. | ||
| Step 14 | Check the
following check boxes, as required:
| ||
| Step 15 | In the Trace
Download Configuration dialog box, perform the following tasks:
| ||
| Step 16 | Click
Finish.
A message indicates that the system added the scheduled trace successfully.
| ||
| Step 17 | Click OK. | ||
| Step 18 | To view a list of scheduled collections, choose in the QuickLaunch Channel pane. |
View Trace Collection Status
To view trace collection event status and to delete scheduled trace collections, use the following procedure.
| Step 1 | Perform one of the following tasks: | ||
| Step 2 | Double-click
the
Job
Status icon.
The Job Status pane appears. | ||
| Step 3 | In the
Select
a Node list box, choose the server for which you want to view or
delete trace collection events.
The list of scheduled trace collections appears. Possible job types include Scheduled Job, OnDemand, RealTimeFileMon, and RealTimeFileSearch. Possible statuses include Pending, Running, Cancel, and Terminated. | ||
| Step 4 | To delete a
scheduled collection, choose the event that you want to delete and click
Delete.
|
Collect a Crash Dump File
Perform the following procedure to collect a crash dump file:
| Step 1 | Perform one of the following tasks: | ||
| Step 2 | In the Trace
& Log Central list, double-click
Collect Crash Dump.
The Select HCS Services/Applications tab appears.
| ||
| Step 3 | Perform one
of the following tasks:
| ||
| Step 4 | Click
Next.
The Select System Services/Applications tab appears. | ||
| Step 5 | Perform one
of the following tasks:
| ||
| Step 6 | Click
Next.
The Collect File Options page appears. | ||
| Step 7 | In the
Collection Time group box, specify the time range. Choose one of the following
options:
| ||
| Step 8 | In the
Select Partition list box, choose the partition that
contains the system logs.
Cisco Unified Serviceability stores the logs for the version of application that you are logged in to in the active partition and stores the logs for the other version (if installed) in the inactive directory. This means that when you upgrade from one version of Cisco HCM-F that is running on the Linux platform to another version, and you restart the server with the new version, Cisco Unified Serviceability moves the logs of the previous version to the inactive partition and stores logs for the newer version in the active partition. If you log in to the older version, Cisco Unified Serviceability moves the logs for the newer version to the inactive partition and stores the logs for the older version in the active directory. | ||
| Step 9 | To specify
the directory in which you want to download the trace files, click
Browse, navigate to the directory, and click
Open.
The default path is <rtmt_install_directory>\<server name or server IP address>\<download time> where <rtmt_install_directory> is the directory where RTMT is installed. | ||
| Step 10 | To create a
zip file of the crash dump files that you collect, click the
Zip
Files radio button.
To download the crash dump files without zipping the files, click the Do Not Zip Files radio button.
| ||
| Step 11 | To delete collected crash dump files from the server, check the Delete Collected Log Files from Server check box. | ||
| Step 12 | Click
Finish.
A message displays that requests confirmation that you want to collect crash dump files (because doing so may affect server performance). To continue, click OK.
|
Collect Audit Logs
The audit user can collect, view, and delete the audit logs. The end user can view the audit logs.
Note | Only a user with an audit role can delete the audit logs. |
| Step 1 | Perform one of the following tasks: | ||||||||||||
| Step 2 | In the Trace
& Log Central list, double-click
Audit Logs.
The Audit Logs dialog box appears. | ||||||||||||
| Step 3 | Choose one of the following actions on the Action Options page: | ||||||||||||
| Step 4 | To browse audit logs:
In the Audit Logs dialog box, check the
Browse Audit Logs check box and click
Next.
The Nodes Selection Options page appears. | ||||||||||||
| Step 5 | Perform one
of the following tasks:
| ||||||||||||
| Step 6 | Click
Finish.
A new tab appears in the Trace & Log Central pane, and the Result dialog box appears to indicate that the data is ready for browsing. The tab contains the Nodes folder list in the left pane, and a list of the audit log files in the right pane. | ||||||||||||
| Step 7 | Click Close to close the Result dialog box. | ||||||||||||
| Step 8 | In the Nodes list, perform the following actions: | ||||||||||||
| Step 9 | Perform one of the following actions: | ||||||||||||
| Step 10 | To open the
file in a viewer, perform the following tasks:
| ||||||||||||
| Step 11 | To download
the selected audit log file, perform the following tasks:
| ||||||||||||
| Step 12 | To download audit logs: In the Audit Logs dialog box, check the Download Audit Logs check box, and click Next. | ||||||||||||
| Step 13 | In the Nodes
Selection Options section of the Audit Logs dialog box, perform one of the
following actions:
| ||||||||||||
| Step 14 | In the
Collection Time section of the Audit Logs dialog box, perform one of the
following tasks:
| ||||||||||||
| Step 15 | In the
Download File Options section, perform the following tasks:
| ||||||||||||
| Step 16 | Click
Finish.
The collection status is reported in the Trace & Log Central pane. | ||||||||||||
| Step 17 | To schedule a download of audit logs: In the Audit Logs dialog box, check the Schedule Download of Audit Logs check box and click Next. | ||||||||||||
| Step 18 | In the
Nodes Selection Options section of the Audit Logs dialog box, perform one of
the following actions:
| ||||||||||||
| Step 19 | In the
Schedule Time section of the Audit Logs dialog box, perform one of the
following tasks:
| ||||||||||||
| Step 20 | Check the following check boxes, as required: | ||||||||||||
| Step 21 | In the
Action Options section, check the
Download Files check box.
The Trace Download Configuration dialog box appears. | ||||||||||||
| Step 22 | In the Trace
Download Configuration dialog box, perform the following tasks:
| ||||||||||||
| Step 23 | Click
Finish.
A confirmation dialog box appears to indicate successful configuration for schedule audit log collection. |
Display Downloaded Trace Files using Local Browse
After you collect trace files and download them to your PC, you can view them with a text editor that can handle UNIX variant line terminators such as WordPad on your PC, or you can view them by using the viewers within RTMT.
Note | Do not use Notepad to view collected trace files. |
Perform the following procedure to display the log files that you collect with Trace & Log Central. If you zip the trace files for the download, you must unzip them to view them using the viewers within RTMT.
Note | You can open a maximum of five concurrent files for viewing within Trace & Log Central. This includes using the Query Wizard, Local Browse, and Remote Browse features. |
| Step 1 | Perform one of the following tasks: |
| Step 2 | Double-click Local Browse. |
| Step 3 | Navigate to the directory where you stored the log file and choose the file that you want to view. |
| Step 4 | Double-click
the file (or click
Finish).
If the file type has a viewer that is already associated with it, the file opens in that viewer. Otherwise, the Open With dialog box appears. |
| Step 5 | Click the
program (viewer) that you want to use to view the file.
If your preferred program is not on the list, choose another program by clicking Other. If you want to use the selected program as your default viewer, check the Always use this program to open these files check box. RTMT displays the file in the chosen viewer. If no other appropriate viewer applies, RTMT opens files in the Generic Log Viewer. |
Display and Download Trace Files using Remote Browse
After the system has generated trace files, you can view them on the server by using the viewers within the Real-Time Monitoring Tool. You can also use the Remote Browse feature to download the traces to your PC.
Perform the following procedure to display and/or download the log files on the server with Trace & Log Central.
Note | You can open a maximum of five concurrent files for viewing within Trace & Log Central. This includes using the Query Wizard, Local Browse, and Remote Browse features. |
| Step 1 | Perform one of the following tasks: | ||||
| Step 2 | Double-click Remote Browse. | ||||
| Step 3 | Select one
of the following radio buttons, and then click
Next.
| ||||
| Step 4 | To display trace
files: Perform one of the following actions on the Select HCS
Services/Application tab.
| ||||
| Step 5 | On the
Select System Services/Application tab, perform one of the following tasks:
| ||||
| Step 6 | Click
Finish.
A new tab appears in the Trace & Log Central pane, and the Result dialog box appears to indicate that the data is ready for browsing. The tab contains the Nodes folder list in the left pane, and a list of the trace files in the right pane. To view the files, go to Step 10. | ||||
| Step 7 | To display crash dumps:
Perform one of the following actions on the Select HCS
Services/Application tab:
| ||||
| Step 8 | On the
Select System Services/Application tab, perform one of the following tasks:
| ||||
| Step 9 | Click
Finish.
A new tab appears in the Trace & Log Central pane, and the Result dialog box appears to indicate that the data is ready for browsing. The tab contains the Nodes folder list in the left pane, and a list of the crash dump files in the right pane. To view the files, go to Step 10. | ||||
| Step 10 | In the Result dialog box, click Close. | ||||
| Step 11 | In the Nodes list, perform the following actions: | ||||
| Step 12 | To open the
file in a viewer, perform the following tasks:
|
Real-time Trace
The Real Time Trace option in Trace & Log Central allows you to view the current trace file that is being written on the server for each application. If the system has begun writing a trace file, the real-time trace starts reading the file from the point where you began monitoring rather than at the beginning of the trace file. You cannot read the previous content.
The real-time trace provides the option to view real-time data and monitor user events.
Edit RTMT Trace Settings
To edit trace settings for RTMT, choose ; then, click the radio button that applies. The system stores the rtmt.log file in the Documents and Settings directory for the user; for example, on a Windows machine, the log is stored in C:\Documents and Settings\<userid>\.jrtmt\log.
Tip | The default Trace Setting is Error. |
Display Messages in SysLog Viewer
You can display messages in SysLog Viewer.
Note | CiscoSyslog messages (in the Application Logs folder) also display the syslog definition, which includes recommended actions, in an adjacent pane when you double-click the syslog message. You do not have to access the Alarm Definitions in Cisco Unified Serviceability for this information. |
The following table describes the SysLog Viewer buttons.
|
Button |
Function |
||
|
Refresh |
|
||
|
Clear |
Clears the display of the current log. |
||
|
Filter |
Limits the messages that displayed base on the set of options that you select. |
||
|
Clear Filter |
Removes the filter that limits the type of messages that display. |
||
|
Find |
Allows you to search for a particular string in the current log. |
||
|
Save |
Saves the currently selected log on your PC. |
When viewing the syslog message, drag the arrow that appears when your mouse hovers between two column headings to make the column wider or narrower.
You can sort the displayed syslog messages by clicking a column heading. The first time that you click a column heading, the records sort into ascending order. An up arrow indicates ascending order. If you click the column heading again, the records sort into descending order. A down arrow indicates descending order. If you click the column heading one more time, the records revert to unsorted state.
| Step 1 | Perform one of the following tasks: | ||
| Step 2 | In the Select a Node list box, choose the server where the logs that you want to view are stored. | ||
| Step 3 | Click the tab for the logs that you want to view. | ||
| Step 4 | Double-click
each item in the folder hierarchy until the logs appear in the bottom section
of SysLog Viewer.
| ||
| Step 5 | To filter
the syslog message display results, select an option in the
Filter By list box.
To remove the filter, click Clear Filter. All logs reappear after you clear the filter. | ||
| Step 6 | To view more
information for a syslog message, double-click the syslog message.
The Show Detail dialog box appears for the selected syslog message. |
Feedback