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

Class CIM_FilterCollectionSubscription

Used in features: WS-Eventing
Compatible with the following Intel AMT Releases: 3.2, 4.0, 5.0, 5.1, 6.0, 6.1, 6.2, 7.0, 8.0, 8.1, 9.0, 9.5, 10.0, 11.0
CIM_AbstractIndicationSubscription
   extended by CIM_FilterCollectionSubscription


Association class CIM_FilterCollectionSubscription
extends CIM_AbstractIndicationSubscription

General Information:
CIM_FilterCollectionSubscription associates the CIM_FilterCollection with a CIM_ListenerDestionation.

Qualifiers:
-------------
Association
Version=2.27.0
UMLPackagePath=CIM::Event


Supported Fields Summary
 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) . . .
 uint16 SubscriptionState
Indicates the current processing state of the subscription.
 uint64 FailureTriggerTimeInterval
The FailureTriggerTimeInterval is used by the client to specify a recommended minimum delay before the OnFatalErrorPolicy is implemented.
 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 . . .
 REF CIM_FilterCollection 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.

Methods Summary
  Get(Instance)
Gets the representation of the instance
  Enumerate()
Enumerates the instances of this class
  Unsubscribe()
Remove subscription to this resource (WS-Eventing)
  Renew()
Renew subscription to this resource (WS-Eventing)

Field Detail

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}


SubscriptionState

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

Product Specific Usage:
In Intel AMT Release 6.0 and later releases value is 2 (Enabled).

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


FailureTriggerTimeInterval

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

Product Specific Usage:
In Intel AMT Release 6.0 and later releases value is 30.

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


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.

Product Specific Usage:
In Intel AMT Release 6.0 and later releases value is 4 (Remove).

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


Filter Key

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

Qualifiers:
-------------
Override=Filter


Handler Key

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

Qualifiers:
-------------
Override=Handler


Method Detail

Get

public  Get([OUT]CIM_FilterCollectionSubscription Instance)
Permission Information:
The permissions of this method depend upon the context of its usage

General Information:
Gets the representation of the instance

Enumerate

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

General Information:
Enumerates the instances of this class

Unsubscribe

public  Unsubscribe()
Permission Information:
Permitted realms: ADMIN_SECURITY_EVENT_MANAGER_REALM

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

Renew

public  Renew()
Permission Information:
Permitted realms: ADMIN_SECURITY_EVENT_MANAGER_REALM

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

Product Specific Usage:
This method isn't supported by AMT.

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