 Feedback
|
Table Of Contents
Integrating Applications with CMIC
Integrating CMIC with CWHP and Device Center
System Flow for CWHP using CMIC
About the Management Service Template
About CMIC Registry Dependencies
Integrating Applications with CMIC
Cisco Management Integration Center (CMIC) is a registry or repository for management services, enabling Cisco Management Servers to integrate with outside-world applications. CMIC acts as a service lookup for any application trying to find a particular service or set of services provided by other applications on in a network, thereby facilitating interaction amongst these application. CMIC takes care of configuring the server to integrate with applications and services residing outside the box.
CMIC Registry replaces the CMF Desktop XML Registry. It allows you to:
•
Register services
•
•
The following topics describe how to use CMIC with your application:
For basic information on CMIC, see the "About the Cisco Management Integration Center (CMIC) Component" section on page 6-6.
For more information about CMIC, see:
•
•
•
•
Understanding CMIC
The CMIC registry provides a Java API for registration, unregistration, and lookup of management services. These APIs are exposed via the Common Services Transport Mechanism (for details, see Chapter 29, "Using the Common Services Transport Mechanism") so that they can be accessed over a network via North Bound (NB) APIs. All NBAPIs take the extra parameter UserCredentials, containing user information, so accesses can be authenticated.
CMIC makes use of an XML template, called the Management Service Template (MST), to define in a coherent, standardized way each management service supplied by an application or tool. Each MST defines the attributes of the service that are relevant to other applications and services, such as the service name, description, how to invoke the service, etc. The only difference between instances of the same service is the host, port, and protocol of the instance where the service resides.
The template collects all the common information, and the information that changes based on the instance is given during the CMIC service registration call. The MST file name serves as the service's Uniform Resource Name (URN); this URN is referred to in the API call for any subsequent registrations or unregistrations of the service.
The CMIC registry provides a user interface to register the following different kinds of application services:
•
•
•
•
Using CMIC Services
The following topics describe how to to use CMIC services with applications:
•
•
•
Registering Applications
Registering applications is the foremost pre-requisite to find any management service. All management services, which intend to be called by other services need to first register with CMIC.
All services willing to register need to define a Management Service Template. The template is XML based and has information about various parameters of a service like host, port, protocol, where the service resides, URL to invoke the service etc.
The users create an MST. Once the MST is created, the user is provided with a URN that identifies the MST. The name of the MST file is URN.xml
This URN is used by respective services in register API along with the host, port & protocol of the host on which the service resides. CMIC registry stores all such registered services in a repository.
Querying an Application
A query is made to CMIC to find a management service from the registered management services. This query is based on certain search parameters
To find a particular or set of services the "query" API is used. CMIC supports query on various parameters like Application Name, Vendor name, Application Category (Fault, Configuration, Accounting, Performance, Security), Task Name etc. A query is constructed by the service requester using one or more of the parameters and sent to CMIC registry. The query can be an "AND" or "OR" on the parameters chosen for query.
Calling an Application
The query returns matched services to service requestor, the query results are processed and call to respective services are made.
CMIC registry returns a list of services matching the query to the requester. The Service requestor can process the result and launch the returned services or provide links to these services for the user to take appropriate action.
Integrating CMIC with CWHP and Device Center
CMIC MST files contain all the information needed to manage and display the tasks in the Cisco Works Home Page Application Panel.
CWHP uses CMIC to register and query installed applications, Cisco Works Resources, Cisco.com resources, Cisco Works Applications installed on other servers, 3rd party applications, Custom Tools. CMIC registry has data about all registered applications in the users network, a snap shot of registry would give CWHP all the information it needs to provide launch points to various applications with the help of queries.
To integrate with CWHP and Device center you need to create a CMIC MST template and tag URLs appropriately (with integration tags) as defined by CWHP and DC, then register the template with CMIC.
You need not create different templates for CWHP and Device Center. All tasks can be a part of single template and be registered with CMIC.
Registration is a one-time process and you do not need to register an application again after installation. The registration code can be part of post-installation script when the application is installed.
All templates must be present under NMS-ROOT/object/data/cmf/cmic/mst-templates. Application teams can drop their template at this location and then mention the URN ( same as file name with out the .xml extension) during their registration with CMIC. You can have only one MST file for an application.
The following table describes the integration tags used by the CWHP:
Wrapper Java Code
During the application's post install, you need to call the CMIC register APIs to register the MST file with CMIC. This requires that you write a Java wrapper which will accept the MST file name. You can use the following Wrapper Java Code to register the MST file with CMIC:
$NMSROOT/lib/jre141/bin/java -classpath $NMSROOT/lib/classpath/cmic.jar:$NMSROOT/MDC/tomcat/lib/apps/MICE.jar:$NMSROOT/MDC/tomcat/ lib/apps/NATIVE.jar:$NMSROOT/objects/log4j/1.1.3/log4j.jar:$NMSROOT/MDC/tomcat/lib/apps/xe rces.jar com.cisco.nm.cmf.cmic.registry.CMICApplicationRegistry URN legacy action [disable-option].This code uses the arguments shown in Table 9-2.
To register RME4.0 using Tomcat with default display option, use the following code in post install:
$NMSROOT/lib/jre141/bin/java -classpath $NMSROOT/lib/classpath/cmic.jar:$NMSROOT/MDC/tomcat/lib/apps/MICE.jar:$NMSROOT/MDC/tomcat/ lib/apps/NATIVE.jar:$NMSROOT/objects/log4j/1.1.3/log4j.jar:$NMSROOT/MDC/tomcat/lib/apps/xe rces.jar com.cisco.nm.cmf.cmic.registry.CMICApplicationRegistry RME4.0 0 register.To register RME4.0 using Tomcat with an option to display an application link, use the following code in post install:
$NMSROOT/lib/jre141/bin/java -classpath $NMSROOT/lib/classpath/cmic.jar:$NMSROOT/MDC/tomcat/lib/apps/MICE.jar:$NMSROOT/MDC/tomcat/ lib/apps/NATIVE.jar:$NMSROOT/objects/log4j/1.1.3/log4j.jar:$NMSROOT/MDC/tomcat/lib/apps/xe rces.jar com.cisco.nm.cmf.cmic.registry.CMICApplicationRegistry RME4.0 0 register all.To unregister RME4.0 using Tomcat, use the following code in post remove:
$NMSROOT/lib/jre141/bin/java -classpath $NMSROOT/lib/classpath/cmic.jar:$NMSROOT/MDC/tomcat/lib/apps/MICE.jar:$NMSROOT/MDC/tomcat/ lib/apps/NATIVE.jar:$NMSROOT/objects/log4j/1.1.3/log4j.jar:$NMSROOT/MDC/tomcat/lib/apps/xe rces.jar com.cisco.nm.cmf.cmic.registry.CMICApplicationRegistry RME4.0 0 unregister.System Flow for CWHP using CMIC
1.
Cisco Products Installed on other servers, 3rd Party Applications, Custom home grown tools will be created by the end user through a CMIC Administration User Interface.
2.
a.
b.
3.
4.
5.
6.
7.
About the CMIC APIs
The following APIs are supported:
Note: Please refer the CMIC Java doc for complete list of API signatures and definitions.
About the Management Service Template
Currently Cisco runs a partner program called Cisco Management Connection, which allows third party Applications to add a launch point from CiscoWorks desktop. All such applications need to follow a certification process for their links to appear in the desktop. A similar program will be introduced to certify the MST's. This will be driven from CCO, where individual applications will be guided to create and update templates. The created template will be certified by a gatekeeper and made available to CMIC registry through PSU. All Cisco Application services will follow the same process to create and update their templates.
The Informtiona in management service template is organized under various tags. The following table describes the tags and attributes used by the MST:
For more information on MST tags and attributes of each tag see, CMIC Software Design Specification, EDCS-137328.
Component Interaction
The table provides informationon the components that participate in the interaction between various components.
About CMIC Registry Dependencies
The CMIC registry depends on the services shown in Table.
Sample MST File
The following file is used by RME to register launch points with CMIC:
<?xml version="1.0" encoding="UTF-8"?>
<!--****************************************************-->
<!-- Copyright (c) 2003 Cisco Systems, Inc. -->
<!-- All rights reserved. -->
<!--****************************************************-->
<APPLICATIONRECORD xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:ws="http://schemas.xmlsoap.org/wsdl/" xsi:noNamespaceSchemaLocation="../cmic.xsd" AppName="RME" AppVersion="4.0" TemplateVersion="1.0" AppDescription="Resource Managemer Essentials" IsCiscoCertified="false" IsCisco="false" Protocol="" Host="" Port="23" ModifiedUser="Madan" ModifiedTime="12 " AppURL="/rme/goHome.do" AppURLWindowName="RME4.0" > <VENDORINFO VendorName="Cisco Systems" Address="170 West TasmanDr. San Jose, CA 95134 USA" Phone="(408)526-4000" Fax="(408)526-4000" Email="tac@cisco.com" ContactURL="http://www.cisco.com"
SupportURL="http://www-tac.cisco.com"/>
<TASKGROUP GroupName="Resource Manager Essentials" GroupURL="/rme/goHome.do">
<TASKINFO TaskName="Devices" TaskIdentity="a" TaskDescription="Device Management" TaskCategory="C" TaskSubCategory="C/admin" SecurityTag="nm.cm.admin" TaskURL="/rme/deviceMgmtDflt.do" SubmitMethod="POST" IsAPI="false">
<INTEGRATIONTAG TagName="CWHP_TASK">
</INTEGRATIONTAG>
</TASKINFO>
<TASKINFO TaskName="Configuration" TaskIdentity="b" TaskDescription="Configuration Management" TaskCategory="C" TaskSubCategory="C/admin" SecurityTag="nm.cm.admin" TaskURL="/rme/configurationDefault.do" SubmitMethod="POST" IsAPI="false">
<INTEGRATIONTAG TagName="CWHP_TASK">
</INTEGRATIONTAG>
</TASKINFO>
<TASKINFO TaskName="Image Management" TaskIdentity="c" TaskDescription="Image Distribution" TaskCategory="C" TaskSubCategory="C/admin" SecurityTag="nm.cm.admin" TaskURL="/rme/swimDefault.do" SubmitMethod="POST" IsAPI="true">
<INTEGRATIONTAG TagName="CWHP_TASK">
</INTEGRATIONTAG>
</TASKINFO>
<TASKINFO TaskName="Job Management" TaskIdentity="d" TaskDescription="Job Browser" TaskCategory="C" TaskSubCategory="C/admin" SecurityTag="nm.cm.admin" TaskURL="/rme/JobMgmt.do" SubmitMethod="POST" IsAPI="false">
<INTEGRATIONTAG TagName="CWHP_TASK">
</INTEGRATIONTAG>
</TASKINFO>
<TASKINFO TaskName="Reports" TaskIdentity="e" TaskDescription="Report Administration" TaskCategory="C" TaskSubCategory="C/admin" SecurityTag="nm.cm.admin" TaskURL="/rme/CriReportJob.do" SubmitMethod="POST" IsAPI="false">
<INTEGRATIONTAG TagName="CWHP_TASK">
</INTEGRATIONTAG>
</TASKINFO>
<TASKINFO TaskName="Tools" TaskIdentity="f" TaskDescription="RME Tools" TaskCategory="C" TaskSubCategory="C/admin" SecurityTag="nm.cm.admin" TaskURL="/rme/toolsDefault.do" SubmitMethod="POST" IsAPI="false">
<INTEGRATIONTAG TagName="CWHP_TASK">
</INTEGRATIONTAG>
</TASKINFO>
<TASKINFO TaskName="Admin" TaskIdentity="g" TaskDescription="Administration of RME Server" TaskCategory="C" TaskSubCategory="C/admin" SecurityTag="nm.cm.admin" TaskURL="/rme/adminDefault.do" SubmitMethod="POST" IsAPI="false">
<INTEGRATIONTAG TagName="CWHP_TASK">
</INTEGRATIONTAG>
</TASKINFO>
</TASKGROUP>
</APPLICATIONRECORD>