| Name | Data Type | Qualifiers |
| Name | Data Type | Value | Scope | Flavors |
| Caption | string |
| Description | string | The Caption property is a short textual description (one- line string) of the object. | None | TRANSLATABLE= true |
| MaxLen | uint32 | 64 | None | None |
| ContentEncoding | string |
| Description | string | This block acts as a hint to indicate how the delivered events should be encoded. The two standard tokens defined for this purpose are "UTF-8" or "UTF-16", although other encoding formats may be specified if necessary. | None | TRANSLATABLE= true |
| CreationClassName | string |
| Description | string | Indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, it allows all instances of this class and its subclasses to be uniquely identified. | None | TRANSLATABLE= true |
| Key | boolean | true | None | OVERRIDABLE= false
|
| MaxLen | uint32 | 256 | None | None |
| DeliveryAuth | string |
| Description | string | A URI identifying the WS-Management security profile to be used by the service (acting as publisher) when authenticating to the event sink (consumer) at event delivery time. | None | TRANSLATABLE= true |
| DeliveryMode | uint16 |
| Description | string | Method by which the service is to deliver events to the client. Values are as follows. Push (2): the event is sent to the destination address; depending on the protocol, delivery may not be guaranteed. PushWithAck (3): the service sends the event and waits for a specific acknowledgment message from the subscriber. Events (4): the service collects events into batches and sends the batches to the subscriber. Pull (5): the service collects the events into batches and the subscriber pulls each batch from the service using wxf:Pull. | None | TRANSLATABLE= true |
| ValueMap | string | 2, 3, 4, 5, .., 32787.. | None | None |
| Values | string | Push, PushWithAck, Events, Pull, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
| Description | string |
| Description | string | The Description property provides a textual description of the object. | None | TRANSLATABLE= true |
| Destination | string |
| Description | string | The destination URL defined in the WS-Eventing Subscribe message. This must match the wsa:Address element in the wse:NotifyTo EPR. The value may be the WS-Addressing anonymous URI if the subscription uses or employs a Pull mode. | None | TRANSLATABLE= true |
| Override | string | Destination | TOSUBCLASS= false | None |
| Required | boolean | true | None | OVERRIDABLE= false
|
| DestinationEndTo | string |
| Description | string | Separate To address for notice of abnormal subscription termination. | None | TRANSLATABLE= true |
| ElementName | string |
| Description | string | A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information.
Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. | None | TRANSLATABLE= true |
| Generation | uint64 |
| Description | string | Generation is an optional, monotonically increasing property that may be used to identify a particular generation of the resource represented by this class.
If Generation is supported by the implementation, its value shall not be null.
Except as otherwise specified, a value (including null) of Generation specified at creation time shall be replaced by null if Generation is not supported by the implementation or shall be a, (possibly different), non-null value if the implementation does support Generation.
After creation and if supported, Generation shall be updated, at least once per access, whenever the represented resource is modified, regardless of the source of the modification.
Note: the Generation value only needs to be updated once between references, even if the resource is updated many times. The key point is to assure that it will be different if there have been updates, not to count each update.
Note: unless otherwise specified, the value of Generation within one instance is not required to be coordinated with the value of Generation in any other instance.
Note:the semantics of the instance, (as defined by its creation class), define the underlying resource. That underlying resource may be a collection or aggregation of resources. And, in that case, the semantics of the instance further define when updates to constituent resources also require updates to the Generation of the collective resource. Default behavior of composite aggregations should be to update the Generation of the composite whenever the Generation of a component is updated.
Subclasses may define additional requirements for updates on some or all of related instances.
For a particular instance, the value of Generation may wrap through zero, but the elapsed time between wraps shall be greater than 10's of years.
This class does not require Generation to be unique across instances of other classes nor across instances of the same class that have different keys. Generation shall be different across power cycles, resets, or reboots if any of those actions results in an update. Generation may be different across power cycles, resets, or reboots if those actions do not result in an update. If the Generation property of an instance is non-null, and if any attempt to update the instance includes the Generation property, then if it doesn't match the current value, the update shall fail.
The usage of this property is intended to be further specified by applicable management profiles.
Typically, a client will read the value of this property and then supply that value as input to an operation that modifies the instance in some means. This may be via an explicit parameter in an extrinsic method or via an embedded value in an extrinsic method or intrinsic operation.
For example: a profile may require that an intrinsic instance modification supply the Generation property and that it must match for the modification to succeed. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| Heartbeat | uint64 |
| Description | string | Specifies how often heartbeat events are added to the event stream at the specified interval. | None | TRANSLATABLE= true |
| Units | string | Seconds | None | TRANSLATABLE= true |
| InstanceID | string |
| Description | string | InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below.
To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm:
<OrgID>:<LocalID>
Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>.
<LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If not null and the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance.
If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM. | None | TRANSLATABLE= true |
| Locale | string |
| Description | string | If the events contain localized content, the service should accept a subscription with this Locale block acting as a hint. The language of the event message is encoded in an xml:lang attribute using RFC 3066 language codes. The service should attempt to localize any descriptive content to the specified language when delivering such events. | None | TRANSLATABLE= true |
| MaxTime | uint64 |
| Description | string | This element may contain a duration that indicates the maximum amount of time the service should allow to elapse while batching EVENT bodies. That is, this time may not be exceeded between the encoding of the first event in the batch and the dispatching of the batch for delivery. | None | TRANSLATABLE= true |
| Units | string | Seconds | None | TRANSLATABLE= true |
| Name | string |
| Description | string | Indicates the name of the CIM Listener destination. | None | TRANSLATABLE= true |
| Key | boolean | true | None | OVERRIDABLE= false
|
| MaxLen | uint32 | 256 | None | None |
| OtherPersistenceType | string |
| Description | string | A string describing ("Other") values for PersistenceType. This value MUST be set to a non NULL value when the PersistenceType is 1 ("Other"). For all other values of PersistenceType, the value of OtherPersistenceType MUST be NULL. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_ListenerDestination.PersistenceType | None | None |
| OtherProtocol | string |
| Description | string | A free-form string providing a description of the supported protocols when 1, "Other", is specified for the Protocol. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ModelCorrespondence | string | CIM_ListenerDestination.Protocol | None | None |
| PersistenceType | uint16 |
| Description | string | Describes the Persistence Type of the destination defined by this instance. If the value of PersistenceType is not specified, the value of PersistenceType MUST be treated as 2 ("Permanent"). A value of 2 ("Permanent") declares that the destination is always expected to be available (e.g., system log file). Inability to access this destination MUST be treated as an error condition. A value of 3 ("Transient") indicates that the destination is short-lived. Inability to access the destination MAY be treated as a normal termination condition. Subscriptions with "Transient" destinations MAY be deleted when the destination terminates or is no longer available. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_ListenerDestination.OtherPersistenceType | None | None |
| ValueMap | string | 1, 2, 3 | None | None |
| Values | string | Other, Permanent, Transient | None | TRANSLATABLE= true |
| PolyMorphismMode | uint16 |
| Description | string | Specifies the treatment of Indication subclasses, whether subclasses are to be included and with what set of properties. Valid values are: None, IncludeSubclassProperties, and ExcludeSubclassProperties. Using None, only instances of the parent class are included in the output (event stream). For other modes, subclass instances are included with the sets of properties stated. | None | TRANSLATABLE= true |
| ValueMap | string | 1, 2, 3, .. | None | None |
| Values | string | None, IncludeSubclassProperties, ExcludeSubclassProperties, DMTF Reserved | None | TRANSLATABLE= true |
| Protocol | uint16 |
| Description | string | Protocol describes an encoding and protocol which will be used to deliver the indication. If Other is used, the value for OtherProtocol must not be null.
If a protocol is not specified, 2 "CIM-XML" must be assumed. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ModelCorrespondence | string | CIM_ListenerDestination.OtherProtocol | None | None |
| ValueMap | string | 1, 2, 3, 4, 5, .. | None | None |
| Values | string | Other, CIM-XML, SM CLP, WS-Management, WSDM, DMTF Reserved | None | TRANSLATABLE= true |
| SendBookmark | boolean |
| Description | string | A property element that instructs the service to send a bookmark with each event. Bookmarks apply to all delivery modes. The bookmark is a token which represents an abstract pointer in the event stream, but whether it points to the last delivered event or the last event plus one (the upcoming event) makes no difference since the token is supplied to the same implementation during a subsequent wse:Subscribe operation. The service may thus attach any service-specific meaning and structure to the bookmark with no change to the client. | None | TRANSLATABLE= true |
| SystemCreationClassName | string |
| Description | string | A System's CreationClassName. A CIM Listener destination is defined in context of a CIM_System (e.g., the sending system. | None | TRANSLATABLE= true |
| Key | boolean | true | None | OVERRIDABLE= false
|
| MaxLen | uint32 | 256 | None | None |
| SystemName | string |
| Description | string | A System's Name. A CIM Listener destination is defined in context of a CIM_System (e.g., the sending system. | None | TRANSLATABLE= true |
| Key | boolean | true | None | OVERRIDABLE= false
|
| MaxLen | uint32 | 256 | None | None |
Copyright © 2008-2010 VMware, Inc. All rights reserved.