User Guide for Device Fault Manager 3.2 (With LMS 3.2)
Chapter 3: Using the Alerts and Activities Display

Table Of Contents

Using the Alerts and Activities Display

How to Use the Alerts and Activities Display

Starting the Alerts and Activities Display

Understanding the Layout of the Alerts and Activities Display

Getting Alert Details

Clearing Alerts

Customizing the Alerts and Activities Display

Selecting Views for Alerts and Activities

Filtering Alerts and Activities

Getting Event Details

Starting the Alerts and Activities Detail Page

Understanding the Layout of the Alerts and Activities Detail Page

Command Button Area

Viewing Events Associated with an Alert

Viewing Event Properties

Clearing an Event

Getting Device Information (Detailed Device View)

Starting the Detailed Device View

Understanding the Detailed Device View

Managing/Unmanaging a Single Device Component

Suspending Device and Element Monitoring

Suspending and Resuming Devices

Performing Bulk Manage and Unmanage Operations

Acknowledging, Annotating, and Sending E-Mail Notifications of Alerts

Acknowledging an Alert

Annotating an Alert

Sending E-Mail in Response to an Alert


Using the Alerts and Activities Display


These topics describe how to use the Alerts and Activities display:

How to Use the Alerts and Activities Display

Starting the Alerts and Activities Display

Getting Alert Details

Customizing the Alerts and Activities Display

Getting Event Details

Getting Device Information (Detailed Device View)

Suspending Device and Element Monitoring

Acknowledging, Annotating, and Sending E-Mail Notifications of Alerts

How to Use the Alerts and Activities Display

The Alerts and Activities display provides real-time information about the operational status of your network. The displays are designed so that you can set them up and leave them running. These displays have a monitoring tool that alerts you when something needs attention.

When a fault occurs in your network, Device Fault Manager (DFM) generates an event. All events occurring on the same device are rolled up into a single alert. If the alert occurs on an element in your active Alerts and Activities view, it is shown on your Alerts and Activities display.

When you click the Alert ID, the Alerts and Activities Detail display opens and lists all events in that particular alert. Alerts are displayed by severity; the most severe and recent alerts are listed first. The alert severity is the severity of the alert's most critical event.

You can change event names to names that are more meaningful to you. These customized names will be reflected in both the Alerts and Activities display and any Fault History reports you generate. For information on changing DFM event names using Notification Customization, see Customizing DFM Events.

You can monitor all devices that DFM supports, after you have added those devices using Device Management and ensured that the devices are in your view. However, DFM reports alerts on specific devices or components, not on entire device groups.

You can start the Alerts and Activities display from DFM. If the DFM server is using Access Control Server (ACS) mode, ACS may limit the devices you are permitted to view. For more information, see Device-Based Filtering.

All Fault History reports generated from within the Alerts and Activities display provide information from the past 24 hours.

To generate a Fault History report on time spans beyond the last 24 hours, use Fault History from DFM by selecting Fault History. For more information, see Starting Fault History from the DFM Home Page.

Starting the Alerts and Activities Display

You can start the Alerts and Activities display several ways:

From the LMS portal Functional view, select Alerts and Activities in the DFM portlet.

From the DFM home page, select Faults > Alerts.

By clicking the Alerts and Activities tab and then clicking Alerts and Activities.

Traps received from the Devices are also shown in Alerts and Activities display. For more information on Traps, see Processed and Pass-Through Traps, and Unidentified Traps and Events

Figure 3-1 shows an example of an Alerts and Activities display.


Tip After you become familiar with the Alerts and Activities display, you can modify the information it provides as described in Customizing the Alerts and Activities Display.


Figure 3-1 Alerts and Activities Display

1

View pane. See View Pane.

3

Tabular display pane. See Tabular Display Pane.

2

Launch information and view status bar area. See Launch Information and View Status Bar Area.

4

Window tools area. See Using Window Tools.


Understanding the Layout of the Alerts and Activities Display

These topics provide details about the information in the Alerts and Activities display.

View Pane

The view pane lists the currently available views, or logical groupings of device groups. Views must be created and activated before they can appear on the Alerts and Activities display. By default, two views—All Alerts and Suspended Devices—are always shown.

You can delete alerts from your Alerts and Activities display. (To create and activate a view or remove an unwanted view from your display, see Configuring Views for the Alerts and Activities Display.)

The current view is highlighted in the view pane. The contents of the current view are shown in the tabular display pane to the right of the view pane. To select another view, click the view name in the view pane.

In Figure 3-2 the current view is View1. Icons next to the views indicate the severity of the alerts received from devices in those views. These icons indicate that the devices may need attention.

Figure 3-2 Alerts and Activities Display—View Pane and Severity Icons

For the current view (View1 in this example), severity icons also appear next to the alerts in the tabular display, as shown in Figure 3-2, to help you quickly locate a specific alert.

The view pane is updated every two minutes. You can have up to 18 views in the view pane in a single Alerts and Activities display.

Launch Information and View Status Bar Area

The launch information area shows the time on the server when the Alerts and Activities display was started.

The view status bar lists the selected view, which is shown in the tabular display pane.

Tabular Display Pane

The tabular display pane is the core of the Alerts and Activities display. It is a paging table that contains a list of all alerts that are occurring on the devices in your current view. Alerts are polled every 30 seconds, and the data is refreshed if a change has occurred.

The information is always updated every 6 minutes, regardless of whether changes are detected. For an explanation of all of the items in the tabular display, see Alerts and Activities Tabular Display—Contents.

Icons alert you to what needs attention. For example:

The severity icons indicate which views and alerts require attention.

The diamond symbols in the Last Change column indicate which alerts have experienced recent activity. When no diamonds appears in the Last Change column, the alert is no longer current, or stale.

You can page through the tabular display to view all records. See Figure 3-3 for an illustration of the tabular display pane.

Window Tools Area

The top-right corner of the Alerts and Activities display contains buttons for the available window tools. All buttons are described in Table 2-1Using Window Tools.

Getting Alert Details

Use the tabular display in the Alerts and Activities display to obtain more information about the alerts that are occurring in your current view.

In the tabular display, as shown in Figure 3-3, alerts are grouped by their severity: critical or informational. Within these severity groupings, or buckets, alerts with the latest change are listed first.

When an alert is generated, it remains in the Alerts and Activities display until it expires. DFM sets an alert state to Expired when DFM determines that the alert has been in the Cleared state for 20 minutes.

Alerts are moved to Cleared when their last active event has been in the Cleared state for 20 minutes. You can also clear an event manually (see Clearing Alerts).

While the alert is in the display, if any of its events recur, the alert is updated. If an expired alert recurs, a new alert with a new ID is shown.

The Alerts and Activities display does not report alerts generated on VLANs. However, the event properties page will show the VLAN number to which the port belongs (see Viewing Event Properties).

The Detailed Device View will display to which VLAN ports belong (see Starting the Detailed Device View).

Figure 3-3 provides an example of an Alerts and Activities tabular display. Alerts are polled every 30 seconds, and the data is refreshed if a change has occurred. The information is always updated every 6 minutes, regardless of whether changes are detected.

Figure 3-3 Alerts and Activities—Tabular Display

Table 3-1 defines the table elements.


Tip You can generate a 24-hour Fault History report on all alerts that occurred on devices in your view by opening Fault History from the DFM home page or the window tools area of the Alerts and Activities display.


Table 3-1 Alerts and Activities Tabular Display—Contents 

Heading
Description
!

Severity of alert. The alert severity is determined by the severity of the most critical event in the alert.

Critical alerts always remain at the top of the column, even if you click the column to do a reverse sort.

Critical

Informational Unidentified Trap alert

(no icon)

Informational (for all other alerts)

Alert ID

Alert identifier number. Clicking this link opens an Alerts and Activities Detail page (see Starting the Alerts and Activities Detail Page).

Device

Device type. Indicates that DFM was discovering the device when the alert occurred. The actual device type is reflected when new events occur. For more information, see Using Device Management.

If the DFM server is using Access Control Server (ACS) mode, ACS may limit the devices you are permitted to view. For more information, see Device-Based Filtering.

Duration

Time span since alert creation, depending upon alert status:

Active or Acknowledged

Time span between alert creation and the current server time.

Cleared

Time span between alert creation and Last Change time (The Last Change time may also represent when the alert was cleared).

Last Change

Date and time alert last occurred or was changed. Diamonds indicate alert activity, such as a new event, alert acknowledgement, new user annotation, and so forth.

If there are no diamonds, it indicates that the alert is stale. Alerts are grouped by severity. Within severities, alerts with the latest change are listed first.

Alert was updated within last 15 minutes.

Alert was updated within last 16-30 minutes.

Alert was updated within last 31-45 minutes.

No diamonds

Alert was updated over 46 minutes ago.

Device Name

Device name or IP address. Clicking this link opens the Detailed Device View (see Understanding the Detailed Device View).

Event Updated

Category of the event with the most recent change, one of the following: Environment, Interface, Other, Reachability, System Hardware, Utilization.

Status

Alert status, based on last polling.

Active

Alert is live. (Note that alerts on suspended devices remain active; see Sending E-Mail in Response to an Alert.)

Cleared

Alert is no longer live (Its last active event has been in the Cleared state for 20 minutes).

When the alert has been in the Cleared state for 20 minutes, it expires and is removed from the display.

Acknowledged

Alert was manually acknowledged by a user (from Alerts and Activities Detail page).


Clearing Alerts

You can manually clear alerts.  

You are asked to confirm if you want to clear the alert. Enter your user ID. This will be used as a reference to identify who cleared the alert.


Step 1 From the Alerts and Activities display page, check the checkbox of the alert that you need to clear.

Step 2 Click Clear.

A confirmation window opens.

Step 3 Click OK to confirm and clear the alert, or click Cancel to retain the alert.


You can clear multiple alerts with a single click from the Alerts and Activities display page.


Step 1 From the Alerts and Activities display page, check the checkboxes of alerts that you need to clear.

Step 2 Click Clear.

A confirmation window opens.

Step 3 Click OK to confirm and clear the alert, or click Cancel to retain the alert.


You can also clear alerts from the Alerts and Activities Detail page.


Step 1 From the Alerts and Activities display page, click the alert that you need to clear.

Alerts and Activities Detail page displays the alert details.

Step 2 Click Clear.

A confirmation window opens.

Step 3 Click OK to confirm and clear the alert, or click Cancel to retain the alert.


The alert status is changed to Cleared and remains in that state for twenty minutes. After that time it is removed from the Alerts and Activities Display.

If the status of the alert changes during the twenty minutes, the alert goes to the active state.

Customizing the Alerts and Activities Display

After adding your devices to a view, you can customize your Alerts and Activities display by selecting specific views and using filters:

Views control the device groups that appear on the Alerts and Activities display. See Selecting Views for Alerts and Activities.

Filters control the specific device types you monitor, along with alert severities and their status. See Filtering Alerts and Activities.

You can also change the names of DFM events to names that are more meaningful to you. These names will be reflected in both the Alerts and Activities display and in any Fault History reports you generate. For information on changing DFM event names using Notification Customization, see Customizing DFM Events.

If the DFM server is using Access Control Server (ACS) mode, ACS may limit the devices you are permitted to view. For more information, see Device-Based Filtering.

Selecting Views for Alerts and Activities

When you open the Alerts and Activities display, all available views are listed in the view pane on the left side of the display. If the views shown do not meet your needs, you can create a new view as described in Creating a View.

The view pane is updated every two minutes. You can have up to 18 views in the view pane in a single Alerts and Activities display. See Activating and Deactivating a View for information on how to manage your views.

Filtering Alerts and Activities

You can filter the alerts on the Alerts and Activities so that only the alerts that match your filters are displayed. You can create a filter based on alert severity, status, and ID, and based on the originating device type or name.

If you use an alert filter, the filter is applied to all of your views until you change the filter; other clients are not affected. When you end your session, your filters are lost. Filters do not affect severity icons in the view pane.

To start the Alerts and Activities display,


Step 1 Select Alerts and Activities from the LMS portal. You can also select Faults > Alerts from the DFM home page.

