Create an adapter for each instance of a CiscoWorks2000 DFM on the network (see Section 2.1, Creating an Adapter). See the integration information in the following sections and then modify the adapter properties (see Section A.9, CiscoWorks2000 DFM).
To integrate CiscoWorks2000 DFM:
Stop the Operations Center server.
For instructions, see Stopping the Operations Center server in Windows
and Stopping the Server and the mosdaemon manually in UNIX
in the Operations Center Server Installation Guide.
Configure the Operations Center server to not restart automatically.
For more information, see the Operations Center Server Configuration Guide.
Copy (or symbolically link) the skclient.jar file from the CiscoWorks distribution to the /OperationsCenter_install_path/classes/ext directory.
Update or install the license file through the Operations Center Configuration Manager, if applicable.
The license file must contain one or more key entries for com.mosol.integration.smarts.DfmIntegration.
Restart the Operations Center server.
For instructions, see Manually Starting the Operations Center Server
and Starting the Operations Center Server in UNIX
in the Operations Center Server Installation Guide.
Create an adapter for each instance of CiscoWorks2000 DFM on the network.
For instructions, see Section 2.1, Creating an Adapter.
It is helpful to know the following information:
The hostname of the DFM Broker
The port that the DFM Broker listens on (default is 9002)
A valid user name and password, if DFM is running with authentication required
IMPORTANT:The Operations Center server and CiscoWorks2000 DFM both run processes that use port 9002. If installing the Operations Center server and CiscoWorks2000 DFM on the same machine, change the Operations Center database listener port from 9002 to another port. Use the Operations Center Configuration Manager to change the Listener Port value from 9002 to an unused port number for the General Datastore and BSA and Alarm History values.
Modify the adapter properties.
For property descriptions, see Section A.9, CiscoWorks2000 DFM.
The integration might throw exceptions in the case of errors or malfunctions. Operations Center logs all exceptions in a standard format. Each logging statement is associated with the following categories: ERROR, INFO, WARN and DEBUG.
The CiscoWorks2000 DFM adapter automatically performs element discovery and synchronization that include:
Discovery of all the technology elements from the DFM database and populating the Operations Center object model
Discovery of classes, instances, and relations between objects for use in the Service Views
Relationship mapping between object for n‑deep nested class/instance/relation sets
Subscriptions to event notifications
Management of instances (when available)
Element property mapping and property pages for elements
Automatic adapter updates for DFM instance create and delete notifications
The specific objects are implemented as proxy objects of the actual DFM objects. When Operations Center queries values (or other data), the adapter requests the data on‑demand from the DFM server. The adapter caches some common data values for efficiency.
Operations Center aggregates all data from the various consoles into the element hierarchy. When comparing the Operations Center element hierarchy tree to the DFM console, typically more Relation instances display in Operations Center than in a single DFM console. This is because the DFM console only shows the relations applicable to that console.
In Operations Center, a unique key value identifies each element. The key value consists of a concatenation of up to three string values delimited by a colon (:). This key value uniquely identifies the element instance in the Operations Center element repository.
A single element can have multiple parents in multiple locations in the element hierarchy. The element’s key value consists of the concatenation of the root hierarchy key plus all element keys for each of its parents.
Table 3-4 describes DFM elements names.
Table 3-4 DFM Element Names
|
Element Type |
Name in Operations Center consists of… |
|---|---|
|
Class |
The class name. For example: Host |
|
Instance |
The concatenation of the class with the instance name. For example: Host:server.mosol.com |
|
Relation |
The concatenation of the class, instance, and relation name. For example: Host:server.mosol.com:ComposedOf |
Normally, the default condition algorithm determines the condition of a Operations Center element. The default condition algorithm sets the element condition equal to the most critical severity of any alarm attached to the element or to its children. The exception is for relation elements, which do not propagate up their condition.
For information on changing the default algorithm, see Using Algorithms to Calculate Element State in the Operations Center Server Configuration Guide.
The ability to perform operations on elements using the right-click menu depends on the ACL permissions granted. Table 3-5 outlines the ACL permission on various element menu operations.
Table 3-5 CiscoWorks2000 DFM—ACL Permissions on Element Operations
|
Element |
Operation |
ACL Permission |
|---|---|---|
|
Adapter (top-level) |
Define |
|
|
Manage |
||
|
Define |
||
|
Define |
||
|
Manage |
||
|
Define |
||
|
Define |
||
|
Instance |
Manage |
|
|
Manage |
||
|
Define |
The CiscoWorks2000 DFM adapter property pages provide a way to review information regarding attributes, programs, libraries and other features.
To view the adapter property pages:
In the Explorer pane, expand Elements > Adapter:CiscoWorks2000.
Right-click an element, then click Properties to open the Status property page.
Select different property pages to view specialized information about the Adapter, Instance, and Class elements.
Table 3-6 outlines the various information and features found in the property pages for the adapter root, class and instance elements.
Table 3-6 CiscoWorks2000 DFM Adapter and Element Property Pages
|
Element Type |
Property Page |
Description |
|---|---|---|
|
Adapter Root |
Details |
Provides information about the adapter connection with the CiscoWorks Domain Manager, including status, socket port and timeout settings. |
|
Correlation |
Provides information regarding the Correlation Codebook and its associated settings. For more information, see Section 3.8.13, Correlating Events. |
|
|
Programs |
Displays the list of programs loaded in the server. |
|
|
Libraries |
Displays the list of models loaded in the server. |
|
|
Subscriptions |
Displays a list of event notification subscriptions (see Section 3.8.12, Subscribing to Events). Allows adding, changing, or deleting subscriptions. |
|
|
Class |
Description |
Displays a textual description for the class element. |
|
Attributes |
Provides the values of various attributes associated with the element. |
|
|
Events |
Displays a list of simple events defined for this class. The simple event names display. Information on this page is read-only. |
|
|
Operations |
Displays a list of all operations defined for this class. |
|
|
Instance |
Attributes |
Provides the values of various attributes defined for the class. Refresh updates the attribute values in real time. Attributes Access types: MR_NO_ACCESS: Attribute value is unavailable. MR_STORED: Sets the attribute value when the class is modeled or instantiated. If the attribute is not read-only, modify it at runtime (optional). MR_COMPUTED: Computes the attribute value upon request. Computed access types are always read-only. MR_INSTRUMENTED: Retrieves attribute value from an external source through a protocol. MR_PROPAGATED: Derives attribute’s value from the values of other class instances in which this class is involved in a relationship or relationship set. MR_UNCOMPUTABLE: Cannot compute attribute value. MR_COMPUTED_WITH_EXPRESSION: Computes attribute value upon request, using an expression. Computed access types are always read-only. |
|
Events |
Displays a list of simple events defined for this class. Allows subscribing and unsubscribing to event notifications for the instance element (see Section 3.8.10, Understanding Event Notifications and Alarms Mappings). |
|
|
Operations |
Displays a list of all available operations for this element. Allows running a selected operation (see Section 3.8.8, Running Instance Operations). |
The DFM monitors managed instances. The DFM does not monitor unmanaged elements, but does probe them and stores element information in the DFM inventory.
When adding elements to or deleting elements from the Domain Manager from another client, the adapter receives notification about the event. The adapter automatically creates (or deletes) the appropriate class and instance elements, allowing for a lazy discovery of object relations.
To create an instance in the DFM:
In the Operations Center Explorer pane, expand the Elements > CiscoWorks2000 DFM element.
Right-click the CiscoWorks2000 DFM element, then click Instance Create.
Specify the class and instance names.
When you delete an instance, you are deleting the instance and its children.
To delete an instance:
Do one of the following:
Right-click the instance element, then select Delete.
Click Yes when prompted for confirmation.
In the Operations Center Explorer pane, right-click the Elements > CiscoWorks2000 DFM element and select Instance Delete.
Specify the name of the class and instance.
To start managing an instance:
In the Explorer pane, right-click an instance element under the CiscoWorks2000 DFM element, then click Manage.
To unmanage an instance:
In the Explorer pane, right-click an instance element under the CiscoWorks2000 DFM element, then click Unmanage.
Operation results (if any) appear in the Operations Center log file as a DEBUG message.
To run an operation on an instance:
In the Explorer pane, right-click an instance element under the CiscoWorks2000 DFM element, then click Properties to open the Status property page.
In the left pane, click Operations.
The Operations property page opens all available operations for the instance.
Following are descriptions of the operation flag types:
OP_CONST: Operation does not change the object.
OP_READONLY: Operation has no side effect on the object.
OP_NOFLAG: Operation returns the same value if called repeatedly, with no other actions performed on the object.
Select an operation to highlight it.
Enter a parameter value in the Parameter field, if the operation supports it.
Restore (read) or save the inventory of the DFM server to a file on the DFM server machine:
To save the element repository:
In the Explorer pane, expand the Administration > Adapters.
Right-click the CiscoWorks2000 DFM adapter, then click Repository Save to open the Repository Save dialog box.
Specify a file name and click OK to save the repository information in the SM_BASEDIR/smarts/repose directory.
The preferred file name extension is .raps.
To restore the element repository:
In the Explorer pane, expand the Administration > Adapters.
Right-click the CiscoWorks2000 DFM adapter, then click Repository Restore to open the Repository Restore dialog box.
Specify a file name and click OK to restore the repository information from the specified file in the SM_BASEDIR/smarts/repose directory.
The adapter converts DFM event notifications to Operations Center alarms and displays them in the Alarms view.
Operations Center represents symptoms as minor alarms and compounds as major alarms (DFM does not subscribe for problems). Table 3-7 outlines these alarm mappings.
Table 3-7 Mapping between CiscoWorks2000 DFM Notifications and Operations Center Alarm Severity
|
Event |
Event Type |
Severity |
Default Severity Color |
|---|---|---|---|
|
SYMPTOM |
MR_EVENT |
MINOR |
Yellow |
|
COMPOUND |
MR_AGGREGATION or MR_PROPAGATED_AGGREGATION |
MAJOR |
Orange |
The adapter maps SmRemoteObserver EVENT_NOTIFY and INFORMATIONAL event types to Operations Center alarms. The configured notification mapping of the adapter instance determines the severity. The adapter always maps SmRemoteObserver EVENT_CLEAR message types to OK severity alarms in Operations Center. This cannot be changed.
Events in DFM can change the state of an alarm from active (when the event type is EVENT_NOTIFY) or inactive (when the event type is EVENT_CLEAR). Operations Center represents active alarms that became inactive with the OK alarm severity. An alarm is considered inactive when the adapter receives a SmRemoteObserver EVENT_CLEAR message type from DFM for a preexisting event.
Table 3-8 lists the operations available for CiscoWorks alarms in the Operations Center Alarms view.
Table 3-8 CiscoWorks2000 DFM—Alarm Operations
|
Operation |
Description |
Required Permission |
|---|---|---|
|
Delete |
Removes an active or inactive alarm. |
Manage |
|
Reset Counter |
Resets the counter to the number of times that the Operations Center server received the event notification. |
Define |
|
Subscribe |
If unsubscribed, subscribes to events with the same event name for the instance. |
Define |
|
Unsubscribe |
If subscribed, unsubscribes from future events using the same event name for the instance. |
Define |
Operations that CiscoWorks2000 DFM does not permit do not display in Operations Center.
The alarm property pages for each alarm displays basic properties of the event notification, a simple description and a list of symptoms, if available.
To view the properties of an alarm:
Right-click an alarm in the Alarms view, then click Properties to open the Status property page.
In the left pane, click Event Attributes.
The Event Attributes property page opens and displays the properties of the alarm.
In the left pane, click Description to view a description of the alarm.
In the left pane, click an information page (Event Causes, Explained By, Problem Explanation, Aggregation¸ or Problem Closure).
Information displays in the associated property page if the data is applicable to that alarm.
The CiscoWorks2000 DFM adapter enables subscribing to and correlating events. Use the adapter to subscribe or unsubscribe to event notifications during startup or runtime.
Event subscriptions reside in a file in the /OperationsCenter_install_path/database directory on a per-adapter instance. If the file does not exist, a default subscriptions file is created. The file name consists of concatenating SmartsConfig and the adapter name.
Starting the adapter also starts the process of reading and parsing this subscription file and sending a request to DFM for each entry.
By default, event subscriptions only apply to existing instances. They do not apply to new instances that occur after a subscription profile is added, unless the Sticky option is selected when the subscription is created.
The following topics describe managing event subscriptions:
To subscribe to event notifications by setting up global subscriptions:
In the Explorer pane, expand the Administration > Adapters.
Right-click CiscoWorks2000 DFM, then do one of the following:
Click Add Subscription.
Click Properties to open the Status property page, and do the following:
In the left pane, click Subscriptions to open the Subscriptions property page.
Click Add.
The Add Subscription dialog box displays.
Specify a value or expression for the Classes, Instances, and Events to which a subscription is made.
Valid syntax includes specific classes, instances, and event types. It is also possible to use regular expression syntax to match a specified pattern.
Select one or more subscription types:
Problems: Notifications that pinpoint the exact cause of a failure.
Symptoms: Notifications indicating an exceptional condition.
Compounds: Notifications that identify one or more failures that have occurred on the same element. These notifications list the symptoms or problems that affect the element.
Select Sticky to apply this event notification subscription to all instances created (before and) after this subscription.
Click Apply to initiate the property subscription.
To subscribe and unsubscribe to event notifications at the instance level:
Right-click an instance in the Explorer pane, then click Properties to open the Status property page.
In the left pane, click Events to open the Events property page.
Do any of the following:
To subscribe to specific events, select the events, then click Subscribe.
To subscribe to all events, click Subscribe All.
To unsubscribe, select the events, then click Unsubscribe.
To unsubscribe to all events, click Unsubscribe All.
Close the property pages.
To subscribe and unsubscribe to event notifications directly from an alarm level:
Right-click an event in the Alarms view, then click Subscribe or Unsubscribe.
If the alarm represents an event that is no longer subscribed to, the Subscribe operation is enabled and the Unsubscribe operation is disabled. If the event is already subscribed to, the Subscribe operation is disabled and the Unsubscribe operation is enabled.
The Correlation property page for the CiscoWorks2000 DFM adapter element displays various correlation metrics:
To view the event correlation property page
In the Explorer pane, expand Elements.
Right-click the CiscoWorks2000 DFM adapter element, then click Properties to open the Status property page.
In the left pane, click Correlation to open the Correlation property page.
To activate real-time correlation for an adapter element:
In the Explorer pane, right-click the CiscoWorks2000 DFM adapter element, then click Correlate Now.
The Domain Manager starts the event correlation process, which continues to run in the background until it finishes.
The Codebook is a casualty mapping between problems and symptoms that is computed by the CiscoWorks2000 DFM Domain Manager’s correlation engine. Use Operations Center operations to request a consistency update from the Domain Manager to regenerate the correlation codebook.
To recompute the codebook:
In the Explorer pane, right-click the CiscoWorks2000 DFM adapter element, then click Recompute Codebook.
The Domain Manager performs the regeneration of the correlation cookbook as a background process.