cim events use and implementation - dmtf · cim events use and implementation denise eckstein...

CIM EventsCIM EventsUse and ImplementationUse and Implementation

Denise EcksteinHewlett-Packard

Wednesday 1:30 - 2:45 pm

DMTF 2002 Developers' Conference June 10-13, 2002

OutlineOutline

• Overview– Terminology– Architecture Components

• Subscription• Delivery• CIM Event v2.7 Extensions


TerminologyTerminology

• Indication. The representation of the occurrence of an event.

• Subscription. The process of registering to receive Indications.

• Filter. The definition of a set Indications of interest.

• Delivery. The process of transporting one or more indications to a designated destination. The intended protocol and destination are specified as part of the subscription definition.

• Client. A process that creates subscriptions.

Indication, Subscription Generation & Delivery

CIMListener

Indication Receipt & Consumption

Subscription

Client(Subscription)

CIM-XM

LIndication H

andler

Resource

Indication Provider

CIMOM

CIM Server

Subscription

2IndicationDelivery

4

IndicationHandler

IndicationProvider

Export Indication(CIM-XML)


ComponentsComponents

IndicationDelivery

4

CIM-XM

LIndication H

andler

Resource

Indication Provider

CIMOM

CIM Server

Indication Subscription,

Generation & DeliveryCIM Listener


Indication Consumer

(Management Application)

ExportIndication

(CIM-XML)

Indication Provider

Registration

1A

IndicationGeneration &Processing

3

IndicationReceipt

5

IndicationConsumption

6


Subscription

2

CIM ListenerModule

IndicationConsumer

Registration

1B



CIM-XM

LIndication H

andler

Resource

Indication Provider

CIMOM

CIM Server


Generation & DeliveryCIM Listener


Indication Consumer


ExportIndication

(CIM-XML)


Subscription

2

CIM ListenerModule


DMTF SpecificationsDMTF Specifications

• CIM Event Module v2.6– Correct CIM_IndicationHandlerCIMXML Class Name (CR619)

• CIM Event Module v2.7– Add Error Handling Semantics to CIM_IndicationSubscription

(CR647)– Add Persistence Semantics to CIM_IndicationSubscription and

CIM_IndicationHandler (CR650)– Add Repeat Indication Handling Semantics to

CIM_IndicationSubscription (CR651)– Add Repeat Indication Semantics to CIM_ProcessIndication

(CR652)


CIM Event Model 2.6CIM Event Model 2.6

CIM_IndicationFilter

Caption: stringDescription: stringSystemCreationClassName: [key] stringSystemName: [key] stringCreationClassName: [key] stringName: [key] stringSourceNamespace: [required] stringQuery: [required] stringQueryLanguage: [required] string

CIM_IndicationHandlerCIMXML

Destination: [required] string

CIM_IndicationHandler (Abstract)

Caption: stringDescription: stringSystemCreationClassName: [key] stringSystemName: [key] stringCreationClassName: [key] stringName: [key] stringOwner: string

Filter: CIM_IndicationFilter REFHandler: CIM_IndicationHandler REF

* *

What to Send How & Where to Send

CIM_IndicationSubscription (Association)


CIM Event Model 2.6CIM Event Model 2.6

AlertType: uint16 [Override Default = 7]IndObject: string [Embedded Object, Required]

CIM_InstIndication (Abstract)

SourceInstance: string [EmbeddedObject, Required]

CIM_InstCreation

CIM_InstDeletion

CIM_InstModification

PreviousInstance: string [EmbeddedObject, Required]

CIM_InstMethodCall

MethodName: string [Required]MethodParameters: string [EmbeddedObject]ReturnValue: stringPreCall: boolean [Required]

CIM_InstRead

CIM_ClassIndication (Abstract)

ClassDefinition: string [EmbeddedObject, Required]

CIM_ClassCreation

CIM_ClassModification

PreviousClassDefinition: string [EmbeddedObject,

Required]

CIM_ClassDeletion

CIM_SNMPTrapIndication

Enterprise: stringAgentAddress: stringGenericTrap: uint16[Enum]SpecificTrap: uint32TimeStamp: datetimeVarBindNames[]: stringVarBindSyntaxes[]: uint16VarBindValues[]: string

CIM_ProcessIndication (Abstract)

CIM_AlertIndication

Description: stringAlertingManagedElement: stringAlertType: uint16 [Required, Enum]OtherAlertType: stringPerceivedSeverity: uint16 [Required, Enum]OtherSeverity: stringProbableCause: uint16 [Required, Enum]ProbableCauseDescription: stringTrending: uint16[Enum]AlertIdentifier: stringCorrelatedAlerts: string[]RecommendedActions: string[]