The Alerts and Activities display opens.

Step 2 Click the filtering button in the tool button area at the top-right of the Alerts and Activities display.

The Alert Filters page opens. You can populate the Device Type box by selecting device types from the button to the right of the Device Type box. By default, all device types are selected.

Step 3 Select the appropriate criteria:

Alert severity and status.

Advanced filtering by AlertID and Device Name. (You can use "*" for wild card matches and "?" for single-character matches in the Device Name field. Do not use "*" by itself in the AlertID field; you will get too many results, most of which will be unrelated to your search.)

Step 4 Click OK.


Getting Event Details

These topics address how to start and use the Alerts and Activities Detail page to get more information on events:

Starting the Alerts and Activities Detail Page

Understanding the Layout of the Alerts and Activities Detail Page

Viewing Events Associated with an Alert

Viewing Event Properties

You can change the names of DFM events using Notification Services. See Customizing DFM Events.


Note For VRF enabled devices, DFM does not evaluate whether the device is VRF enabled or not. So, in the Detailed Devices View, DFM displays the IP address for the first interface and not for the second interface.


Starting the Alerts and Activities Detail Page

The Alerts and Activities Detail page provides information about all of the events that were rolled up into a specific alert. Figure 3-4 provides an example of an Alerts and Activities Detail page.

The Alerts and Activities Detail page does not report alerts generated on VLANs. However, the event properties page will show the VLAN number to which the port belongs (see Viewing Event Properties).

The Detailed Device View will display to which VLAN ports belong (see Starting the Detailed Device View).

You can start the Alerts and Activities Detail page two ways:

From the LMS portal DFM view, select a high-severity alert.

From the Alerts and Activities display, select an alert.

Figure 3-4 Alerts and Activities Detail Page

1

Alerts status bar. See the Alert Status Bar.

5

Window tools area. See Using Window Tools.

2

Launch information area. See Launch Information Area.

6

Command button area. See Command Button Area.

3

Tabular display pane. See Tabular Display Pane.

7

Notes pane. See Notes Pane.

4

Tools drop-down list. See Tools Drop-Down List.

 

Understanding the Layout of the Alerts and Activities Detail Page

These topics provide details about the information in the Alerts and Activities display.

Alert Status Bar

The alert status bar lists details about the alert with which the listed events are associated. Table 3-2 explains the contents of the alert status bar area.

Table 3-2 Alerts and Activities Detail  Page—Alert Status Bar Contents 

Field
Description
Device Name

Device name or IP address.

Device

Device type. Learning indicates that DFM was discovering the device when the alert occurred. The actual device type is reflected when new events occur. For more information, see Using Device Management

If the DFM server is using Access Control Server (ACS) mode, ACS may limit the devices you are permitted to view. For more information, see Device-Based Filtering.

Status

Alert status, based on last polling.

Active

Alert is live. (Note that alerts on suspended devices remain active; see Sending E-Mail in Response to an Alert.)

Cleared

Alert is no longer live (its last active event has been in the Cleared state for 20 minutes). When the alert has been in the Cleared state for 20 minutes, it expires and is removed from the display.

Acknowledged

Alert was manually acknowledged by a user (from Alerts and Activities Detail page). If an event on the alert recurs, the alert state reverts to Active.

Alert ID

Alert identifier number.

Duration

Time span since alert creation, depending upon the alert status:

Active or Acknowledged

Time span between alert creation and current server time.

Cleared

Time span between alert creation and Last Change time (the Last Change time may also represent when the alert was cleared).

Last Change

Time and date of last alert update (indicates activity, such as an event recurrence, alert acknowledgement, the addition of an annotation, and so forth). Alerts are grouped by severity, and within severities. Alerts with the latest change are listed first.


Tabular Display Pane

In the Alerts and Activities Detail page, the tabular display pane contains a table that lists details about events. These events are associated with the alert listed in the alert status bar.

You can refresh the display by clicking Refresh at the bottom of the pane. For an explanation of all of the items in the table, see Alerts and Activities Detail Tabular Display—Contents.

You can page through the tabular display to view all records. See Figure 3-3 for an illustration of the tabular display pane.

See Figure 3-4 for an illustration of the actions you can perform from this window.

Launch Information Area

The launch information area shows the time on the server when the Alerts and Activities Detail page was started.

Tools Drop-Down List

The Tools drop-down list contains a list of applications that will display detailed information on events. However this depends on how you have installed DFM. For more information, see Alerts and Activities Detail Tabular Display—Contents.

Notes Pane

The Notes pane lists any alert annotations that users have entered. This tool ensures that all users see information on alerts. To add an annotation to an alert, click the Annotate button. For detail on how to do this see Starting the Alerts and Activities Display.

Command Button Area

In addition to the Annotate button in the notes pane, the command button area provides other ways to respond to alerts.

Table 3-3 Alerts and Activities Detail  Page—Command Buttons 

Button
Action

Refresh

Refreshes the tabular display.

Acknowledge

Changes the event status to Acknowledged. See Acknowledging an Alert for more information.

Clear

Clears and deletes alarms and events.

Suspend

Suspends polling and trap processing on the device or device component by opening a Detailed Device View (DDV), from which you can perform the suspend command. The DDV is described in Starting the Detailed Device View.

Notify

Sends e-mail notification of the alert. See Sending E-Mail in Response to an Alert for more information.

Close

Closes the Alerts and Activities Detail page.


Viewing Events Associated with an Alert

Use the tabular display in the Alerts and Activities Detail page to obtain more information about all of the events associated with a specific alert. In the tabular display, as shown in Figure 3-5, events with the latest change are listed first.

Events remain on the Alerts and Activities Detail page until the parent alert expires. If you suspend a device, all the events are cleared, but the alert remains active. (This way, users cannot remove important information from the display, and you can easily resume the device.)

If an event recurs, the existing event is not updated. Instead, the recurrence is shown as a new event with a new event ID.

Figure 3-5 provides an example of an Alerts and Activities Detail table.

Figure 3-5 Alerts and Activities Detail Page—Tabular Display

Table 3-4 defines the table elements. Click Refresh at the bottom of the page to refresh the table contents.


Tip You can generate a 24-hour Fault History report on all events that occurred on a selected component by opening Fault History from the window tools area of the Alerts and Activities display or from the DFM home page.


Table 3-4 Alerts and Activities Detail Tabular Display—Contents 

Event ID

Event identifier number. Clicking this link opens the event properties page (see Getting Event Details).

Note that this Event ID is not the same as the Event Code provided by Notification Services. For more information, see Customizing DFM Events.

Description

DFM event name (as described in Events Processed). You can also change the names of DFM events to names that are more meaningful to you.

For information on changing DFM event names using Notification Customization, see Customizing DFM Events.

Component

Device element on which the event occurred.

Time

Time at which the event occurred.

Status

Event status, based on last polling.

Active

Event is live.

Cleared

Event is no longer live. When the event has been in the Cleared state for 20 minutes, it expires and is removed from the display.

Note that events on suspended devices are moved to Cleared, but the alert remains active. See Suspending and Resuming Devices.

Suspended

Device is suspended.

Resumed

Device is being resumed.

Deleted

Device has been deleted.

Tools

A drop-down list of applications that can provide more information. The Tools drop-down list can include the following, depending upon the applications installed on your server:

Fault History—Opens a 24-hour Fault History report on the component. See Understanding the Fault History: Events Display.

Device Ctr.—Opens the CiscoWorks Device Center, which provides a centralized point for reports, tools, and tasks that you can perform on the selected device.

UT Report—Opens a User Tracking End Host report that lists end-user hosts in the network. (This tool is available if Campus Manager is installed.)

CiscoView—Opens the CiscoView chassis view for the device. (This tool is available if CiscoView is installed.)


Viewing Event Properties

The event properties page provides additional details about the event, such as the values of MIB attributes at the time of the event, polling and threshold information, and utilization information.

You can view VLAN properties on the event properties page, if applicable, although DFM does not display alerts generated on VLANs. The Detailed Device View will display to which VLAN ports belong (see Starting the Detailed Device View).


Step 1 From the Alerts and Activities display, locate the alert you want to investigate and click the alert ID.

The Alerts and Activities Detail page appears.

Step 2 Locate the event you want to investigate, and click the event ID.

The event properties page appears.


The information that is shown on the event properties page depends on the event type.

Table 3-5 lists the attributes in the Events Properties window.

Table 3-5 List of Classes and their Attributes 

Class
Attribute Name
Attribute Type
Attribute Description

Card

The Card class represents a type of physical container that can be plugged into another Card or HostingBoard, or is itself a HostingBoard/Motherboard in a Chassis. The Card class includes any package capable of carrying signals and providing a mounting point for PhysicalComponents, such as Chips, or other PhysicalPackages, such as other Cards.

CreationClassName

string

Name of the most-derived class of this instance

Description

string

Textual description of the object.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

IsCardNotOperating

boolean

NA

IsManaged

boolean

Determines whether a given SystemElement should be monitored by the management system. An unmanaged object does not have associated instrumentation. This attribute is Read Only.

IsSwitchOverActive

boolean

This package becomes active after IsSwitchOverActive event.

IsSystemUnresponsive

boolean

TRUE if the system is unresponsive.

Location

string

Specifies the position and address of a PhysicalElement.

Name

string

Name of object.

Reason

string

String indicating the reason.

Reserved1

string

Reserved attribute 1.

Reserved2

string

Reserved attribute 2.

 

SerialNumber

string

String indicating the version of the PhysicalElement.

ServiceName

string

Name of external server used for imported events and instrumented attributes.

Slot

string

String indicating the slot of the card during switchover

StandbyStatus

string

Standby status for card redundancy.

Status

string

Indicates the current state of the package as reported by the instrumentation.

OK— Package is operating normally.

CRITICAL— Package is at critical status.

MARGINAL— Package is at marginal status.

OTHER— Status of the package is other than the above or unrecognized SNMP error.

NOTPRESENT— Package MIB value missing.

UNKNOWN— Default value before SNMP polling.

SystemName

string

Name of the System containing this element.

Tag

string

Arbitrary string that uniquely identifies the PhysicalElement and serves as the element's key. The Tag property can contain information such as Asset tag or Serial Number data.

The key for PhysicalElement is high in the object hierarchy. This is to identify the hardware and the entity, regardless of physical placement.

For example, a hotswappable or removable component may be taken from its containing (scoping) package and be temporarily unused.

However, this object still continues to exist and may be inserted into a different scoping container.

Type

string

Functional type of this PhysicalPackage.

Chassis

The Chassis class represents the PhysicalElements that enclose other Elements and provide definable functionality, such as a desktop, processing node, UPS, disk or tape storage, or a combination of these.

AprioriProbability_Down

float

NA

BackplaneUtilization

float

Percentage of bandwidth utilization for the Chassis backplane as reported by the instrumentation.

CreationClassName

string

Name of the most-derived class of this instance.

Description

string

Textual description of the object.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

IsAnySystemResponsive

boolean

NA

 

IsManaged

boolean

Determines whether an ICIM_ManagedSystemElement should be monitored by the management system.

An unmanaged object does not have associated instrumentation. This attribute is Read Only.

Location

string

Specifies the position and address of a physical element.

Name

string

Name of object

SerialNumber

string

String indicating the version of the ICIM_PhysicalElement.

ServiceName

string

Name of external server used for imported events and instrumented attributes.

Status

string

Indicates the current state of the package as reported by the instrumentation.

OK— Package is operating normally.

CRITICAL— Package is at critical status.

MARGINAL— Package is at marginal status.

OTHER— Status of the package is other than the above or unrecognized SNMP error.

NOTPRESENT— Package MIB value missing.

UNKNOWN— Default value before SNMP polling.

SystemName

string

Name of the ICIM_System containing this element.

Tag

string

Arbitrary string that uniquely identifies the PhysicalElement and serves as the element's key. The Tag property can contain information such as Asset tag or Serial Number data.

The key for PhysicalElement is high in the object hierarchy. This is to identify the hardware and the entity, regardless of physical placement.

For example, a hotswappable or removable component may be taken from its containing (scoping) package and be temporarily unused.

