CIM2.17.1 Class Declaration
CIM_IndicationSubscription

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_IndicationSubscription --> CIM_AbstractIndicationSubscription --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_AbstractIndicationSubscription
NAMECIM_IndicationSubscription

Class Qualifiers

Class CIM_IndicationSubscription Qualifiers
NameTypeValueFrom Class
AssociationbooleantrueCIM_IndicationSubscription
Versionstring2.16.0CIM_IndicationSubscription
UMLPackagePathstringCIM::EventCIM_IndicationSubscription
DescriptionstringCIM_IndicationSubscription describes a flow of Indications. The flow is specified by the referenced Filter, and directed to the referenced destination or process in the Handler. Property values of the referenced CIM_IndicationFilter instance and CIM_ListenerDestination instance MAY significantly effect the definition of the subscription. E.g., a subscription associated with a "Transient" destination MAY be deleted when the destination terminates or is no longer available.CIM_IndicationSubscription
AssociationbooleantrueCIM_AbstractIndicationSubscription
UMLPackagePathstringCIM::EventCIM_AbstractIndicationSubscription
DescriptionstringCIM_IndicationSubscription describes a flow of Indications. The flow is specified by the referenced Filter, and directed to the referenced destination or process in the Handler. Property values of the referenced CIM_IndicationFilter instance and CIM_ListenerDestination instance MAY significantly effect the definition of the subscription. E.g., a subscription associated with a "Transient" destination MAY be deleted when the destination terminates or is no longer available.CIM_AbstractIndicationSubscription

Properties

Properties
NameTypeValueQualifiersClassOrigin
FilterCIM_IndicationFilter ref Key
Override
Description
CIM_IndicationSubscription
HandlerCIM_ListenerDestination ref Key
Override
Description
CIM_IndicationSubscription
OnFatalErrorPolicyuint16 Description
ValueMap
Values
CIM_AbstractIndicationSubscription
OtherOnFatalErrorPolicystring Description CIM_AbstractIndicationSubscription
FailureTriggerTimeIntervaluint64 Description
Units
PUnit
CIM_AbstractIndicationSubscription
SubscriptionStateuint16 Write
Description
ValueMap
Values
CIM_AbstractIndicationSubscription
OtherSubscriptionStatestring Description CIM_AbstractIndicationSubscription
TimeOfLastStateChangedatetime Description CIM_AbstractIndicationSubscription
SubscriptionDurationuint64 Write
Description
Units
PUnit
CIM_AbstractIndicationSubscription
SubscriptionStartTimedatetime Description CIM_AbstractIndicationSubscription
SubscriptionTimeRemaininguint64 Description
Units
PUnit
CIM_AbstractIndicationSubscription
RepeatNotificationPolicyuint16 Description
ValueMap
Values
CIM_AbstractIndicationSubscription
OtherRepeatNotificationPolicystring Description CIM_AbstractIndicationSubscription
RepeatNotificationIntervaluint64 Description
Units
PUnit
CIM_AbstractIndicationSubscription
RepeatNotificationGapuint64 Description
Units
PUnit
CIM_AbstractIndicationSubscription
RepeatNotificationCountuint16 Description CIM_AbstractIndicationSubscription
AlertOnStateChangebooleanfalseExperimental
Description
CIM_AbstractIndicationSubscription
LastIndicationIdentifierstring Experimental
Description
ModelCorrespondence
CIM_AbstractIndicationSubscription
LastIndicationProductionDateTimedatetime Experimental
Description
ModelCorrespondence
CIM_AbstractIndicationSubscription
SubscriptionInfostring Experimental
Write
Description
CIM_AbstractIndicationSubscription

Property Qualifiers

Property Filter Qualifiers
NameTypeValueFrom Class
KeybooleantrueCIM_IndicationSubscription
DescriptionstringThe Filter that defines the criteria and data of the possible Indications of this subscription.CIM_IndicationSubscription

Property Handler Qualifiers
NameTypeValueFrom Class
KeybooleantrueCIM_IndicationSubscription
DescriptionstringThe Handler addressing delivery of the possible Indications of this subscription.CIM_IndicationSubscription

Property Filter Qualifiers
NameTypeValueFrom Class
KeybooleantrueCIM_AbstractIndicationSubscription
DescriptionstringThe Filter that defines the criteria and data of the possible Indications of this subscription.CIM_AbstractIndicationSubscription