ThresholdIdentifier: stringThresholdValue: stringObservedValue: string

CIM_AlertInstIndication

CIM _Indication (Abstract)

IndicationTime:datetimeWhat’s Available

CIM_ThresholdIndication


Model ExtensionsModel Extensions

Description: stringAlertingManagedElement: stringAlertType: uint16 [Required, Enum]OtherAlertType: stringPerceivedSeverity: uint16 [Required, Enum]OtherSeverity: stringProbableCause: uint16 [Required, Enum]ProbableCauseDescription: stringTrending: uint16[Enum]AlertIdentifier: stringCorrelatedAlerts: string[]RecommendedActions: string[]

SystemIPAddress: stringSystemModelNumber:stringOSVersion:stringSystemSerialNumber: :stringSystemSoftwareID:MonitorID: stringMonitorProductVersion: stringEventClass: stringMonitorEventID: uint1

DetectionTime: datetimeSystemShutdownTime: uint16UPSShutOffTime: uint16UPSttyPath: stringUPSStatusCode: uint16UPSFirmwareVersion: stringBatteryVoltage: uint16UPSInternalOperatingTemperature: uint16UPSACOperatingFrequency; uint16ACInputVoltage: uint16ACOutputVoltage: uint16LoadPower: uint16RemainingRuntimeReserve: unit16UnitType: stringRatedInputVoltage:uint16NominalFrequency: unit16RatedVA: unit16OutputVoltage: uint16Phase: uint16

ACME_AlertIndication

ACME_UPSAlertIndication

CIM_AlertIndication

CIM_ProcessIndication (Abstract)

What’s Available from ACME


SubscriptionsSubscriptionsUse Model 1: Subscriptions are created when the system is deployed. Indication delivery is viewed as a critical component of a remote support service that offers a guaranteed level of availability. The expectation is that the subscriptions “exist” for the life of the system. Subscriptions must be explicitly deleted.

System Deployment Requirements•System configured with a pre-defined set of subscriptions that monitor supported hardware and software components.

CIM Listener

CIM ServerManaged Node

CIM-XN

LIndication H

andler

Resource

Indication Provider

CIMOM

Export Indication(CIM-XML)

Indication Consumer

(e.g.,Remote Support Service)

CIM Listener Protocol Handler


Subscription

2

IndicationDelivery

4


SubscriptionsSubscriptionsUse Model 2: Subscriptions are defined and removed as part of an interactive monitoring session with an “end user.” The client application creates the subscriptions as well as serves as the Indication consumer. The expectation is that the subscriptions “exist” only while the client session is active. A subscription should be automatically deleted when the client application terminates.


CIM-XN

LIndication H

andler

Resource

Indication Provider

CIMOM

CIM Listener

Indication Consumer(e.g. Event Browser)


ExportIndication(CIM-XML)

IndicationDelivery

4

Subscription

2

CreateInstance(CIM-XML)


SubscriptionsSubscriptionsUse Model 3: Subscriptions provide a service and are created, renewed and deleted based on the terms of a lease. The expectation is that a subscription “exists” for the duration of time specified by the lease. An “expiration date” is associated with each subscription and a “renewal” would consist of updating the expiration date. A subscription should be automatically deleted when the expiration date has passed.

CIM Listener

Indication Consumer(e.g., Stock

Ticker)



CIM-XN

LIndication H

andler

Resource

Indication Provider

CIMOMExport Indication

(CIM-XML)

IndicationDelivery

4

Subscription

2

Create Instance(CIM-XML)


ExampleExampleSubscription Example: Create a subscription to send any critical UPS alert indications for device “tty0p1” on system “server001.acme.com” using CIM-XML to URL “server006.acme.com/cimom/EB”.

CIM Listener

Indication Consumer


CIM-XM

LIndication H

andler

UPSdev/tty0p1

Indication Provider

CIMOM

server001.acme.comIndication

Subscription, Generation & Delivery


server006.acme.com

/cimom

/EB

Subscription Hierarchy

Indication Hierarchy

Indication (Abstract)

InstIndication (Abstract)

ClassIndication(Abstract)

ProcessIndication(Abstract)





* *

server006.acme.comIndication Receipt &

Consumption

Critical Problem with UPS Device Detected

UPS AlertExport Indication

(CIM-XML)


SubscriptionSubscription


Caption: stringDescription: stringSystemCreationClassName: [key] stringSystemName: [key] stringCreationClassName: [key] stringName: [key] stringSourceNamespace: [required] stringQuery: [required] stringQueryLanguage: [required] string


Destination: [required] string