However, this object still continues to exist and may be inserted into a different scoping container.

Type

string

Functional type of this PhysicalPackage.

Disk

Capabilities and management of Disk-related LogicalDevices.

Access

string

Indicates whether this long-term storage device is readable and writable or only readable.

This should reflect the media type, any write-protect mechanism, and any device configuration that affects the entire device.

Capacity

int

Total size in KBytes for this long-term storage device. If the media is removable and is currently removed, this value should be zero.

CreationClassName

string

Name of the most-derived class of this instance.

Description

string

Textual description of the object.

DeviceID

string

Address or other information to uniquely identify the LogicalDevice.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

HighAvgDataRate

double

Data rate is higher than MaxAvgDataRate.

HighQueueDepth

double

Average queue depth is higher than MaxAvgQueueDepth.

IsManaged

boolean

Determines whether a given SystemElement should be monitored by the management system. An unmanaged object does not have associated instrumentation. This attribute is Read Only.

MaxAvgDataRate

double

Threshold for I/O date rate in KB/sec.

MaxAvgQueueDepth

double

Threshold for the average size of the disk's request queue(s).

Media

string

Indicates the type of media used in this long- term storage device.

Name

string

Name of object

Removable

boolean

Denotes whether or not the disk media may be removed from the drive.

Reserved1

string

Reserved attribute 1.

Reserved2

string

Reserved attribute 2.

ServiceName

string

Name of external server used for imported events and instrumented attributes.

Status

string

Current status of the Fan as reported by the instrumentation.

SystemName

string

Name of the System containing this element.

Fan

Capabilities and management of a Fan CoolingDevice.

CreationClassName

string

Name of the most-derived class of this instance.

Description

string

Textual description of the object.

DeviceID

string

Address or other identifying information to uniquely identify the LogicalDevice.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

IsManaged

boolean

Determines whether a given SystemElement should be monitored by the management system. An unmanaged object does not have associated instrumentation. This attribute is Read Only.

Name

string

Name of object

Reserved1

string

Reserved attribute 1.

Reserved2

string

Reserved attribute 2.

ServiceName

string

Name of external server used for imported events and instrumented attributes.

Status

string

Current status of the Fan as reported by the instrumentation.

SystemName

string

Name of the System containing this element.

Host

Host is a UnitaryComputerSystem that represents a workstation or server.

AccessMode

string

Mode to access a system. It can have one of the following values: ICMPONLY, SNMPONLY, or ICMPSNMP.

AprioriProbability_Down

float

NA

Certification

string

Defines the level of certification that this device has in the Discovery process:

UNSUPPORTED— Deprecated.

GENERIC — OID for the device is not recognized and the device will be classified as GENERIC and added to the Node class. Standard MIB-II data is used to perform analysis on the device.

TEMPLATE— Device is recognized but any information about the MIBs that this device supports is unknown.

CERTIFIED —Device has the highest level of certification and is discovered using enterprise MIBs as well as standard MIB-II data.

VALIDATED— Deprecated.

UNDISCOVERED—System is undiscovered.

CreationClassName

string

Name of the most-derived class of this instance.

Description

string

Textual description of the object.

DiscoveredFirstAt

string

Time when the first Discovery probe of this system occurred.

DiscoveredLastAt

string

Time when the last Discovery probe of this system occurred.

DiscoveryErrorInfo

string

Message describing the last Discovery error for this system.

DiscoveryTime

string

Length of time it took for the last Discovery probe of this system.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

Domain

string

The domain to which the system belongs.

Grouping1

string

NA

Grouping2

string

NA

Grouping3

string

NA

IsAddressable

boolean

Set to TRUE if the system is IP addressable.

IsDiscoveryInProgress

boolean

TRUE if Discovery in progress for this system.

IsEveryIPUnresponsive

boolean

NA

IsEveryNeighborUnresponsive

boolean

NA

IsEverySNMPAgentUnresponsive

boolean

NA

 

IsManaged

boolean

Determines whether a given SystemElement should be monitored by the management system. An unmanaged object does not have associated instrumentation. This attribute is Read Only.

IsMgmtStation

boolean

TRUE if this node is the Network Management Station.

IsMightBeDown

boolean

NA

IsSeed

boolean

TRUE if the system is added as seed.

IsUnmanagedOrUnresponsive

boolean

NA

IsUnmanagedOrUnresponsive_internal

boolean

NA

IsUnresponsive

boolean

TRUE— Indicates that the system is not responding to ICMP pings or SNMP polls.

FALSE— Indicates that the system is responding to ICMP pings and/or SNMP polls

IsUnresponsive_internal

boolean

NA

Location

string

Specifies where this system is located.

LossProbability_Unresponsive

float

NA

Model

string

The name by which the system is generally known.

Name

string

Name of object

NameFormat

string

The ComputerSystem object and its derivatives are Top Level Objects of ICIM. They provide the scope for numerous components.

You must have unique System keys. A heuristic is defined to create the ComputerSystem Name to attempt to always generate the same Name, independent of discovery protocol.

This prevents inventory and management problems where the same asset or entity is discovered multiple times and cannot be resolved to a single object. Use of the heuristic is optional, but recommended.

The NameFormat property uses a heuristic to identify how the ComputerSystem Name is generated. The heuristic is described in the CIM V2 System Model specifications. It assumes that the documented rules are traversed in order, to determine and assign a name.

The NameFormat Values list defines the precedence order to assign the ComputerSystem Name. Several rules map to the same Value.

The ComputerSystem Name that is calculated, using the heuristic is the System's key value. You can assign other names, or aliases, for the ComputerSystem.

 

NumberOfInterfaces

unsigned-int

NA

NumberOfIPs

unsigned-int

NA

NumberOfNetworkAdapters

unsigned-int

NA

NumberOfPorts

unsigned-int

NA

OSVersion

string

The software version of this system's operating system.

PrimaryOwnerContact

string

A string that provides information on how the primary system owner can be reached (e.g., phone number, e-mail address).

PrimaryOwnerName

string

Name of the primary system owner.

ReadCommunity

string

SNMP read community string.

RemoveComponents

string

Enable or disable component deletion functionality for ICIM_System instances. This is used by remove() function. Default value is set to FALSE.

Reserved1

string

Reserved attribute 1.

Reserved2

string

Reserved attribute 2.

ServiceName

string

Name of external server used for imported events and instrumented attributes.

SNMPAddress

string

Primary address used to contact the SNMP agent running on this system.

Note that if this system hosts more than one network address it may be possible that another address is currently being used to contact the agent.

SourceAddress

string

System level source address. All IP addresses that are hosted by the system use this address as source address. This is unless each IP address has its own source address.

SupportsSNMP

boolean

TRUE if this system can be managed using SNMP.

SystemName

string

Name of this System object.

SystemObjectID

string

System Object Identifier associated with the Vendor of this ComputerSystem.

Type

string

Classifies the ComputerSystem. This attribute is used primarily for display purposes only.

The actual capabilities of a ComputerSystem are reflected in the LogicalDevices, Services, and ServiceAccessPoints related to it.

UseBridgingRelationship

boolean

TRUE to use Bridging relationship in correlation.

Vendor

string

Name of the system's supplier.

Interface

Interface is a device that represents a logical (typically Layer 2) connection to a network. For example, an ethernet interface.

AdminStatus

string

Reflects the current administrative status of the interface as reported by the instrumentation.

UP — Port or interface is administratively enabled.

DOWN— Port or interface is administratively disabled.

TESTING — Port or interface is in testing mode.

OTHER— Port or interface is in an unknown state.

NOTPRESENT — Port or interface MIB value missing.

UNKNOWN—Port or interface has not yet been polled.

AprioriProbability_Disabled

float

NA

AprioriProbability_Down

float

NA

AprioriProbability_LogicalConnectionDown

float

NA

CreationClassName

string

Name of the most-derived class of this instance.

CurrentUtilization

float

Current utilization of the NetworkAdapter expressed as a percentage of the bandwidth.

Description

string

Textual description of the object.

DeviceID

string

Address or other information to uniquely identify the LogicalDevice.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

DuplexMode

string

Indicates whether the adapter is full-duplex or half-duplex.

FULLDUPLEX — Indicates the adapter is full-duplex.

HALFDUPLEX — Indicates the adapter is half-duplex.

UNSPECIFIED— Duplex mode is not available.

 

DuplexSource

string

Indicates the source for setting the adapter to be full-duplex or half-duplex.

ENTERPRISE_MIB— Duplex is set by enterprise specific mib.

ETHERLIKE_MIB—Duplex is set by the value of dot3StatsDuplexStatus in ETHERLIKE MIB.

NEIGHBOR_MIB—Duplex is set by neighbor mib like Cisco CDP MIB.

USER_CHANGED—Duplex is set by the user.

ASSUMED—Duplex is set based upon the type of interface.

NONE —Duplex is not set by any sources.

OTHER_SOURCE—Placeholder for future use.

Grouping1

string

Propagated from Device's Grouping1.

Grouping2

string

Propagated from Device's Grouping2.

Grouping3

string

Propagated from Device's Grouping3.

InterfaceAlias

string

Alias name for the network adapter as specified by a network manager.

InterfaceCode

string

Represents the interface types or protocols or encapsulations.

InterfaceKey

string

Unique value that identifies this Interface within the scope of the containing system.

InterfaceNumber

unsigned-int

Integer value that uniquely identifies this adapter within the scope of the containing system.

IsConnector

boolean

TRUE if this Network Adapter is part of the networking infrastructure, e.g., a router or trunk port as opposed to a user access port.

IsFlapping

boolean

TRUE - Indicates that the port or interface is flapping.FALSE - Indicates that the port or interface is not flapping.

IsLogicalConnectionDownEnabled

boolean

TRUE if the LogicalConnectionDown problem is enabled.

IsLogicalNetworkAdapter

boolean

NA

IsManaged

boolean

Determines whether a given SystemElement should be monitored by the management system. An unmanaged object does not have associated instrumentation. This attribute is Read Only.

IsNetworkAdapterNotOperating

boolean

NA

IsSystemUnresponsive

boolean

NA

 

LastChangedAt

string

Time at which the adapter last changed state. This typically represents the time at which this application noticed the change in state.

It does not necessarily represent the actual time that the state changed.

Location

string

Propagated from Device's Location.

MaximumUptime

unsigned-int

Maximum length of time, in seconds, that an ONDEMAND or BACKUP NetworkAdapter may be in the UP state before the event ExceededMaximumUptime is notified. If this attribute is set to 0 the event is disabled.

MaxSpeed

unsigned-long

Maximum speed, in Bits per Second, for the NetworkAdapter.

MaxTransferUnit

unsigned-int

Size of the largest datagram which can be sent or received on the interface, specified in octets.

For interfaces that are used for transmitting network datagrams, this is the size of the largest network datagram that can be sent on the interface.

Mib2IfType

int

Numerical representation of the interface type.

Mode

string

Indicates the intended purpose of this adapter: backup, dial-on-demand, or normal. The diagnostics applied to a particular adapter will vary based on its mode.

For instance, an alert should not be generated when a backup or dial-on-demand adapter is down.

Name

string

Name of object

NumberOfNetworkAdapters

unsigned-int

Total number of network adapters in the computer system.

OperStatus

string

Reflects the current operational status of the interface as reported by the instrumentation.

UP— Port or interface is operationally up. -

DOWN—Port or interface is operationally down.

TESTING — Port or interface is in testing mode.

OTHER— Port or interface is in an unknown state.

DORMANT — Port or interface is waiting for an external action to occur before becoming active.

NOTPRESENT— Port or interface MIB value missing.

UNKNOWN— Port or interface has not yet been polled

OSVersion

string

Propagated from Device's OSVersion.

PeerSystemName

string

Name of the system containing the NetworkAdapter that is the Peer of this NetworkAdapter.

 

PeerSystemType

string

Type of the system containing the NetworkAdapter that is the Peer of this NetworkAdapter.

PrimaryOwnerContact

string

Propagated from Device's PrimaryOwnerContact.

Reserved1

string

