CIM211 Class Declaration
CIM_FormattedIndicationSubscription

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

Class Hierarchy

CIM_FormattedIndicationSubscription --> CIM_IndicationSubscription --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_IndicationSubscription
NAMECIM_FormattedIndicationSubscription

Class Qualifiers

Class CIM_FormattedIndicationSubscription Qualifiers
NameTypeValueFrom Class
Versionstring2.10.0 CIM_FormattedIndicationSubscription
DescriptionstringA subclass of IndicationSubscription that defines the text formatting of Indication information. The TextFormatOwningEntity, TextFormatID, TextFormat, and TextFormatParameters properties are used to describe a human-readable representation of the Indication as defined by the referenced CIM_IndicationFilter. This representation MAY be used by the CIM_ListenerDestination when the intended consumer of the Indication is human. For example, this format could be used when writing the Indication to a system log or sending an e-mail notification to a system administrator. CIM_FormattedIndicationSubscription
Associationbooleantrue CIM_FormattedIndicationSubscription
Associationbooleantrue CIM_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

Properties

Properties
NameTypeValueQualifiersClassOrigin
TextFormatOwningEntitystring Description
ModelCorrespondence
CIM_FormattedIndicationSubscription
TextFormatIDstring Description
ModelCorrespondence
CIM_FormattedIndicationSubscription
TextFormatstring Description CIM_FormattedIndicationSubscription
TextFormatParametersstring[] Description
ArrayType
ModelCorrespondence
CIM_FormattedIndicationSubscription
FilterCIM_IndicationFilter ref Key
Description
CIM_IndicationSubscription
HandlerCIM_ListenerDestination ref Key
Description
CIM_IndicationSubscription
OnFatalErrorPolicyuint16 Description
ValueMap
Values
CIM_IndicationSubscription
OtherOnFatalErrorPolicystring Description CIM_IndicationSubscription
FailureTriggerTimeIntervaluint64 Description
Units
CIM_IndicationSubscription
SubscriptionStateuint16 Write
Description
ValueMap
Values
CIM_IndicationSubscription
OtherSubscriptionStatestring Description CIM_IndicationSubscription
TimeOfLastStateChangedatetime Description CIM_IndicationSubscription
SubscriptionDurationuint64 Write
Description
Units
CIM_IndicationSubscription
SubscriptionStartTimedatetime Description CIM_IndicationSubscription
SubscriptionTimeRemaininguint64 Description
Units
CIM_IndicationSubscription
RepeatNotificationPolicyuint16 Description
ValueMap
Values
CIM_IndicationSubscription
OtherRepeatNotificationPolicystring Description CIM_IndicationSubscription
RepeatNotificationIntervaluint64 Description
Units
CIM_IndicationSubscription
RepeatNotificationGapuint64 Description
Units
CIM_IndicationSubscription
RepeatNotificationCountuint16 Description CIM_IndicationSubscription
AlertOnStateChangebooleanfalse Experimental
Description
CIM_IndicationSubscription

Property Qualifiers

Property TextFormatOwningEntity Qualifiers
NameTypeValueFrom Class
DescriptionstringThe TextFormatOwningEntity is a string that uniquely identifies the entity that owns the definition of the human-readable format described in this instance. OwningEntity MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity or standards body defining the format. CIM_FormattedIndicationSubscription
ModelCorrespondencestringCIM_FormattedIndicationSubscription.TextFormatID
CIM_FormattedIndicationSubscription.TextFormat
CIM_FormattedIndicationSubscription.TextFormatParameters
CIM_FormattedIndicationSubscription

Property TextFormatID Qualifiers
NameTypeValueFrom Class
DescriptionstringAn opaque string that uniquely identifies, within the scope of the TextFormatOwningEntity, a human-readable format for representing the Indications described by this Subscription. CIM_FormattedIndicationSubscription
ModelCorrespondencestringCIM_FormattedIndicationSubscription.TextFormatOwningEntity
CIM_FormattedIndicationSubscription.TextFormat
CIM_FormattedIndicationSubscription.TextFormatParameters
CIM_FormattedIndicationSubscription