Caption: stringDescription: stringSystemCreationClassName: [key] stringSystemName: [key] stringCreationClassName: [key] stringName: [key] stringOwner: string

Filter: CIM_IndicationFilter REFHandler: CIM_IndicationHandler REF

* *

What to Send How & Where to Send


Create Handler Instance

2a

Create Filter Instance

2b

Create Subscription Instance

2b

Subscription

2


Indication HandlerIndication Handler

server001.acme.comSystemNameKey

server006.acme.com/cimom/EBDestinationRequired

EventAdminOwner

ACMESubscription12345NameKey

CIM_IndicationHandlerCIMXMLCreationClassNameKey

CIM_UnitaryComputerSystemSystemCreationClassNameKey

Location of Acme Event Browser responsible for monitoring hardware events for this system.

Description

Acme Hardware Event BrowserCaption

ValueProperty NameCIM_IndicationHandlerCIMXML

CIM Listener

Indication Consumer


server006.acme.comIndication Receipt &

Consumption

How & Where to Send


Indication FilterIndication Filter

WQLQueryLanguageRequired

SELECT *FROM ACME_UPSAlertIndicationWHERE PerceivedSeverity = Critical AND

UPSttyPath = “/dev/tty0p1”

QueryRequired

server001.acme.comSystemNameKey

root/cimv2SourceNamespace

ACMESubscription12345NameKey

CIM_IndicationFilterCreationClassNameKey

CIM_UnitaryComputerSystemSystemCreationClassNameKey

Filter used by ACME to generate critical UPS alerts for device ‘tty0p1’. This indication will return all properties associated with the class ACME_UPSAlertIndication.

Description

Generate critical UPS alerts for /dev/tty0p1

Caption

ValueProperty Name


IndicationProvider

CIMOM

CIM Server



What to Send



IndicationProvider

CIMOM

CIM Server




Class Name = CIM_IndicationHanlderCIMXMLKey Binding = SystemCreateClassName = “CIM_UnitaryComputerSystem”, SystemName = “server001.acme.com”, CreationClassName = “CIM_IndicationHandlerCIMXML, Name = “ACMESubscription12345”

Handlerkey

Class Name = CIM_IndicationFilterKey Binding = SystemCreateClassName = “CIM_UnitaryComputerSystem”, SystemName = “server001.acme.com”, CreationClassName = “CIM_IndicationFilter, Name = “ACMESubscription12345”

Filterkey

Value <instanceName)Property NameCIM_IndicationSubscription


CIM Server

Resource

CIM Operation Processor

Indication Service

Provider Manager

Registration Data

Indication Provider

CIM OperationMessage


CIM-XM

LIndication H

andler

Resource

Indication Provider

CIMOM

CIM Server

Indication Subscription, Generation & Delivery


Subscription Data

Subscription Management Operations

Indi

catio

n

Indication Handler Manager

CIM-XMLIndication Handler


Indication

Subscription

2

IndicationDelivery

4

HTTP Server



IndicationDelivery

4

CIM Listener


Indication Consumer


ExportIndication

(CIM-XML)

CIM-XM

LIndication H

andler

Resource

Indication Provider

CIMOM

CIM Server


Generation & Delivery


CIM ListenerModule



• CIM Operations over HTTP 1.1Representation of CIM in XML 2.1– CIM-XML Indication Delivery Specification (CR 605)– Add Indication Delivery Example to Appendix (CR 653)– Add Subscription Example to Appendix (CR 708)


CIM ListenerCIM Listener

A CIM Message is a well-defined request or response data packet used to exchange information between CIM Applications. There are two types of CIM Messages, CIM Operation Messages and CIM Export Messages.

•A CIM Operation Message is a CIM Message used to invoke an operation on the target CIM namespace.•A CIM Export Message is a CIM Message used to communicate information about a CIM namespace or element that is foreign to the target. A CIM Export Message is informational only and does not define an operation on the target CIM namespace or even imply the existence of a target namespace.

CIM Message

CIM Operation CIM Export

SimpleReqSimpleRespMultiReqMultiResp

SimpleExpReqSimpleExpRespMultiExpReqMultiExpResp

CIM Server CIM Listener


Indication DeliveryIndication DeliveryUse Model 1: Indications are received, acted on my the management application, but not stored (e.g., "mouse-click", "plug-n-play" device added, statistics gathering data).

CIM Listener


Indication Consumer


CIM ListenerModule

e.g., “mouse-click”, “plug-n-play” device added, etc.

Management Station

IndicationDelivery

4


Indication DeliveryIndication DeliveryUse Model 2: Indications are received, acted on my the management application, and stored in an application-specific repository.