Reserved attribute 1.

Reserved2

string

Reserved attribute 2.

ServiceName

string

Name of external server used for imported events and instrumented attributes.

Status

string

Reflects the current status of the interface as reported by the instrumentation.

SuppressDisabledNotifications

boolean

Obsolete attribute.

SuppressTestingNotifications

boolean

If TRUE then do not generate a problem alert when the adapter is in testing mode.

SystemModel

string

Name by which the system is generally known.

SystemName

string

Name of the system containing this element.

SystemObjectID

string

System Object Identifier associated with the Vendor of this ComputerSystem.

SystemType

string

Type of the system containing this NetworkAdapter.

SystemVendor

string

Name of the system's supplier.

TrafficRate

float

Total input and output traffic rate expressed in octets per second.

Utilization is measured as:

max(ifInOctets, ifOutOctets), if Full Duplex

sum(ifInOctets, ifOutOctets), if Half Duplex

Type

string

Type of interface, distinguished according to the physical/link protocol(s) immediately `below' the network layer in the protocol stack.

IP

IP describes the IP-layer characteristics of a network-attached interface.

Address

string

IP address.

CreationClassName

string

Name of the most-derived class of this instance.

Description

string

Textual description of the object.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

InterfaceAdminStatus

string

AdminStatus of the underlying Network Adapter.

InterfaceMode

string

Mode (backup, on-demand, normal) of the Interface Underlying this IP end point.

InterfaceName

string

Name of the underlying Network Adapter.

InterfaceOperStatus

string

OperStatus of the underlying Network Adapter.

InterfaceType

string

Type of the Interface Underlying this IP end point.

 

IPStatus

string

Reflects the current state of the IP end point as reported by the instrumentation. IP objects are typically instrumented using the ICMP (ping) protocol.

IsInterfaceInstrumented

boolean

TRUE if the IP LayeredOver Interface is instrumented.

IsManaged

boolean

A ServiceAccessPoint is managed if its containing system is managed and the Service it accesses is managed.

IsSystemsUnmanagedOrUnresponsive

boolean

NA

Name

string

Name of object

Netmask

string

Network mask.

NetworkNumber

string

Network number (computed from Address and Netmask).

Reserved1

string

Reserved attribute 1.

Reserved2

string

Reserved attribute 2.

Responsive

boolean

TRUE if a successful response has been received from the IP address.

ServiceName

string

Name of external server used for imported events and instrumented attributes.

Status

string

Current status of the ServiceAccessPoint. One of: RESPONSIVE, UNRESPONSIVE, or UNKNOWN.

SystemName

string

Name of the system hosting this ServiceAccessPoint.

SystemType

string

Type of system that hosts this IP end point.

IPNetwork

An IPNetwork is a specialization of LogicalNetwork that represents a logical IP sub-network.

ConnectedSystemsUnresponsive

boolean

NA

CreationClassName

string

Name of the most-derived class of this instance.

Description

string

Textual description of the object.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

IsManaged

boolean

Determines whether a given SystemElement should be monitored by the management system. An unmanaged object does not have associated instrumentation. This attribute is Read Only.

Name

string

Name of object

Netmask

string

IP network mask.

NetworkNumber

string

IP network number.

Reserved1

string

Reserved attribute 1.

Reserved2

string

Reserved attribute 2.

 

ServiceName

string

Name of external server used for imported events and instrumented attributes.

SystemName

string

Name of the System containing this element.

MAC

MAC describes the link-layer characteristics of a network attached interface.

Address

string

IEEE 802.x MAC address.

CreationClassName

string

Name of the most-derived class of this instance.

Description

string

Textual description of the object.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

IsManaged

boolean

ServiceAccessPoint is managed if its containing System is managed and the Service it accesses is managed.

Name

string

Name of object

NumberOfBridgedViaThreshold

int

NA

Reserved11.

string

Reserved attribute

Reserved2

string

Reserved attribute 2.

ServiceName

string

Name of external server used for imported events and instrumented attributes.

SystemName

string

Name of the system hosting this ServiceAccessPoint.

Memory

Capabilities and management of Memory-related LogicalDevices.

BufferMissPct

float

Number of buffer misses expressed as a percentage of the total number of buffer requests.

BufferUtilizationPct

float

Number of buffers used expressed as a percentage of the total number of buffers.

CreationClassName

string

Name of the most-derived class of this instance.

Description

string

Textual description of the object.

DeviceID

string

Address or other information to uniquely identify the LogicalDevice.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

FreeMemory

unsigned-int

Amount of free memory currently available in KBytes as reported by the instrumentation.

FreeMemoryPct

double

Percentage of free memory of the total memory

IsManaged

boolean

Determines whether a given SystemElement should be monitored by the management system. An unmanaged object does not have associated instrumentation. This attribute is Read Only.

LargestFreeBuffer

int

Largest number of contiguous KBytes that are currently unused.

Name

string

Name of object

ServiceName

string

Name of external server used for imported events and instrumented attributes.

SystemName

string

Name of the ICIM_System containing this element.

TotalBufferAllocationFailures

int

Number of buffer allocation failures due to lack of memory experienced in the last polling cycle.

TotalMemory

int

Total amount of memory present in this device as reported by the instrumentation.

NasManager

NA

AddFsToPending

boolean

If TRUE, add non-discovered FileServer to the pending list

CreationClassName

string

Name of the most-derived class of this instance.

HttpsAdapterName

string

Name of the HTTPS Java adapter.

Name

string

Name of object

pdlTable

struct[]

Table holding entries to be added to the pending list

ServiceName

string

Name of external server used for imported events and instrumented attributes.

Node

Node is a class representing a generic computer system.

AccessMode

string

Mode to access a system. It can have one of the following values: ICMPONLY, SNMPONLY, or ICMPSNMP.

AprioriProbability_Down

float

NA

Certification

string

Defines the level of certification that this device has in the Discovery process:

UNSUPPORTED— Deprecated.

GENERIC — OID for the device is not recognized and the device will be classified as GENERIC and added to the Node class. Standard MIB-II data is used to perform analysis on the device.

TEMPLATE— Device is recognized but that no information about the MIBs this device supports is unknown.

CERTIFIED — Device is recognized but any information about the MIBs that this device supports is unknown.

VALIDATED— Deprecated.

UNDISCOVERED—System is undiscovered.

CreationClassName

string

Name of the most-derived class of this instance.

Description

string

Textual description of the object.

DiscoveredFirstAt

string

Time when the first discovery probe of this System occurred.

DiscoveredLastAt

string

Time when the last discovery probe of this System occurred.

DiscoveryErrorInfo

string

Message describing the last discovery error for this System.

DiscoveryTime

string

Length of time it took for the last discovery probe of this System.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

Domain

string

Domain to which the system belongs.

Grouping1

string

NA

Grouping2

string

NA

Grouping3

string

NA

IsAddressable

boolean

Set to TRUE if the system is IP addressable.

IsDiscoveryInProgress

boolean

TRUE if Discovery in progress for this system.

IsEveryIPUnresponsive

boolean

NA

IsEveryNeighborUnresponsive

boolean

NA

IsEverySNMPAgentUnresponsive

boolean

NA

IsManaged

boolean

Determines whether a given SystemElement should be monitored by the management system. An unmanaged object does not have associated instrumentation. This attribute is Read Only.

 

IsMightBeDown

boolean

NA

IsSeed

boolean

TRUE if the system is added as seed.

IsUnmanagedOrUnresponsive

boolean

NA

IsUnresponsive

boolean

TRUE— Indicates that the system is not responding to ICMP pings or SNMP polls.

FALSE— Indicates that the system is responding to ICMP pings and/or SNMP polls

IsUnresponsive_internal

boolean

NA

Location

string

Description of where this System is located.

LossProbability_Unresponsive

float

NA

Model

string

Name by which the System is generally known.

Name

string

Name of object

NameFormat

string

The ComputerSystem object and its derivatives are Top Level Objects of ICIM. They provide the scope for numerous components.

You must have unique System keys. A heuristic is defined to create the ComputerSystem Name to attempt to always generate the same Name, independent of discovery protocol.

This prevents inventory and management problems where the same asset or entity is discovered multiple times and cannot be resolved to a single object. Use of the heuristic is optional, but recommended.

The NameFormat property uses a heuristic to identify how the ComputerSystem Name is generated. The heuristic is described in the CIM V2 System Model specifications. It assumes that the documented rules are traversed in order, to determine and assign a name.

The NameFormat Values list defines the precedence order to assign the ComputerSystem Name. Several rules map to the same Value.

The ComputerSystem Name that is calculated, using the heuristic is the System's key value. You can assign other names, or aliases, for the ComputerSystem

NumberOfInterfaces

unsigned-int

NA

NumberOfIPs

unsigned-int

NA

NumberOfNetworkAdapters

unsigned-int

NA

NumberOfPorts

unsigned-int

NA

 

OSVersion

string

Software version of this system's operating system.

PrimaryOwnerContact

string

String that provides information on how the primary system owner can be reached (e.g., phone number, e-mail address).

PrimaryOwnerName

string

Name of the primary system owner.

ReadCommunity

string

SNMP read community string.

RemoveComponents

boolean

Enable or disable component deletion functionality for ICIM_System instances. This is used by remove() function. Default value is set to FALSE.

Reserved1

string

Reserved attribute 1.

Reserved2

string

Reserved attribute 2.

ServiceName

string

Name of external server used for imported events and instrumented attributes.

SNMPAddress

string

Primary address used to contact the SNMP agent running on this system.

Note that if this system hosts more than one network address it may be possible that another address is currently being used to contact the agent.

SourceAddress

string

System level source address. All IP addresses that are hosted by the system use this address as source address. This is unless each IP address has its own source address.

SupportsSNMP

boolean

TRUE if this system can managed using SNMP.

SystemName

string

Name of this system object.

SystemObjectID

string

System Object Identifier associated with the Vendor of this ComputerSystem.

Type

string

Classifies the ComputerSystem. This attribute is used primarily for display purposes only.

The actual capabilities of a ComputerSystem are reflected in the LogicalDevices, Services, and ServiceAccessPoints related to it.

UseBridgingRelationship

boolean

TRUE to use Bridging relationship in correlation.

Vendor

string

Name of the system's supplier.

Partition

ICIM_Collection represents of collection of managed Elements.

CreationClassName

string

Name of the most-derived class of this instance.

Description

string

Textual description of the object.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

IsProxy

boolean

TRUE if this is proxy partition.

IsProxyDown

boolean

TRUE if the proxy partition is down.

Name

string

Name of object

NumberOfSystems

int

Total number of member systems.

PartitionKey

string

Unique value that distinguishes this Partition from all other Partitions.

ServiceName

string

Name of external server used for imported events and instrumented attributes.

Port

Port is a specialization of ICIM_NetworkAdapter that represents a port to which an Interface connects and gains access to a network.For example, an ethernet port on an Ethernet Switch.

AdminStatus

string

Reflects the current administrative status of the interface as reported by the instrumentation.

UP — Port or interface is administratively enabled.

DOWN— Port or interface is administratively disabled.

TESTING — Port or interface is in testing mode.

OTHER— Port or interface is in an unknown state.

NOTPRESENT — Port or interface MIB value missing.

UNKNOWN—Port or interface has not yet been polled.

AprioriProbability_Disabled

float

NA

AprioriProbability_Down

float

NA

AprioriProbability_LogicalConnectionDown

float

NA

CreationClassName

string

Name of the most-derived class of this instance.

CurrentUtilization

float

Current utilization of the NetworkAdapter expressed as a percentage of the bandwidth.

Description

string

Textual description of the object.

DesignatedBridge

string

Unique Bridge Identifier of the Bridge recorded as the Root in the Configuration BPDUs transmitted by the Designated Bridge for the segment to which the port is attached.

DesignatedPort

unsigned-int

The Port Identifier of the port on the Designated Bridge for this port's segment.

DeviceID

string

Address or other identifying information to uniquely name the LogicalDevice.

 

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

DuplexMode

string

Indicates whether the adapter is full-duplex or half-duplex.

FULLDUPLEX — Indicates the adapter is full-duplex.

HALFDUPLEX — Indicates the adapter is half-duplex.

UNSPECIFIED— Duplex mode is not available.

DuplexSource

string

Indicates the source for setting the adapter to be full-duplex or half-duplex.

ENTERPRISE_MIB— Duplex is set by enterprise specific mib.

ETHERLIKE_MIB—Duplex is set by the value of dot3StatsDuplexStatus in ETHERLIKE MIB.

NEIGHBOR_MIB—Duplex is set by neighbor mib like Cisco CDP MIB.

USER_CHANGED—Duplex is set by the user.

ASSUMED—Duplex is set based upon the type of interface.

NONE —Duplex is not set by any sources.

OTHER_SOURCE—Placeholder for future use.

Grouping1.

string

Propagated from Device's Grouping1

Grouping2

string

Propagated from Device's Grouping2.

Grouping3

string

Propagated from Device's Grouping3.

InterfaceAlias

string

Alias name for the network adapter as specified by a network manager.

InterfaceCode

string

Represents the interface types or protocols or encapsulations.

InterfaceNumber

unsigned-int

Integer value that uniquely identifies this adapter within the scope of the containing system.

IsConnectedToManagedSystem

boolean

TRUE if the device connected to this Port is in the topology and is managed.

IsConnectedToSystem

boolean

TRUE if the device connected to this Port is in the topology.

IsConnector

boolean

TRUE if this Network Adapter is part of the networking infrastructure, e.g., a router or trunk port as opposed to a user access port.

IsFlapping

boolean

TRUE - Indicates that the port or interface is flapping.FALSE - Indicates that the port or interface is not flapping.

IsLogicalConnectionDownEnabled

boolean

TRUE if the LogicalConnectionDown problem is enabled.

IsLogicalNetworkAdapter

boolean

NA

 

IsManaged

boolean

Determines whether a given SystemElement should be monitored by the management system. An unmanaged object does not have associated instrumentation. This attribute is Read Only.

IsNetworkAdapterNotOperating

boolean

NA

IsSystemUnresponsive

boolean

NA

LastChangedAt

string

Time at which the adapter last changed state. This typically represents the time at which this application noticed the change in state. It does not necessarily represent the actual time that the state changed.

Location

string

Propagated from Device's Location.

ManagedState

string

Keeps track of the management status of this device in case the system containing this device is unmanaged. Restores the device's management status once the system is remanaged.

MaximumUptime

unsigned-int

Maximum length of time, in seconds, that an ONDEMAND or BACKUP NetworkAdapter may be in the UP state before the event ExceededMaximumUptime is notified. If this attribute is set to 0 the event is disabled.

MaxSpeed

unsigned-long

The maximum speed, in Bits per Second, for the NetworkAdapter.

MaxTransferUnit

unsigned-int

Size of the largest datagram which can be sent or received on the interface, specified in octets.

For interfaces that are used for transmitting network datagrams, this is the size of the largest network datagram that can be sent on the interface.

Mib2IfType

int

Numerical representation of the interface type.

Mode

string

Indicates the intended purpose of this adapter: backup, dial-on-demand, or normal. The diagnostics applied to a particular adapter will vary based on its mode. For instance, an alert should not be generated when a backup or dial-on-demand adapter is down.

Name

string

Name of object

NumberOfBridgesThreshold

int

NA

NumberOfNetworkAdapters

unsigned-int

Total number of network adapters in the computer system.

 

OperStatus

string

Reflects the current operational status of the interface as reported by the instrumentation.

UP— Port or interface is operationally up. -

DOWN—Port or interface is operationally down.

TESTING — Port or interface is in testing mode.

OTHER— Port or interface is in an unknown state.

DORMANT — Port or interface is waiting for an external action to occur before becoming active.

NOTPRESENT— Port or interface MIB value missing.

UNKNOWN— Port or interface has not yet been polled.

OSVersion

string

Propagated from Device's OSVersion.

PeerSystemName

string

Name of the system containing the NetworkAdapter that is the Peer of this NetworkAdapter.

PeerSystemType

string

The type of the system containing the NetworkAdapter that is the Peer of this NetworkAdapter.

PortKey

string

Unique value that identifies this Port from other Ports within the scope of the containing system. The PortKey is typically used to identify the Port to the Instrumenation.

Depending on the vendor implementation, the PortKey may or may not be equivalent to the PortNumber, which may or may not be equivalent to the InterfaceKey.

PortNumber

unsigned-int

Integer value that uniquely identifies this Port within the scope of the containing system.

PortType

string

Type of Port represented by this object. Valid values are TRUNK and ACCESS. The default is ACCESS.

PrimaryOwnerContact

string

Propagated from Device's PrimaryOwnerContact.

Reserved1

string

Reserved attribute 1.

Reserved2

string

Reserved attribute 2.

ServiceName

string

Name of external server used for imported events and instrumented attributes.

Status

string

Reflects the current status of the interface as reported by the instrumentation.

SuppressDisabledNotifications

boolean

Obsolete attribute.

SuppressTestingNotifications

boolean

If TRUE then do not generate a problem alert when the adapter is in testing mode.

SystemModel

string

Name by which the system is generally known.

SystemName

string

Name of the system containing this element.

SystemObjectID

string

The System Object Identifier associated with the Vendor of this ComputerSystem.

 

SystemType

string

Type of the system containing this NetworkAdapter.

SystemVendor

string

The name of the System's supplier.

TrafficRate

float

Total input and output traffic rate expressed in octets per second. Utilization is measured as:

max(ifInOctets, ifOutOctets), if Full Duplex

sum(ifInOctets, ifOutOctets), if Half Duplex

Type

string

The type of interface, distinguished according to the physical/link protocol(s) immediately `below' the network layer in the protocol stack.