Property Handler Qualifiers
NameTypeValueFrom Class
KeybooleantrueCIM_AbstractIndicationSubscription
DescriptionstringThe Handler addressing delivery of the possible Indications of this subscription.CIM_AbstractIndicationSubscription

Property OnFatalErrorPolicy Qualifiers
NameTypeValueFrom Class
DescriptionstringDefines the desired behavior for a subscription when a fatal error occurs in one of the Indication processing subcomponents (e.g., Indication processor, Indication or instance provider, or Indication handler) and the Indication cannot be successfully sent. Specifically, a failure implies that some aspect of Indication generation, processing or dispatch is no longer functioning and Indications may be lost. If the value of OnFatalErrorPolicy is 2 ("Ignore") or not set (NULL), the subscription MUST continue to be processed in a 'best effort' mode. This mode of operation can lead to unpredictable, and potentially misleading results, because Indications may be lost. If the value is 3 ("Disable"), the subscription MUST be disabled. With this policy, no new Indications will be generated or dispatched until the subscription is explicitly enabled. This is accomplished via the property, SubscriptionState. If the value is 4 ("Remove"), the subscription MUST be deleted. Selecting this policy has the same effect as issuing a DeleteInstance operation on this subscription instance.CIM_AbstractIndicationSubscription
ValueMapstring
[See below.]
CIM_AbstractIndicationSubscription
ValuesstringOther
Ignore
Disable
Remove
CIM_AbstractIndicationSubscription

NameValue
1Other
2Ignore
3Disable
4Remove
Property OtherOnFatalErrorPolicy Qualifiers
NameTypeValueFrom Class
DescriptionstringA string defining "Other" values for OnFatalErrorPolicy. This value MUST be set to a non NULL value when OnFatalErrorPolicy is set to a value of 1 ("Other"). For all other values, the OtherOnFatalErrorPolicy MUST be NULL.CIM_AbstractIndicationSubscription

Property FailureTriggerTimeInterval Qualifiers
NameTypeValueFrom Class
DescriptionstringThe FailureTriggerTimeInterval is used by the client to specify a recommended minimum delay before the OnFatalErrorPolicy is implemented.CIM_AbstractIndicationSubscription
UnitsstringSecondsCIM_AbstractIndicationSubscription
PUnitstringsecondCIM_AbstractIndicationSubscription

Property SubscriptionState Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_AbstractIndicationSubscription
DescriptionstringIndicates the current processing state of the subscription.CIM_AbstractIndicationSubscription
ValueMapstring
[See below.]
CIM_AbstractIndicationSubscription
ValuesstringUnknown
Other
Enabled
Enabled Degraded
Disabled
CIM_AbstractIndicationSubscription

NameValue
0Unknown
1Other
2Enabled
3Enabled Degraded
4Disabled
Property OtherSubscriptionState Qualifiers
NameTypeValueFrom Class
DescriptionstringA string defining "Other" values for SubscriptionState. This value MUST be set to a non NULL value when SubscriptionState is set to a value of 1 ("Other"). For all other values, the OtherSubscriptionState MUST be NULL.CIM_AbstractIndicationSubscription

Property TimeOfLastStateChange Qualifiers
NameTypeValueFrom Class
DescriptionstringDate and time of the last state change. This value is based on the notion of local date and time of the Managed System Element running the Indication processing subcomponents.CIM_AbstractIndicationSubscription

Property SubscriptionDuration Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_AbstractIndicationSubscription
DescriptionstringSubscriptionDuration defines the desired length of the subscription. Indications generated after the duration of the subscription has exceeded SubscriptionDuration MUST NOT be sent. The duration of a subscription MAY be changed by modifying this property. An expired subscription MAY be deleted and MUST NOT be modified. If the value of SubscriptionDuration is not set, the subscription MUST be treated as having no expiration date.CIM_AbstractIndicationSubscription
UnitsstringSecondsCIM_AbstractIndicationSubscription
PUnitstringsecondCIM_AbstractIndicationSubscription

Property SubscriptionStartTime Qualifiers
NameTypeValueFrom Class
DescriptionstringSubscriptionStartTime is the time the subscription was started. The value of this property is computed based on the notion of date and time of the ManagedSystemElement running the Indication processing subcomponents.CIM_AbstractIndicationSubscription