CIM Listener


Indication Consumer

CIM ListenerModule

Management Station

IndicationDelivery

4

Event Repository

Application-specific operations on Event

Repository


Indication DeliveryIndication DeliveryUse Model 3: Indications are received, acted on my the management application, and stored in a repository that is accessible through CIM.

CIM Listener


Indication Consumer

CIM ListenerModule

Management Station

IndicationDelivery

4

Instance ProviderEvent Repository

CIMOM

CIM Server

Event Repository

Event RepositoryAccess and

Manipulation


Indication DeliveryIndication DeliveryA CIM Listener receives and processes CIM Export Message requests and issues CIM Export Message responses.

M-POST /cimlistener/browser HTTP/1.1 HOST: http://www.acme.com/Content-Type: application/xml; charset="utf-8"Content-Length: XXXMan: http://www.dmtf.org/cim/mapping/http/v1.0 ; ns=4040-CIMExport: MethodRequest40-CIMExportMethod: ExportIndication

<?xml version="1.0" encoding="utf-8" ?><CIM CIMVERSION="2.0" DTDVERSION="2.0"><MESSAGE ID="1007" PROTOCOLVERSION="1.0"><SIMPLEEXPREQ><EXPMETHODCALL NAME="ExportIndication"><IPARAMVALUE NAME="NewIndication"><INSTANCE CLASSNAME="CIM_AlertIndication" ><PROPERTY NAME="Description" TYPE="string"><VALUE>Sample CIM_AlertIndication indication</VALUE></PROPERTY><PROPERTY NAME="AlertType" TYPE="uint16"><VALUE>1</VALUE><PROPERTY NAME="IndicationTime" TYPE="datetime"><VALUE>20010515104354.000000:000</VALUE></PROPERTY></INSTANCE></IPARAMVALUE></EXPMETHODCALL>

</SIMPLEEXPREQ></MESSAGE></CIM>

ExportIndication

void ExportIndication ([IN] <instance> NewIndication

)

Indication Consumer


CIM Listener Module

IndicationDelivery

4


CIM Listener

Indication DeliveryIndication Delivery

CIM Listener

Indication Consumer

CIM ListenerModule

CIM Export Message

CIM Export Message Processor

Consumer Manager

Registration Data

Indication Consumer

CIM Export Message

HTTP Server



• CIM Event Module v2.7– Add Error Handling Semantics to CIM_IndicationSubscription (CR647)– Add Persistence Semantics to CIM_IndicationSubscription and

CIM_IndicationHandler (CR650)– Add Repeat Indication Handling Semantics to CIM_IndicationSubscription

(CR651)– Add Repeat Indication Semantics to CIM_ProcessIndication (CR652)


Error HandlingError Handling•Problem Statement

–Need to define a mechanism to handle and track subscription subcomponent errors. E.g., failure of an indication provider, indication handler, CIM_Listener.

CR

647

Filter: CIM_IndicationFilter REFHandler: CIM_IndicationHandler REFOnFatalErrorPolicy: uint16OtherOnFatalErrorPolicy: stringFailureTriggerTimeInterval: uint64SubscriptionState: uint16OtherSubscriptionState: stringTimeOfLastStateChange: datetime


Failure of an Indication Provider. (Note that this type of failure would not necessarily be associated with the generation of an indication.)

Failure by Indication Service when trying to process an Indication.

Failure of Indication Handler when trying to deliver an indication.

Possible Failure Condition


PersistencePersistence•Problem Statement

–The Indication Subscription service needs to be able to perform routine maintenance on instances of the subscription schema. In particular, the service needs to be able to delete “unwanted” subscriptions.

•Use Model

–Subscription “life-span” is defined, by the client, as part of the subscription definition. This allows the Indication Subscription service to automatically delete out-of-date subscriptions.

DMTF 2002 Developers' Conference June 10-13, 2002 Page 11

SubscriptionsSubscriptionsUse Model 2: Subscriptions are defined and removed as part of an interactive monitoring session with an “end user.” The client application creates the subscriptions as well as serves as the indication consumer. The expectation is that the subscriptions “exist” only while the client session is active. A subscription should be automatically deleted when the client application terminates.


CIM

-XN

LIndication H

andler

Resource

Indication Provider

CIMOM

CIM Listener

Indication Consumer

(Event Browser)



IndicationDelivery

4

Subscription

2


Persistence of CIM Listener

DMTF 2002 Developers' Conference June 10-13, 2002 Page 12