PowerSupply

Capabilities and management of the PowerSupply LogicalDevice.

CreationClassName

string

The name of the most-derived class of this instance.

Description

string

Textual description of the object.

DeviceID

string

Address or other information to uniquely identify the LogicalDevice.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

IsManaged

boolean

Determines whether a given SystemElement should be monitored by the management system. An unmanaged object does not have associated instrumentation. This attribute is Read Only.

Name

string

Name of object

ServiceName

string

Name of external server used for imported events and instrumented attributes.

Status

string

Current status of the PowerSupply as reported by the instrumentation.

SystemName

string

Name of the ICIM_System containing this element.

Probe

Probe is a ComputerSystem that monitors networks or systems. For example, an RMON probe.

AccessMode

string

The mode to access a system. It can have one of the following values: ICMPONLY, SNMPONLY, or ICMPSNMP.

AprioriProbability_Down

float

NA

 

Certification

string

Defines the level of certification that this device has in the Discovery process:

UNSUPPORTED— Deprecated.

GENERIC— OID for the device is not recognized and the device will be classified as GENERIC and added to the Node class. Standard MIB-II data is used to perform analysis on the device.

TEMPLATE— Device is recognized but any information about the MIBs that this device supports is unknown.

CERTIFIED— Device has the highest level of certification and is discovered using enterprise MIBs as well as standard MIB-II data.

VALIDATED— Deprecated.

UNDISCOVERED— System is undiscovered.

CreationClassName

string

Name of the most-derived class of this instance.

Description

string

Textual description of the object.

DiscoveredFirstAt

string

Time when the first discovery probe of this System occurred.

DiscoveredLastAt

string

Time when the last discovery probe of this System occurred.

DiscoveryErrorInfo

string

Message describing the last discovery error for this System.

DiscoveryTime

string

Length of time it took for the last discovery probe of this System.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

Domain

string

Domain to which the system belongs.

Grouping1

string

NA

Grouping2

string

NA

Grouping3

string

NA

HasIPAddresses

boolean

NA

HasIPv6Addresses

boolean

NA

IsAddressable

boolean

Set to TRUE if the system is IP addressable.

IsDiscoveryInProgress

boolean

TRUE if Discovery in progress for this system.

IsEveryIPUnresponsive

boolean

NA

IsEveryIPv6Unresponsive

boolean

NA

IsEveryNeighborUnresponsive

boolean

NA

IsEverySNMPAgentUnresponsive

boolean

NA

 

IsManaged

boolean

Determines whether a given SystemElement should be monitored by the management system. An unmanaged object does not have associated instrumentation. This attribute is Read Only.

IsMightBeDown

boolean

NA

IsProxy

boolean

TRUE if this is a proxy of remote system.

IsProxyDown

boolean

TRUE if the proxy system is down.

IsProxyMightBeDown

boolean

TRUE if the system is unresponsive and on the edge.

IsProxyUnresponsive

boolean

TRUE if the system is unresponsive.

IsSeed

boolean

TRUE if the system is added as seed.

IsUnmanagedOrUnresponsive

boolean

NA

IsUnmanagedOrUnresponsive_internal

boolean

NA

IsUnresponsive

boolean

TRUE— Indicates that the system is not responding to ICMP pings or SNMP polls.

FALSE— Indicates that the system is responding to ICMP pings and/or SNMP polls.

IsUnresponsive_internal

boolean

NA

Location

string

Description of where this system is located.

LossProbability_Unresponsive

float

NA

Model

string

Name by which the system is generally known.

Name

string

Name of object

 

NameFormat

string

The ComputerSystem object and its derivatives are Top Level Objects of ICIM. They provide the scope for numerous components.

You must have unique System keys. A heuristic is defined to create the ComputerSystem Name to attempt to always generate the same Name, independent of discovery protocol.

This prevents inventory and management problems where the same asset or entity is discovered multiple times and cannot be resolved to a single object. Use of the heuristic is optional, but recommended.

The NameFormat property uses a heuristic to identify how the ComputerSystem Name is generated. The heuristic is described in the CIM V2 System Model specifications. It assumes that the documented rules are traversed in order, to determine and assign a name.

The NameFormat Values list defines the precedence order to assign the ComputerSystem Name. Several rules map to the same Value.

The ComputerSystem Name that is calculated, using the heuristic is the System's key value. You can assign other names, or aliases, for the ComputerSystem.

NumberOfInterfaces

unsigned-int

NA

NumberOfIPs

unsigned-int

NA

NumberOfIPv6s

unsigned-int

NA

NumberOfNetworkAdapters

unsigned-int

NA

NumberOfPorts

unsigned-int

NA

OSVersion

string

The software version of this system's operating system.

PrimaryOwnerContact

string

A string that provides information on how the primary system owner can be reached (e.g., phone number, e-mail address).

PrimaryOwnerName

string

The name of the primary owner of the ICIM_System.

ReadCommunity

string

The SNMP read community string.

RemoveComponents

boolean

Enable or disable component deletion functionality for ICIM_System instances. This is used by remove() function. Default value is set to FALSE.

Reserved1

string

Reserved attribute 1.

Reserved2

string

Reserved attribute 2.

 

ServiceName

string

Name of external server used for imported events and instrumented attributes.

SNMPAddress

string

Primary address used to contact the SNMP agent running on this system.

Note that if this system hosts more than one network address it may be possible that another address is currently being used to contact the agent.

SourceAddress

string

System level source address. All IP addresses that are hosted by the system use this address as source address. This is unless each IP address has its own source address.

SupportsSNMP

boolean

TRUE if this system can be managed using SNMP.

SystemName

string

The name of this ICIM_System object.

SystemObjectID

string

System Object Identifier associated with the vendor of this ComputerSystem.

Type

string

Classifies the ComputerSystem. This attribute is used primarily for display purposes only. The actual capabilities of a ComputerSystem are reflected in the LogicalDevices, Services, and ServiceAccessPoints related to it.

UseBridgingRelationship

boolean

TRUE to use Bridging relationship in correlation.

Vendor

string

Name of the system's supplier.

Processor

Capabilities and management of the Processor LogicalDevice.

CreationClassName

string

Name of the most-derived class of this instance.

CurrentUtilization

int

The current value of the Processor utilization as reported by the instrumentation. The utilization is reported as a percentage of the overall capacity of the Processor.

Description

string

Textual description of the object.

DeviceID

string

Address or other information to uniquely identify the LogicalDevice.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

IsManaged