Property SubscriptionTimeRemaining Qualifiers
NameTypeValueFrom Class
DescriptionstringSubscriptionTimeRemaining is a computed value that provides a snapshot of the time remaining in the Subscription.CIM_AbstractIndicationSubscription
UnitsstringSecondsCIM_AbstractIndicationSubscription
PUnitstringsecondCIM_AbstractIndicationSubscription

Property RepeatNotificationPolicy Qualifiers
NameTypeValueFrom Class
DescriptionstringThe RepeatNotificationPolicy property defines the desired behavior for handling Indications that report the occurrence of the same underlying event (e.g., the disk is still generating I/O errors and has not yet been repaired). The defined semantics for the RepeatNotificationCount, RepeatNotificationInterval, and RepeatNotificationGap properties depend on the value of RepeatNotificationPolicy, but values for these properties MUST be set if the property is defined for the selected policy. If the value of RepeatNotificationPolicy is 0 ("Unknown") or not set, no special processing for repeat Indications is defined by the subscription. The semantics associated with the handling of repeat Indications MAY be defined by the Indication processing subcomponents. If the value of RepeatNotificationPolicy is 2 ("None"), special processing of repeat Indications MUST NOT be performed. If the value is 3 ("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. If the value of RepeatNotificationPolicy is 4 ("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.CIM_AbstractIndicationSubscription
ValueMapstring
[See below.]
CIM_AbstractIndicationSubscription
ValuesstringUnknown
Other
None
Suppress
Delay
CIM_AbstractIndicationSubscription

NameValue
0Unknown
1Other
2None
3Suppress
4Delay
Property OtherRepeatNotificationPolicy Qualifiers
NameTypeValueFrom Class
DescriptionstringA string defining "Other" values for RepeatNotificationPolicy. This value MUST be set to a non NULL value when RepeatNotificationPolicy is set to a value of 1 ("Other"). For all other values, the OtherRepeatNotificationPolicy MUST be NULL.CIM_AbstractIndicationSubscription

Property RepeatNotificationInterval Qualifiers
NameTypeValueFrom Class
DescriptionstringDefines the time interval for the repeat notification policy calculation.CIM_AbstractIndicationSubscription
UnitsstringSecondsCIM_AbstractIndicationSubscription
PUnitstringsecondCIM_AbstractIndicationSubscription

Property RepeatNotificationGap Qualifiers
NameTypeValueFrom Class
DescriptionstringDefines the gap interval for the repeat notification policy calculation.CIM_AbstractIndicationSubscription
UnitsstringSecondsCIM_AbstractIndicationSubscription
PUnitstringsecondCIM_AbstractIndicationSubscription

Property RepeatNotificationCount Qualifiers
NameTypeValueFrom Class
DescriptionstringDefines the count property for the repeat notification policy calculation.CIM_AbstractIndicationSubscription

Property AlertOnStateChange Qualifiers
NameTypeValueFrom Class
DescriptionstringSet to TRUE if a Listener should receive an IndicationSubscriptionAlert if a state change affects the subscription. Otherwise it is set to FALSE.CIM_AbstractIndicationSubscription

Property LastIndicationIdentifier Qualifiers
NameTypeValueFrom Class
DescriptionstringThe IndicationIdentifier for the last indication produced for this indication subscription.This property shall be updated when the indication is produced regardless if the indication was delivered to its destination.CIM_AbstractIndicationSubscription
ModelCorrespondencestringCIM_Indication.IndicationIdentifierCIM_AbstractIndicationSubscription

Property LastIndicationProductionDateTime Qualifiers
NameTypeValueFrom Class
DescriptionstringThe date and time of the last time an indication was produced for this subscription. This property shall be updated when the indication is produced regardless if the indication was delivered to its destination.CIM_AbstractIndicationSubscription
ModelCorrespondencestringCIM_Indication.IndicationTimeCIM_AbstractIndicationSubscription

Property SubscriptionInfo Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_AbstractIndicationSubscription
DescriptionstringSubscription identification information. May be used by the client or protocol to store subscription identification information.CIM_AbstractIndicationSubscription

Methods

Method Qualifiers

Parameters

Parameter Qualifiers

Associations this class can participate in