SubscriptionsSubscriptionsUse Model 3: Subscriptions provide a service and are created, renewed and deleted based on the terms of a lease. The expectation is that a subscription “exists” for the duration of time specified by the lease. An “expiration date” is associated with each subscription and a “renewal” would consist of updating the expiration date. A subscription should be automatically deleted when the expiration date has passed.

CIM Listener

Indication Consumer(e.g., Stock

Ticker)



CIM-XN

LIndication H

andler

Resource

Indication Provider

CIMOMExportIndication

(CIM-XML)

IndicationDelivery

4

Subscription

2


Subscription Expiration Date


PersistencePersistence

Subscription should be automatically deleted when the expiration date is passed.

NON-NULLNULL

Subscription must be explicitly deleted.NULLNULL

Subscription should be automatically deleted when either the CIM Listener terminates or the expiration date is passed.

NON-NULLTransient

Subscription should be automatically deleted when the expiration date is passed.

NON-NULLPersistent

NULL

NULL

Subscription Expiration Date

Subscription should be automatically deleted when the CIM Listener (i.e., indication consumer) terminates.

Transient

Subscription must be explicitly deleted.Persistent

BehaviorListener Type

Filter: CIM_IndicationFilter REFHandler: CIM_IndicationHandler REFUint64: SubscriptionDurationDatetime; SubscriptionStartTimeUint64: SubscriptionTimeRemaining


CR

650


Caption: stringDescription: stringSystemCreationClassName: [key] stringSystemName: [key] stringCreationClassName: [key] stringName: [key] stringOwner: stringPersistenceType: uint16;OtherPersistenceType: string;C

R65

0


Repeat NotificationsRepeat Notifications• Problem Statement

–Need to define a mechanism to allow a client to control how frequently to send repeat notifications to a destination.

• Use Model

–Client can control resource usage (e.g., network bandwidth) by configuring the number of times the consumer is notified of an event.

• Solution Notes

–At a conceptual level, a repeat notification refers to an indication that describes an event that has already been reported. It is the responsibility of the indication provider to determine whether or not an indication is a repeat notification (i.e., describes the same the same event).

–By definition, all repeat notification MUST match the same filter condition as the initial notification.


Caption: stringDescription: stringSystemCreationClassName: [key] stringSystemName: [key] stringCreationClassName: [key] stringName: [key] stringSourceNamespace: [required] stringQuery: [required] stringQueryLanguage: [required] stringRepeatNotificationPolicy: uint16OtherRepeatNotificationPolicy: stringRepeatNotificationInterval: uint64RepeatNotificationGap: uint64RepeatNotificationCount: uint16C

R65

1


Repeat NotificationRepeat Notification

RepeatNotificationPolicy = SuppressRepeatNotificationInterval = 30RepeatNotificationCount = 2RepeatNotificationGap is Ignored

Note: There is no guarantee that a repeat indication will be generated at a consistent interval. The frequency which indication are generated will be dependent on the mechanism used by the indication provider to discover the event.

If the value is 'Suppress‘ the first'RepeatNotificationCount' indications, describing the same event, must be sent and all subsequent indications for this event suppressed for the remainder of the time interval 'RepeatNotificationInterval'. A new interval starts when the next indication for this event is received.

IndicationGenerated

RepeatIndicationGenerated


Time 0 10 20 30 59 70


100



IndicationSent

IndicationSent

IndicationSent

IndicationSent

IndicationSent

37

Interval Interval Interval

Possible values for RepeatNotificationPolicy : "Unknown", "Other", "None", "Suppress", "Delay"


Repeat NotificationRepeat Notification

Note: There is no guarantee that a repeat indication will be generated during each notification interval. The frequency which indication are generated will be dependent on the mechanism used by the indication provider to discover the event.

RepeatNotificationPolicy = DelayRepeatNotificationInterval = 30RepeatNotificationCount = 2RepeatNotificationGap = 60

If the value of RepeatNotificationPolicy is 'Delay' and an indication is received, this indication MUST be suppressed if, including this indication, RepeatNoticationCount or fewer indications for this event have been received during the prior time interval defined by RepeatNotificationInterval. If this indication is the RepeatNotificationCount + 1 indication, this indication MUST be sent and all subsequent indications for this event ignored until the RepeatNotificationGap has elapsed. A RepeatNotificationInterval MAY NOT overlap a RepeatNotificationGap time interval.

All indications for this event MUST be

ignored during the gap interval.

IndicationGenerated

IndicationSent

Time

5 25 90


105


Gap

85


122


IndicationSent

125

Gap



185



9575 80

Interval Interval

Possible values for RepeatNotificationPolicy : "Unknown", "Other", "None", "Suppress", "Delay"

cim events use and implementation - dmtf · cim events use and implementation denise eckstein...

Documents