boolean

Determines whether a given SystemElement should be monitored by the management system. An unmanaged object does not have associated instrumentation. This attribute is Read Only.

Name

string

Name of object

ServiceName

string

Name of external server used for imported events and instrumented attributes.

SystemName

string

The name of the ICIM_System containing this element.

Router

Router is a UnitaryComputerSystem that routes packets between computer networks. Routers operate at layer 3 of the OSI model.

AccessMode

string

Mode to access a system. It can have one of the following values: ICMPONLY, SNMPONLY, or ICMPSNMP.

AprioriProbability_Down

float

NA

BridgeAddress

string

Bridge address as defined in RFC1493.

Certification

string

Defines the level of certification that this device has in the Discovery process:

UNSUPPORTED— Deprecated.

GENERIC — OID for the device is not recognized and the device will be classified as GENERIC and added to the Node class. Standard MIB-II data is used to perform analysis on the device.

TEMPLATE— Device is recognized but any information about the MIBs that this device supports is unknown.

CERTIFIED —Device has the highest level of certification and is discovered using enterprise MIBs as well as standard MIB-II data.

VALIDATED— Deprecated.

UNDISCOVERED—System is undiscovered.

CreationClassName

string

Name of the most-derived class of this instance.

Description

string

Textual description of the object.

DesignatedRoot

string

Bridge identifier of the root of the spanning tree as determined by the Spanning Tree Protocol as executed by this Bridge. This value is used as the Root Identifier parameter in all Configuration Bridge PDUs originated by this node.

DesignatedRootPort

int

Port number of the port which offers the lowest cost path from this Bridge to the root Bridge.

DiscoveredFirstAt

string

Time when the first Discovery probe of this system occurred.

DiscoveredLastAt

string

Time when the last Discovery probe of this system occurred.

DiscoveryErrorInfo

string

Message describing the last Discovery error for this system.

DiscoveryTime

string

Length of time it took for the last Discovery probe of this System.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

Domain

string

Domain to which the system belongs.

Grouping1

string

NA

Grouping2

string

NA

Grouping3

string

NA

IsAddressable

boolean

Set to TRUE if the system is IP addressable.

IsDiscoveryInProgress

boolean

TRUE if discovery in progress for this system.

 

IsEveryIPUnresponsive

boolean

NA

IsEveryNeighborUnresponsive

boolean

NA

IsEverySNMPAgentUnresponsive

boolean

NA

IsManaged

boolean

Determines whether a given SystemElement should be monitored by the management system. An unmanaged object does not have associated instrumentation. This attribute is Read Only.

IsMightBeDown

boolean

NA

IsSeed

boolean

TRUE if the system is added as seed.

IsUnmanagedOrUnresponsive

boolean

NA

IsUnmanagedOrUnresponsive_internal

boolean

NA

IsUnresponsive

boolean

TRUE— Indicates that the system is not responding to ICMP pings or SNMP polls.

FALSE— Indicates that the system is responding to ICMP pings and/or SNMP polls.

IsUnresponsive_internal

boolean

NA

Location

string

Description of where this system is located.

LossProbability_Unresponsive

float

NA

Model

string

Name by which the system is generally known.

Name

string

Name of object

 

NameFormat

string

The ComputerSystem object and its derivatives are Top Level Objects of ICIM. They provide the scope for numerous components.

You must have unique System keys. A heuristic is defined to create the ComputerSystem Name to attempt to always generate the same Name, independent of discovery protocol.

This prevents inventory and management problems where the same asset or entity is discovered multiple times and cannot be resolved to a single object. Use of the heuristic is optional, but recommended.

The NameFormat property uses a heuristic to identify how the ComputerSystem Name is generated. The heuristic is described in the CIM V2 System Model specifications. It assumes that the documented rules are traversed in order, to determine and assign a name.

The NameFormat Values list defines the precedence order to assign the ComputerSystem Name. Several rules map to the same Value.

The ComputerSystem Name that is calculated, using the heuristic is the System's key value. You can assign other names, or aliases, for the ComputerSystem.

NumberOfInterfaces

unsigned-

int

NA

NumberOfIPs

unsigned-int

NA

NumberOfNetworkAdapters

unsigned-int

NA

NumberOfPorts

unsigned-int

NA

OSVersion

string

Software version of this system's operating system.

PrimaryOwnerContact

string

String that provides information on how the primary system owner can be reached (e.g., phone number, e-mail address).

PrimaryOwnerName

string

Name of the primary System owner.

ReadCommunity

string

SNMP read community string.

RemoveComponents

boolean

Enable or disable component deletion functionality for ICIM_System instances. This is used by remove() function. Default value is set to FALSE.

Reserved1.

string

Reserved attribute 1

Reserved2

string

Reserved attribute 2.

ServiceName

string

Name of external server used for imported events and instrumented attributes.

 

SNMPAddress

string

Primary address used to contact the SNMP agent running on this system.

Note that if this system hosts more than one network address it may be possible that another address is currently being used to contact the agent.

SourceAddress

string

System level source address. All IP addresses that are hosted by the system use this address as source address. This is unless each IP address has its own source address.

SupportsSNMP

boolean

TRUE if this system can be managed using SNMP.

SystemName

 

Name of this System object.

SystemObjectID

string

System Object Identifier associated with the Vendor of this ComputerSystem.

Type

string

Classifies the ComputerSystem. This attribute is used primarily for display purposes only. The actual capabilities of a ComputerSystem are reflected in the LogicalDevices, Services, and ServiceAccessPoints related to it.

UseBridgingRelationship

boolean

TRUE to use Bridging relationship in correlation.

Vendor

string

Name of the system's supplier.

SNMPAgent

SNMPAgent represents an SNMP agent running in a system. An SNMP agent implements one or more MIBs and provides access to the MIB data to SNMP management applications using the SNMP protocol.

AgentAddress

string

IP address currently used to contact this agent.

AgentAddressList

string

Comma-separated list of addresses to use in contacting this agent. This attribute is updated by the updateAgentAddressList() method. The address in the AgentAddress attribute is always first in the list. Other IP addresses that are Underlying this SNMPAgent are appended.

AprioriProbability_NotResponding

float

Apriori probability for problem NotResponding.

AuthPass

string

Authentication password of the user for this SNMP engine.

AuthProtocol

string

Indicates of whether messages sent on behalf of this user can be authenticated and the authentication protocol.

CreationClassName

string

Name of the most-derived class of this instance.

Description

string

Textual description of the object.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

EngineBoots

int

Count of the engine boots.

EngineBootTime

string

Time when the engine was last booted.

EngineID

string

ID which (at least within an administrative domain) uniquely and unambiguously identifies an SNMP engine.

HasFaultInstrumentedSAP

boolean

NA

 

IsManaged

boolean

Determines whether a given SystemElement should be monitored by the management system. An unmanaged object does not have associated instrumentation. This attribute is Read Only.

IsSystemUnresponsive

boolean

TRUE - Indicates that the system is not responding to ICMP pings or SNMP polls.

FALSE - Indicates that the system is responding to ICMP pings and/or SNMP polls.

Name

string

Name of object

PortNumber

unsigned-short

UDP port number at which the agent is listening.

PrivPass

string

Encryption password of the user for this SNMP engine.

PrivProtocol

string

Type of encryption protocol to be used.

ProbeSuccessful

boolean

Set to TRUE if this agent was able to be successfully probed by the discovery topology adapters.

ReadCommunity

string

SNMP read community string.

Reserved1

string

Reserved attribute 1.

Reserved2

string

Reserved attribute 2.

Responsive

boolean

Responsive is an internal attribute used in propagating to the System the responsive status of this Service.

SeedName

string

Name of this agent as originally specified for this agent. This is typically the name listed in a seed file.

ServiceKey

string

Unique value that distinguishes this Service from other Services within the scope of the containing system.

ServiceName

string

Name of external server used for imported events and instrumented attributes.

SNMPStatus

string

Current state of the SNMP agent as reported by the instrumentation.

SNMP agent objects are typically instrumented by issuing an SNMP GET request for commonly supported MIB variables (such as sysUpTime from RFC 1213).

OK — Agent is responding to SNMP requests.

AUTHFAIKURE—Authentication failure to SNMP request.

TIMEDOUT—Agent is not responding to SNMP requests but that the host system is responding to ICMP pings.

UNREACHABLE —Host system is not responding to ICMP pings.

OTHER—Unspecified failure occured.

UNKNOWN—Default value before the agent is polled.

 

SNMPVersion

string

SNMP protocol version (V1 or V2C) used to communicate with the agent. The value 'unknown_SNMP_version' is assigned to agents which do not support any of the above SNMP protocol versions.

Status

string

Current status of the Service. One of: RESPONSIVE, UNRESPONSIVE, or UNKNOWN.

supportsHCCounters

boolean

Set to TRUE if this agent supports RFC1573, which includes 64-bit counters for interface statistics.

SupportsSNMP

boolean

Set to TRUE if this agent was successfully contacted at least once using SNMP.

sysContact

string

String that provides information on how the system owner can be reached (e.g. phone number, e-mail address, ...).

sysDescr

string

Description of the system.

sysLocation

string

Description of where this system is located.

sysName

string

Administratively-assigned name for this managed node. By convention, this is the node's fully-qualified domain name.

sysObjectID

string

The vendor's authoritative identification of the network management subsystem contained in the entity.

This value is allocated within the SMI enterprises subtree (1.3.6.1.4.1) and provides an easy and unambiguous means for determining the object being managed.

SystemName

string

Name of the System hosting this Service.

TopologyUpdateInfo

struct[]

Table of topology information discovered through this agent.

User .

string

Name of the user

WriteCommunity

string

SNMP write community string.

Switch

Switch is a UnitaryComputerSystem that 'switches' packets, typically at wire speeds, between physically separate segments.

AccessMode

string

Mode to access a system. It can have one of the following values: ICMPONLY, SNMPONLY, or ICMPSNMP.

AprioriProbability_Down

float

NA

BridgeAddress

string

Bridge address as defined in RFC1493.

 

Certification

string

Defines the level of certification that this device has in the Discovery process:

UNSUPPORTED— Deprecated.

GENERIC — OID for the device is not recognized and the device will be classified as GENERIC and added to the Node class. Standard MIB-II data is used to perform analysis on the device.

TEMPLATE— Device is recognized but any information about the MIBs that this device supports is unknown.

CERTIFIED —Device has the highest level of certification and is discovered using enterprise MIBs as well as standard MIB-II data.

VALIDATED— Deprecated.

UNDISCOVERED—System is undiscovered.

CreationClassName

string

Name of the most-derived class of this instance.

Description

string

Textual description of the object.

DesignatedRoot

string

Bridge identifier of the root of the spanning tree as determined by the Spanning Tree Protocol as executed by this Bridge. This value is used as the Root Identifier parameter in all Configuration Bridge PDUs originated by this node.

DesignatedRootPort

int

Port number of the port which offers the lowest cost path from this Bridge to the root Bridge.

DiscoveredFirstAt

string

Time when the first Discovery probe of this system occurred.

DiscoveredLastAt

string

Time when the last Discovery probe of this system occurred.

DiscoveryErrorInfo

string

Message describing the last Discovery error for this system.

DiscoveryTime

string

Length of time it took for the last Discovery probe of this system.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

Domain

string

Domain to which the system belongs.

Grouping1

string

NA

Grouping2

string

NA

Grouping3

string

NA

IsAddressable

boolean

Set to TRUE if the system is IP addressable.

IsDiscoveryInProgress

boolean

TRUE if Discovery in progress for this system.

IsEveryIPUnresponsive

boolean

NA

IsEveryNeighborUnresponsive

boolean

NA

IsEverySNMPAgentUnresponsive

boolean

NA

 

IsManaged

boolean

Determines whether a given SystemElement should be monitored by the management system. An unmanaged object does not have associated instrumentation. This attribute is Read Only.

IsMightBeDown

boolean

NA

IsSeed

boolean

TRUE if the system is added as seed.

IsUnmanagedOrUnresponsive

boolean

NA

IsUnmanagedOrUnresponsive_internal

