WS-Management > WS-Management Class Reference > CIM Classes > CIM_AbstractIndicationSubscription

Class CIM_AbstractIndicationSubscription

CIM_AbstractIndicationSubscription

Known Subclasses:
CIM_FilterCollectionSubscription

Abstract Association class CIM_AbstractIndicationSubscription

General Information:
CIM_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.

Qualifiers:
-------------
Association
Abstract
Version=2.31.0
UMLPackagePath=CIM::Event


Supported Fields Summary
 REF CIM_ManagedElement Filter Key
The Filter that defines the criteria and data of the possible Indications of this subscription.
 REF CIM_ListenerDestination Handler Key
The Handler addressing delivery of the possible Indications of this subscription.
 uint16 OnFatalErrorPolicy
Defines 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 . . .
 string OtherOnFatalErrorPolicy
A string defining "Other" values for OnFatalErrorPolicy . . .
 uint64 FailureTriggerTimeInterval
The FailureTriggerTimeInterval is used by the client to specify a recommended minimum delay before the OnFatalErrorPolicy is implemented.
 uint16 SubscriptionState
Indicates the current processing state of the subscription.
 string OtherSubscriptionState
A string defining "Other" values for SubscriptionState . . .
 datetime TimeOfLastStateChange
Date and time of the last state change . . .
 uint64 SubscriptionDuration
SubscriptionDuration defines the desired length of the subscription . . .
 datetime SubscriptionStartTime
SubscriptionStartTime is the time the subscription was started . . .
 uint64 SubscriptionTimeRemaining
SubscriptionTimeRemaining is a computed value that provides a snapshot of the time remaining in the Subscription.
 uint16 RepeatNotificationPolicy
The 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) . . .
 string OtherRepeatNotificationPolicy
A string defining "Other" values for RepeatNotificationPolicy . . .
 uint64 RepeatNotificationInterval
Defines the time interval for the repeat notification policy calculation.
 uint64 RepeatNotificationGap
Defines the gap interval for the repeat notification policy calculation.
 uint16 RepeatNotificationCount
Defines the count property for the repeat notification policy calculation.

Methods Summary
  Create(Instance, ResourceCreated)
Creates a new instance of this class
  Put(Instance)
Changes properties of the selected instance
  Get(Instance)
Gets the representation of the instance
  Delete()
Deletes an instance
  Pull(EnumerationContext, MaxElements)
Pulls instances of this class, following an Enumerate operation
  Enumerate()
Enumerates the instances of this class
  Release(EnumerationContext)
Releases an enumeration context
  Subscribe()
Subscribes to this resource (WS-Eventing)
  Unsubscribe()
Remove subscription to this resource (WS-Eventing)

Field Detail

Filter Key

public REF CIM_ManagedElement Filter
General Information:
The Filter that defines the criteria and data of the possible Indications of this subscription.

Qualifiers:
-------------
Key


Handler Key

public REF CIM_ListenerDestination Handler
General Information:
The Handler addressing delivery of the possible Indications of this subscription.

Qualifiers:
-------------
Key


OnFatalErrorPolicy

public uint16 OnFatalErrorPolicy
General Information:
Defines 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.

Qualifiers:
-------------
ValueMap={1, 2, 3, 4}
Values={Other, Ignore, Disable, Remove}


OtherOnFatalErrorPolicy

public string OtherOnFatalErrorPolicy
General Information:
A 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.

Qualifiers:
-------------
MaxLen=256


FailureTriggerTimeInterval

public uint64 FailureTriggerTimeInterval
General Information:
The FailureTriggerTimeInterval is used by the client to specify a recommended minimum delay before the OnFatalErrorPolicy is implemented.

Qualifiers:
-------------
Units=Seconds
PUnit=second


SubscriptionState

public uint16 SubscriptionState
General Information:
Indicates the current processing state of the subscription.

Qualifiers:
-------------
Write
ValueMap={0, 1, 2, 3, 4}
Values={Unknown, Other, Enabled, Enabled Degraded, Disabled}


OtherSubscriptionState

public string OtherSubscriptionState
General Information:
A 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.

Qualifiers:
-------------
MaxLen=256


TimeOfLastStateChange

public datetime TimeOfLastStateChange
General Information:
Date 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.


SubscriptionDuration

public uint64 SubscriptionDuration
General Information:
SubscriptionDuration 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.

Qualifiers:
-------------
Write
Units=Seconds
PUnit=second


SubscriptionStartTime

public datetime SubscriptionStartTime
General Information:
SubscriptionStartTime 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.


SubscriptionTimeRemaining

public uint64 SubscriptionTimeRemaining
General Information:
SubscriptionTimeRemaining is a computed value that provides a snapshot of the time remaining in the Subscription.

Qualifiers:
-------------
Units=Seconds
PUnit=second


RepeatNotificationPolicy

public uint16 RepeatNotificationPolicy
General Information:
The 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.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4}
Values={Unknown, Other, None, Suppress, Delay}


OtherRepeatNotificationPolicy

public string OtherRepeatNotificationPolicy
General Information:
A 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.

Qualifiers:
-------------
MaxLen=256


RepeatNotificationInterval

public uint64 RepeatNotificationInterval
General Information:
Defines the time interval for the repeat notification policy calculation.

Qualifiers:
-------------
Units=Seconds
PUnit=second


RepeatNotificationGap

public uint64 RepeatNotificationGap
General Information:
Defines the gap interval for the repeat notification policy calculation.

Qualifiers:
-------------
Units=Seconds
PUnit=second


RepeatNotificationCount

public uint16 RepeatNotificationCount
General Information:
Defines the count property for the repeat notification policy calculation.


Method Detail

Create

public  Create([IN]CIM_AbstractIndicationSubscription Instance, [OUT] REF CIM_AbstractIndicationSubscription ResourceCreated)
Permission Information:
No permissions defined

General Information:
Creates a new instance of this class

Product Specific Usage:
The following properties must be included in any representation of CIM_AbstractIndicationSubscription:

Filter
Handler


Put

public  Put([IN]CIM_AbstractIndicationSubscription Instance)
Permission Information:
No permissions defined

General Information:
Changes properties of the selected instance

Product Specific Usage:
The following properties must be included in any representation of CIM_AbstractIndicationSubscription:

Filter
Handler


Get

public  Get([OUT]CIM_AbstractIndicationSubscription Instance)
Permission Information:
No permissions defined

General Information:
Gets the representation of the instance

Delete

public  Delete()
Permission Information:
No permissions defined

General Information:
Deletes an instance

Pull

public  Pull([IN]String EnumerationContext, [IN]String MaxElements)
Permission Information:
All users permitted to use method, only instances to whom the user has permissions will be returned

General Information:
Pulls instances of this class, following an Enumerate operation

Enumerate

public  Enumerate()
Permission Information:
All users permitted to use method

General Information:
Enumerates the instances of this class

Release

public  Release([IN]String EnumerationContext)
Permission Information:
All users permitted to use method

General Information:
Releases an enumeration context

Subscribe

public  Subscribe()
Permission Information:
No permissions defined

General Information:
Subscribes to this resource (WS-Eventing)

Unsubscribe

public  Unsubscribe()
Permission Information:
No permissions defined

General Information:
Remove subscription to this resource (WS-Eventing)

Copyright © 2006-2022, Intel Corporation. All rights reserved.