Log Collection (LogCollection, DimeGetFile) Services Getting Started

The Log Collection and the File Retrieval (DimeGetFile) services are included in the installation of Cisco Unified Communications Manager (Cisco Unified CM) software. The minimum requirement for using and testing Log Collection and DIME service is a Cisco Unified CM infrastructure or the Dedicated Lab in the Cisco Sandbox

Service Activation

DIME does not need to have a specific service running to work.

Log Collection Service activation is handled via the Cisco Unified Serviceability Administration. Before making a Log Collection request, ensure the SOAP - Log Collection APIs service is running.

Follow these steps to verify the service is running:

  1. From the Cisco Unified CM Administration window, select Cisco Unified Serviceability. Then click Go.
  2. Select Tools > Control Center - Network Services
  3. Scroll down to the SOAP Services section to verify SOAP - Log Collection APIs is running.

If needed, other services can be activated or deactivated.

Application User Configuration

All Serviceability APIs use HTTP 1.0 Basic access authentication which requires username and password credentials. Create an Application User in Cisco Unified CM, then use those credentials to authenticate the Log Collection and DIME requests.

For configuring an application user, refer to Application User Setup.

Application users are assigned to Access Control Groups. An application user can be assigned to:

  • An existing group
  • A newly configured group
Assigning a User to an Existing Group

To assign an application user to an existing group, select the Standard CCM Server Monitoring group. This is the default group.

Roles are assigned to groups, and users in that group are assigned roles belonging to that group. For example, Standard CCM Server Monitoring group has the three roles assigned to it. This image shows the user being associated to the group which contains those roles.

Assigning a User to a New Group

To create a new group, refer to Access Control Group Setup. Then verify the roles for that new group include at least the Standard CCM Admin Users and Standard SERVICEABILITY roles.

Application Preparation

Your application can use the WSDL file to generate the proper SOAP requests. The WSDL files are located on every Cisco Unified CM Publisher and Subscriber node. Download the WSDL for LogCollectionService at the following URL:

https://<server>:8443/logcollectionservice2/services/LogCollectionPortTypeService?wsdl

Download the WSDL for DimeGetFile at the following URL:

https://<server>:8443/logcollectionservice/services/DimeGetFileService?wsdl

With the SOAP - Log Collection APIs service activated, a user created, and WSDL consumed, you are ready to make the first request. Use SoapUI to test, become familiar with, and gain a better understanding of the APIs.

When you are ready to build an application, refer to the sample applications.