Property TextFormat Qualifiers
NameTypeValueFrom Class
DescriptionstringA string describing the human-readable format for representing the Indications described by this Subscription. The actual text is constructed by applying the dynamic content, defined in the Indication, to the string specified in this property. /n /n The dynamic content is specified by embedding the following syntax in the appropriate places in the format string: " { " < index > [ " [ " [ < index > ] " ] " ], < type > " } " - the first occurrence of < index > defines the element of TextFormatParameters that contains the name of the Indication property to be used to populate the text message. - if the Indication property defined by the first < index > is an array property, then the first index MUST be followed by either empty brackets (i.e., []) or an index value enclosed in brackets (e.g., [1]). If empty brackets are specified (e.g., {4[], string}), then the dynamic content of the text message is populated with a list of the array elements. If an index is specified (e.g., {4[1], string}, then only the specified array element is used to populate the message. If the value of the dynamic content is not defined in the Indication, then the string " UNKNOWN " is used to populate the text message. - < type > defines the type of the dynamic content. Valid values for < type > are: ’ boolean ’ , ’ string ’ , ’ char16 ’ , ’ uint8 ’ , ’ sint8 ’ , ’ uint16 ’ , ’ sint16 ’ , ’ uint32 ’ , ’ sint32 ’ , ’ uint64 ’ , ’ sint64 ’ , ’ datetime ’ , ’ real32 ’ , ’ real64 ’ or ’ ref ’ . The string encoding for the dynamic content MUST conform to the MOF Syntax Grammar described in the CIM Infrastructure Specification. The string encoding for a list of array elements MUST conform to the definition of the arrayInitializer element. As an example, a format string for a UPS AlertIndication could be defined as follows: " A {4,string} UPS Alert of type {5,uint16} was detected on the device {6,string} on the system {2,string} at {1,datetime}. The following actions have been recommended to resolve the alert: {3[],string} " . CIM_FormattedIndicationSubscription

Property TextFormatParameters Qualifiers
NameTypeValueFrom Class
DescriptionstringAn indexed array containing the names of properties defined in the select clause of the associated CIM_IndicationFilter Query. The values of these Indication properties are used to populate the dynamic content of the text message. CIM_FormattedIndicationSubscription
ArrayTypestringIndexed CIM_FormattedIndicationSubscription
ModelCorrespondencestringCIM_FormattedIndicationSubscription.TextFormatOwningEntity
CIM_FormattedIndicationSubscription.TextFormatID
CIM_FormattedIndicationSubscription.TextFormat
CIM_FormattedIndicationSubscription

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

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

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_IndicationSubscription
ValueMapstring
[See below.]
CIM_IndicationSubscription
ValuesstringOther
Ignore
Disable
Remove
CIM_IndicationSubscription

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_IndicationSubscription

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

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

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_IndicationSubscription

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_IndicationSubscription

Property SubscriptionDuration Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_IndicationSubscription
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_IndicationSubscription
UnitsstringSeconds CIM_IndicationSubscription

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_IndicationSubscription

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

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_IndicationSubscription
ValueMapstring
[See below.]
CIM_IndicationSubscription
ValuesstringUnknown
Other
None
Suppress
Delay
CIM_IndicationSubscription

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_IndicationSubscription

Property RepeatNotificationInterval Qualifiers
NameTypeValueFrom Class
DescriptionstringDefines the time interval for the repeat notification policy calculation. CIM_IndicationSubscription
UnitsstringSeconds CIM_IndicationSubscription

Property RepeatNotificationGap Qualifiers
NameTypeValueFrom Class
DescriptionstringDefines the gap interval for the repeat notification policy calculation. CIM_IndicationSubscription
UnitsstringSeconds CIM_IndicationSubscription

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

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_IndicationSubscription

Methods

Method Qualifiers

Parameters

Parameter Qualifiers

Associations this class can participate in