boolean

NA

IsUnresponsive

boolean

TRUE— Indicates that the system is not responding to ICMP pings or SNMP polls.

FALSE— Indicates that the system is responding to ICMP pings and/or SNMP polls.

IsUnresponsive_internal

boolean

NA

Location

string

Description of where this system is located.

LossProbability_Unresponsive

float

NA

Model

string

Name by which the system is generally known.

Name

string

Name of object

NameFormat

string

The ComputerSystem object and its derivatives are Top Level Objects of ICIM. They provide the scope for numerous components.

You must have unique System keys. A heuristic is defined to create the ComputerSystem Name to attempt to always generate the same Name, independent of discovery protocol.

This prevents inventory and management problems where the same asset or entity is discovered multiple times and cannot be resolved to a single object. Use of the heuristic is optional, but recommended.

The NameFormat property uses a heuristic to identify how the ComputerSystem Name is generated. The heuristic is described in the CIM V2 System Model specifications. It assumes that the documented rules are traversed in order, to determine and assign a name.

The NameFormat Values list defines the precedence order to assign the ComputerSystem Name. Several rules map to the same Value.

The ComputerSystem Name that is calculated, using the heuristic is the System's key value. You can assign other names, or aliases, for the ComputerSystem.

NumberOfInterfaces

unsigned-int

NA

 

NumberOfIPs

unsigned-int

NA

NumberOfNetworkAdapters

unsigned-int

NA

NumberOfPorts

unsigned-int

NA

OSVersion

string

Software version of this system's operating system.

PrimaryOwnerContact

string

String that provides information on how the primary system owner can be reached (e.g., phone number, e-mail address).

PrimaryOwnerName

string

Name of the primary system owner.

ReadCommunity

string

SNMP read community string.

RemoveComponents

boolean

Enable or disable component deletion functionality for ICIM_System instances. This is used by remove() function. Default value is set to FALSE.

Reserved1

string

Reserved attribute 1.

Reserved2

string

Reserved attribute 2.

ServiceName

string

Name of external server used for imported events and instrumented attributes.

SNMPAddress

string

Primary address used to contact the SNMP agent running on this system.

Note that if this System hosts more than one network address it may be possible that another address is currently being used to contact the agent.

SourceAddress

string

System level source address. All IP addresses that are hosted by the system use this address as source address. This is unless each IP address has its own source address.

SupportsSNMP

boolean

TRUE if this system can be managed using SNMP.

SystemName

string

Name of this System object.

SystemObjectID

string

System Object Identifier associated with the vendor of this ComputerSystem.

Type

string

Classifies the ComputerSystem. This attribute is used primarily for display purposes only. The actual capabilities of a ComputerSystem are reflected in the LogicalDevices, Services, and ServiceAccessPoints related to it.

UseBridgingRelationship

boolean

TRUE to use Bridging relationship in correlation.

Vendor

string

Name of the system's supplier.

TempratureSensor

Refines NumericSensor with qualities specific to a TemperatureSensor.

CreationClassName

string

Name of the most-derived class of this instance.

CurrentValue

int

Current value of the TemperatureSensor test point, in degrees C, as reported by the instrumentation.

Description

string

Textual description of the object.

DeviceID

string

Address or other information to uniquely identify the LogicalDevice.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

HighThreshold

float

Current value of the TemperatureSensor's upper threshold, in degrees C, as reported by the instrumentation.

IsManaged

boolean

Determines whether a given SystemElement should be monitored by the management system. An unmanaged object does not have associated instrumentation. This attribute is Read Only.

Name

string

Name of object

ServiceName.

string

Name of external server used for imported events and instrumented attributes

Status

string

Current state of the TemperatureSensor test point as reported by the instrumentation.

SystemName

string

Name of the ICIM_System containing this element.

VoltageSensor

Redefines NumericSensor qualities specific to a VoltageSensor.

CreationClassName

string

Name of the most-derived class of this instance.

CurrentValue

float

Current value of the VoltageSensor test point, in Volts, as reported by the instrumentation.

Description

string

Textual description of the object.

DeviceID

string

Address or other information to uniquely identify the LogicalDevice.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

HighThreshold

float

Current high threshold value of the VoltageSensor test point, in Volts, as reported by the instrumentation.

IsManaged

boolean

Determines whether a given SystemElement should be monitored by the management system. An unmanaged object does not have associated instrumentation. This attribute is Read Only.

LowThreshold

float

Current low threshold value of the VoltageSensor test point, in Volts, as reported by the instrumentation.

Name

string

Name of object

 

ServiceName

string

Name of external server used for imported events and instrumented attributes.

Status

string

Current state of the VoltageSensor test point as reported by the instrumentation.

SystemName

string

Name of the ICIM_System containing this element.

VLAN

VLAN represents a 'virtual LAN'. Such LANs are typically implemented in switched network environments.

CreationClassName

string

Name of the most-derived class of this instance.

Description

string

Textual description of the object.

DisplayClassName

string

String shown in the GUI when this object's class is displayed.

DisplayName

string

String shown in the GUI when this object's name is displayed.

IsManaged

boolean

Determines whether a given SystemElement should be monitored by the management system. An unmanaged object does not have associated instrumentation. This attribute is Read Only.

MembershipCriteria

string

Membership criteria for participation in this VLAN.

Name

string

Name of object

Reserved1

string

Reserved attribute 1.

Reserved2

string

Reserved attribute 2.

ServiceName

string

Name of external server used for imported events and instrumented attributes.

SystemName

string

Name of the System containing this element.

VLANKey

string

A unique value that distinguishes this VLAN from all other VLANs.

VLANNumber

unsigned-int

Number that identifies the VLAN. This number is not guaranteed to be unique across all VLANs, but is unique across all VLANs within a given VLAN domain.


Clearing an Event

You can manually clear events. To do this:


Step 1 From the Event Description window, select the event and click Clear to remove the event from DFM. 

You are prompted to confirm if you want to clear the event.

Step 2 Enter your user ID. This will be used as a reference to identify who cleared the event.

Step 3 Click OK to confirm and clear the event

or

Click Cancel to retain the event.

The event description window shows that the event was cleared.


Getting Device Information (Detailed Device View)

The Detailed Device View (DDV) provides extensive information on the devices and device components listed in Starting the Detailed Device View.

You can view information on devices that DFM is currently managing, as well as devices whose management you have suspended (regardless of whether the device is generating an alert):

View hardware and software information on system, environment, and interface components (including port VLAN information)

View hardware and software information on subcomponents of aggregate devices. For example, Multilayer Switch Feature Cards (MSFCs) on switches.

Suspend or resume management of a device or a device component so the device or component s no longer polled, or polling is resumed

See these topics for more information:

Starting the Detailed Device View

Understanding the Detailed Device View

Managing/Unmanaging a Single Device Component

Starting the Detailed Device View

You can open a DDV for any device in the Alerts and Activities page—or for any known device in the DFM inventory (regardless of whether it is currently managed).

You cannot display a DDV for unidentified trap devices. For more information on unidentified traps, refer to Processed and Pass-Through Traps, and Unidentified Traps and Events


Step 1 Open the DDV as follows:

For any known device, from the DFM home page, select Device Management > View Device Details and click the device link.

For devices with alerts, click the device link in the Alerts and Activities display Device Name column.

The DDV opens. See Figure 3-6 for an example.

Step 2 Select an instance from the device tree.

The details table is populated.

If the item you select is the subdevice of an aggregated device—for example, an MSFC/RSM in a switch—the DDV will show the subdevice's managed state and device capability.

To display a complete DDV of the subcomponent, click Launch New DDV For This Device.

If you want to suspend a managed device so it is no longer polled and its traps are no longer processed or if you want to resume a suspended device:

Click Suspend to change the device's managed state to Suspended.

DFM no longer polls any device components, nor does it process any traps.

All alerts and activities change to the Cleared state, and the device is moved to the Suspended Devices view. Subsequent events (including traps) are ignored and no longer processed.

Click Resume to change the device's managed state to Active.

DFM resumes polling and trap processing on the device, and the device is moved out of the Suspended Devices view and back into its previous view.

If you resumed any devices and if you have completed your monitoring status changes, select Configuration > Polling and Thresholds > Apply Changes from the DFM home page so that DFM will resume polling according to the polling and threshold settings for the device.

Since this action is CPU-intensive, wait until you have made all of your monitoring status changes before you apply them.


Figure 3-6 provides an example of device information for a Cisco 3745 router.

Figure 3-6 Detailed Device View—Cisco 3745 Router

1

Component categories pane. See Component Categories Pane.

4

Command button area. See Command Buttons Area.

2

System information pane. See System Information Pane.

5

Launch information area. See Launch Information.

3

Record count. See Record Count.

 

Understanding the Detailed Device View

To understand the Detailed Device View, see the following topics:

Component Categories Pane

System Information Pane

Record Count

Command Buttons Area

Launch Information

Component Categories Pane

The component categories pane lists the components of the device: Environment, System, and Interface (what is shown depends on the device being viewed). The following are some examples of what you may see in these categories:

Environment: Temperature, fan, power supply, voltage information

System: Hard disk, RAM, processor, memory information

Interface: Interface, port, card information; IP addresses on the device


Note Avoid using non US (eg.8 bit ASCII) characters in the description of an Interface. If you use these characters in an interface description, an error occurs when you try to change the managed state of a device in the Detailed Device View page.


From a DDV for an aggregate (containing) device, you can launch a DDV for the contained device. For example, for a router containing MSFCs, open a DDV for the router. From the router DDV, you can launch a new DDV for the MSFC.

System Information Pane

The system information pane provides information such as the system name, IP address, SysObjectID, system contact, and so forth. The device type determines what is displayed by the DDV.

If the system information pane lists an attribute with no value, it is because of one of the following reasons:

The attribute is not populated.

The attribute is not configured correctly.

The attribute does not apply to the device.

If the current view is of a parent (or containing) device—for example, a Catalyst 6513 switch with an MSFC card—the System Information Pane will contain a button, Launch New DDV For This Device button. If you click that button, a DDV for the MSFC is displayed.

You can suspend or resume device or component monitoring by clicking the Suspend or Resume button (The button shown depends on the component's current managed state). These functions are described in these sections:

Suspending and Resuming Devices

Managing/Unmanaging a Single Device Component

Record Count

The record count lists the number of information types available on the device.

Command Buttons Area

In addition to the Suspend and Resume buttons in the system information pane, the Command Button area provides other ways to respond to alerts.

Table 3-6 Detailed Device View—Command Buttons

Button
Action

Get Troubleshooting Info

Launches a CiscoWorks Assistant Troubleshooting Report, which helps identify the cause of a device being unreachable. (For more information, see the User Guide for CiscoWorks Assistant 1.1.)

Refresh

Refreshes the DDV page. (The DDV is not automatically refreshed; you must do so manually.)

Close

Closes the DDV page.


Launch Information

The launch information tells you when the DDV was started. If you refresh the page, the time is updated.

Managing/Unmanaging a Single Device Component

You can unmanage or remanage device components using the DDV (cards, interfaces, ports, IP addresses, and so forth). If you unmanage a component, DFM will ignore subsequent events (including traps).


Note You cannot resume a device component if the parent device is suspended. You must resume the parent device first. If a parent device is suspended, the device components are also suspended.



Step 1 From the Alerts and Activities display, click a device in the Device Name column.

The DDV opens.

Step 2 Select the component with the instance you want to unmanage or manage.

Step 3 Locate the instance you want to unmanage or manage, and make your change using the list in the ManagedState column.

Note that:

You can change the unmanaged state of an IP component of a device to managed state, only if its underlying interface is in a managed state.

You cannot change the state of a management IP because it is not displayed in the DDV page.

You can place the cursor on Details to see the Interface/Port details of a specific device. This option is available only for Port and Interface components. See Figure 3-8 for more information.

Figure 3-7 is an example where the management IP 10.77.210.189 is not displayed in the DDV page. This is to prevent you from accidentally unmanaging the management IP.

Figure 3-7 Example of a Management IP not Displayed in the DDV page

You cannot unmanage the interface of the management IP. Its status is static and there is no option to unmanage it.

Figure 3-8 is an example where the Managed State of the IP 13.0.1.4 is displayed as True. You can manage or unmanage the other interfaces but not the interface of the IP 13.0.1.4.

Figure 3-8 Example Displaying the Static Managed State of a Management IP

Step 4 Click Submit.

If you resumed any devices (and you are finished making all of your monitoring status changes), select Configuration > Polling and Thresholds > Apply Changes from the DFM home page. This causes DFM to resume polling according to the polling and threshold settings for the device.

Since this action is CPU-intensive, wait until you have made all of your monitoring status changes before you apply them.


Managing Interfaces with ONDEMAND mode

Interfaces with ONDEMAND mode are not managed by default.

To manage them using the dmctl CLI command, enter:

get Ethernet_Performance_Setting:: "Thresholds setting group" ::AnalysisModeOfSubInterfacePerformance ENABLED

invoke ICF_PolicyManager::ICF-PolicyManager reconfigure

For example: get Ethernet_Performance_Setting:: "SET-CFG-Interface Groups/1 Gb Ethernet/Ethernet_Performance_Setting" ::AnalysisModeOfSubInterfacePerformance ENABLED

invoke ICF_PolicyManager::ICF-PolicyManager reconfigure

Suspending Device and Element Monitoring

You can stop monitoring a device by selecting it and clicking the Suspend button in the DDV. Conversely, you can resume monitoring by clicking the Resume button.

See these topics for more information:

Suspending and Resuming Devices

Performing Bulk Manage and Unmanage Operations

Suspending and Resuming Devices

When you unmanage a device (changing its managed state to False) DFM no longer polls that device for information. Subsequent events (including traps) are ignored and no longer processed.

When you suspend a device, all of the active events on the device are moved to the Cleared state, but the alert remains in the Active state. This happens to ensure that:

You cannot mistakenly remove important information from the display when you suspend a device (When alerts are cleared, they are removed from the Alerts and Activities display).

You can easily resume the device.


Note Your login determines whether you can perform this operation.



Step 1 From the Alerts and Activities display, start the view that contains your device. Devices not managed will be in the Suspended Devices view.

The DDV opens. Depending upon the managed state of the device, either the Suspend or the Resume button is shown.

Step 2 Click either:

Suspend to change the device's current managed state to Suspended.

DFM no longer polls any device components, nor does it process any traps. All alerts and activities change to the Cleared state, and the device is moved to the Suspended Devices view. Subsequent events (including traps) are ignored and no longer processed.

Or

Resume to change the device's current managed state to Active.

DFM resumes polling and trap processing on the device, and the device is moved out of the Suspended Devices view and back into its previous view.

If you resumed any devices (and you are finished making all of your monitoring status changes), select Configuration > Polling and Thresholds > Apply Changes from the DFM home page. This causes DFM to resume polling according to the polling and threshold settings for the device.

Since this action is CPU-intensive, wait until you have made all of your monitoring status changes before you apply them.


Performing Bulk Manage and Unmanage Operations

You can use ASL scripts to perform bulk manage and unmanage operations of interfaces, ports, IP addresses, processors, and memory, as described in this topic.

You can create and edit a generated file so that it reflects the management state you want. Later you can apply the change to the DFM inventory, so that DFM will use your new settings when gathering device information.

In the following procedures, NMSROOT represents the CiscoWorks installation directory. By default, these directories are:

Solaris: /opt/CSCOpx

Windows: C:\Progra~1\CSCOpx (which stands for C:\Program Files\CSCOpx)


Step 1 Depending on your platform, run one of the following scripts to create the generated files that are necessary for the operation:

Operating System/Element
Command
Solaris

Interfaces/Ports

NMSROOT/objects/smarts/utils/getStateIntPort.ksh

IP Addresses

NMSROOT/objects/smarts/utils/getStateIP.ksh

Processor

NMSROOT/objects/smarts/utils/getStateProc.ksh

Memory

NMSROOT/objects/smarts/utils/getStateMem.ksh

Windows

Interfaces/Ports

NMSROOT\objects\smarts\utils\getStateIntPort.bat

IP Addresses

NMSROOT\objects\smarts\utils\getStateIP.bat

Processor

NMSROOT\objects\smarts\utils\getStateProc.bat

Memory

NMSROOT\objects\smarts\utils\getStateMem.bat


Step 2 Open the appropriate generated file:

Operating System/Element
Command
Solaris

Interfaces

NMSROOT/objects/smarts/local/logs/expInterface.log

NMSROOT/objects/smarts/local/logs/expInterface1.log

Ports

NMSROOT/objects/smarts/local/logs/expPort.log

NMSROOT/objects/smarts/local/logs/expPort1.log

IP Addresses

NMSROOT/objects/smarts/local/logs/expIP.log

NMSROOT/objects/smarts/local/logs/expIP1.log

Processor

NMSROOT/objects/smarts/local/logs/expProc.log

NMSROOT/objects/smarts/local/logs/expProc1.log

Memory

NMSROOT/objects/smarts/local/logs/expMem.log

NMSROOT/objects/smarts/local/logs/expMem1.log

Windows

Interfaces

NMSROOT\objects\smarts\local\logs\expInterface.log

NMSROOT\objects\smarts\local\logs\expInterface1.log

Ports

NMSROOT\objects\smarts\local\logs\expPort.log

NMSROOT\objects\smarts\local\logs\expPort1.log

IP Addresses

NMSROOT\objects\smarts\local\logs\expIP.log

NMSROOT\objects\smarts\local\logs\expIP1.log

Processor

NMSROOT\objects\smarts\local\logs\expProc.log

NMSROOT\objects\smarts\local\logs\expProc1.log

Memory

NMSROOT\objects\smarts\local\logs\expMem.log

NMSROOT\objects\smarts\local\logs\expMem1.log


Step 3 Edit the generated file to reflect one of the following states:

MANAGED_STATE:EXPLICITLY_MANAGED

MANAGED_STATE:EXPLICITLY_UNMANAGED

Step 4 Set and apply your state changes so DFM will collect the proper device information

Operating System/Element
Command
Solaris

Interfaces/Ports

NMSROOT/objects/smarts/utils/setStateIntPort.ksh

IP Addresses

NMSROOT/objects/smarts/utils/setStateIP.ksh

Processor

NMSROOT/objects/smarts/utils/setStateProc.ksh

Memory

NMSROOT/objects/smarts/utils/setStateMem.ksh

Windows

Interfaces/Ports

NMSROOT\objects\smarts\utils\setStateIntPort.bat

IP Addresses

NMSROOT\objects\smarts\utils\setStateIP.bat

Processor

NMSROOT\objects\smarts\utils\setStateProc.bat

Memory

NMSROOT\objects\smarts\utils\setStateMem.bat


:


The following example shows a session in which you can perform a bulk unmanage on interfaces.

# /opt/CSCOpx/objects/smarts/utils/getStateIntPort.ksh
Get Managed state for interfaces from DfmServer
MAIN-N-Closing this log file at 13-Jan-2007 19:05:45; continuing in
    /opt/CSCOpx/objects/smarts/local/logs/expInterface.log
Get Managed state for Ports from DfmServer
MAIN-N-Closing this log file at 13-Jan-2007 19:05:49; continuing in
    /opt/CSCOpx/objects/smarts/local/logs/expPort.log

# cd /opt/CSCOpx/objects/smarts/local/logs

You can open the exp.Interface.log file and locate the interfaces to be unmanaged:

INTERFACE:IF-12.9.150.46/2 MANAGED_STATE:MANAGED
INTERFACE:IF-12.9.150.76/5 MANAGED_STATE:MANAGED
INTERFACE:IF-12.9.150.63/2 MANAGED_STATE:MANAGED
...

You can change the MANAGED_STATE value:

INTERFACE:IF-12.9.150.46/2 MANAGED_STATE:EXPLICITLY_UNMANAGED
INTERFACE:IF-12.9.150.76/5 MANAGED_STATE:EXPLICITLY_UNMANAGED
INTERFACE:IF-12.9.150.63/2 MANAGED_STATE:EXPLICITLY_UNMANAGED
...

# /opt/CSCOpx/objects/smarts/utils/setStateIntPort.ksh
Set Managed state for interfaces for DfmServer
MAIN-N-Closing this log file at 13-Jan-2007 19:12:18; continuing in
    /opt/CSCOpx/objects/smarts/local/logs/intfOut.log
Set Managed state for Ports for DfmServer
MAIN-N-Closing this log file at 13-Jan-2007 19:12:22; continuing in
    /opt/CSCOpx/objects/smarts/local/logs/portOut.log
Apply changes and reconfigure on DfmServer
MAIN-N-Closing this log file at 13-Jan-2007 19:12:33; continuing in
    /opt/CSCOpx/objects/smarts/local/logs/apply.log

Acknowledging, Annotating, and Sending E-Mail Notifications of Alerts

As shown in Figure 3-4, the Alerts and Activities Detail page provides command buttons in the bottom-right corner of the page. The Suspend button is discussed in Suspending Device and Element Monitoring. This section explains how you can use the Acknowledge, Annotate, and Notify buttons to respond to alerts. It contains:

Acknowledging an Alert

Annotating an Alert

Sending E-Mail in Response to an Alert

Acknowledging an Alert

Acknowledging an active alert signals other users that are aware of the alert. When you click Acknowledge, this status change is populated to all Alerts and Activities displays.

If an event on the alert recurs, the event status reverts to Active.


Step 1 From the Alerts and Activities display page, check the checkbox of the alert that you need to acknowledge.

Step 2 Click Acknowledge.

A confirmation window opens.

Step 3 Click OK.


You can acknowledge multiple alerts with a single click from the Alerts and Activities display page.


Step 1 From the Alerts and Activities display page, check the checkboxes of alerts that you need to acknowledge.

Step 2 Click Acknowledge.

A confirmation window opens.

Step 3 Click OK.


You can also acknowledge alerts from the Alerts and Activities Detail page.


Step 1 From the Alerts and Activities display page, click the alert that you need to acknowledge.

Alerts and Activities Detail page displays the alert details.

Step 2 Click Acknowledge.

A confirmation window opens.

Step 3 Click OK.


Annotating an Alert

You can annotate an alert by clicking Annotate from the Alerts and Activities Detail page. An editable Annotation dialog box opens; in the dialog box, you can enter up to 255 characters. An annotation will be shown whenever other users view the alert from an Alerts and Activities Detail page.


Step 1 From the Alerts and Activities Detail page, click Annotate.

The Annotation dialog box opens.

Step 2 Enter your text.

Text that exceeds 255 characters will be truncated without warning. If this happens, you can add another annotation.

Step 3 Click OK.

The annotated text is displayed in the Notes box.


Figure 3-9 shows the Alerts and Activities Detail page, containing a previously created annotation.

Figure 3-9 Annotation on the Alerts and Activities Detail Page

Sending E-Mail in Response to an Alert

When you click the Notify button on the Alerts and Activities Detail page, DFM opens a dialog box that you can complete to manually send an e-mail notification to multiple recipients. The e-mail notification contains the text you add with any alert or event information.

If you want to send automatic e-mail notifications when alerts or events occur on certain devices, use Notification Services to set up an E-mail Notification subscription. See Managing E-Mail Configurations.

CiscoWorks Common Services controls the SMTP server used by DFM. For more information, from the Common Services home page, select Server > Admin > System Preferences, and click Help.


Step 1 From the Alerts and Activities Detail page, click Notify.

The E-mail Notification Recipients dialog box opens.

Step 2 In the E-mail Notification Recipients dialog box:

a. Select your SMTP server by doing one of the following:

Click the SMTP Server button and select the SMTP server you want to use.

Enter a fully qualified DNS name or IP address for an SMTP server.

b. Click the Domain Names button and select the domain you want to use.

c. Enter your e-mail address in the Sender Address field.

d. Enter a comma-separated list of e-mail addresses in the Recipient Address(es) field.

e. Enter a subject heading in the Header field.

f. (Optional) Enter a message in the Message field.

g. Click Send.