| Name | Data Type | Qualifiers |
| Name | Data Type | Value | Scope | Flavors |
| AvailableRequestedStates | uint16 |
| Description | string | AvailableRequestedStates indicates the possible values for the RequestedState parameter of the method RequestStateChange, used to initiate a state change. The values listed shall be a subset of the values contained in the RequestedStatesSupported property of the associated instance of CIM_EnabledLogicalElementCapabilities where the values selected are a function of the current state of the CIM_EnabledLogicalElement. This property may be non-null if an implementation is able to advertise the set of possible values as a function of the current state. This property shall be null if an implementation is unable to determine the set of possible values as a function of the current state. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_EnabledLogicalElement.RequestStateChange, CIM_EnabledLogicalElementCapabilities.RequestedStatesSupported | None | None |
| ValueMap | string | 2, 3, 4, 6, 7, 8, 9, 10, 11, .. | None | None |
| Values | string | Enabled, Disabled, Shut Down, Offline, Test, Defer, Quiesce, Reboot, Reset, DMTF Reserved | None | TRANSLATABLE= true |
| AvailableStorage | uint64 |
| Description | string | The number of bytes of opaque management data storage available from the CIM_OpaqueManagementDataService. The value of AvailableStorage shall not exceed the value of MaxAvailableStorage in the associated CIM_OpaqueManagementDataCapabilities. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_OpaqueManagementDataCapabilities.MaxAvailableStorage | None | None |
| PUnit | string | byte | None | None |
| 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 |
| CommunicationStatus | uint16 |
| Description | string | CommunicationStatus indicates the ability of the instrumentation to communicate with the underlying ManagedElement. CommunicationStatus consists of one of the following values: Unknown, None, Communication OK, Lost Communication, or No Contact.
A Null return indicates the implementation (provider) does not implement this property.
"Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
"Not Available" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).
"Communication OK " indicates communication is established with the element, but does not convey any quality of service.
"No Contact" indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.
"Lost Communication" indicates that the Managed Element is known to exist and has been contacted successfully in the past, but is currently unreachable. | None | TRANSLATABLE= true |
| ValueMap | string | 0, 1, 2, 3, 4, .., 0x8000.. | None | None |
| Values | string | Unknown, Not Available, Communication OK, Lost Communication, No Contact, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
| CreationClassName | string |
| Description | string | CreationClassName indicates the name of the class or the subclass that is used in the creation of an instance. When used with the other key properties of this class, this property 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 |
| Description | string |
| Description | string | The Description property provides a textual description of the object. | None | TRANSLATABLE= true |
| DetailedStatus | uint16 |
| Description | string | DetailedStatus compliments PrimaryStatus with additional status detail. It consists of one of the following values: Not Available, No Additional Information, Stressed, Predictive Failure, Error, Non-Recoverable Error, SupportingEntityInError. Detailed status is used to expand upon the PrimaryStatus of the element.
A Null return indicates the implementation (provider) does not implement this property.
"Not Available" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).
"No Additional Information" indicates that the element is functioning normally as indicated by PrimaryStatus = "OK".
"Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, and so on.
"Predictive Failure" indicates that an element is functioning normally but a failure is predicted in the near future.
"Non-Recoverable Error " indicates that this element is in an error condition that requires human intervention.
"Supporting Entity in Error" indicates that this element might be "OK" but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower-layer networking problems. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_EnabledLogicalElement.PrimaryStatus, CIM_ManagedSystemElement.HealthState | None | None |
| ValueMap | string | 0, 1, 2, 3, 4, 5, .., 0x8000.. | None | None |
| Values | string | Not Available, No Additional Information, Stressed, Predictive Failure, Non-Recoverable Error, Supporting Entity in Error, DMTF Reserved, Vendor Reserved | 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. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class. | None | TRANSLATABLE= true |
| EnabledDefault | uint16 |
| Description | string | An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is "Enabled" (value=2). | None | TRANSLATABLE= true |
| ValueMap | string | 2, 3, 5, 6, 7, 9, .., 32768..65535 | None | None |
| Values | string | Enabled, Disabled, Not Applicable, Enabled but Offline, No Default, Quiesce, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
| Write | boolean | true | None | None |
| EnabledState | uint16 |
| Description | string | EnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled and disabled states:
Enabled (2) indicates that the element is or could be executing commands, will process any queued commands, and queues new requests.
Disabled (3) indicates that the element will not execute commands and will drop any new requests.
Shutting Down (4) indicates that the element is in the process of going to a Disabled state.
Not Applicable (5) indicates the element does not support being enabled or disabled.
Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests.
Test (7) indicates that the element is in a test state.
Deferred (8) indicates that the element might be completing commands, but will queue any new requests.
Quiesce (9) indicates that the element is enabled but in a restricted mode.
Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_EnabledLogicalElement.OtherEnabledState | None | None |
| ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11..32767, 32768..65535 | None | None |
| Values | string | Unknown, Other, Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
| HealthState | uint16 |
| Description | string | Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. The following continuum is defined:
"Non-recoverable Error" (30) - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost.
"Critical Failure" (25) - The element is non-functional and recovery might not be possible.
"Major Failure" (20) - The element is failing. It is possible that some or all of the functionality of this component is degraded or not working.
"Minor Failure" (15) - All functionality is available but some might be degraded.
"Degraded/Warning" (10) - The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors.
"OK" (5) - The element is fully functional and is operating within normal operational parameters and without error.
"Unknown" (0) - The implementation cannot report on HealthState at this time.
DMTF has reserved the unused portion of the continuum for additional HealthStates in the future. | None | TRANSLATABLE= true |
| ValueMap | string | 0, 5, 10, 15, 20, 25, 30, .. | None | None |
| Values | string | Unknown, OK, Degraded/Warning, Minor failure, Major failure, Critical failure, Non-recoverable error, DMTF Reserved | None | TRANSLATABLE= true |
| InstallDate | datetime |
| Description | string | A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed. | None | TRANSLATABLE= true |
| MappingStrings | string | MIF.DMTF|ComponentID|001.5 | None | None |
| 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 |
| LockTimeout | datetime |
| Description | string | The amount of time a lock on a CIM_OpaqueManagementData instance shall remain in effect without execution of any CIM_OpaqueManagementDataService extrinsic methods on that CIM_OpaqueManagementData instance by the Identity that holds the lock. Locks on CIM_OpaqueManagementData are created by Lock(). The intent of the timeout is to ensure that a lock is released if the lock holder neglects to release it or is unable to release it. The value of LockTimeout shall be a duration. | None | TRANSLATABLE= true |
| MaxCreateSize | uint64 |
| Description | string | MaxCreateSize shall contain the maximum value that the implementation will currently accept in the MaxSize property of the OpaqueManagementDataTemplate embedded instance parameter in a call to Create(). This value may change over time for any reason, including but not limited to fragmentation of the storage resources managed by the service. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_OpaqueManagementData.MaxSize | None | None |
| PUnit | string | byte | None | None |
| Name | string |
| Description | string | The Name property uniquely identifies the Service and provides an indication of the functionality that is managed. This functionality is described in more detail in the Description property of the object. | None | TRANSLATABLE= true |
| Key | boolean | true | None | OVERRIDABLE= false
|
| MaxLen | uint32 | 256 | None | None |
| Override | string | Name | TOSUBCLASS= false | None |
| OperatingStatus | uint16 |
| Description | string | OperatingStatus provides a current status value for the operational condition of the element and can be used for providing more detail with respect to the value of EnabledState. It can also provide the transitional states when an element is transitioning from one state to another, such as when an element is transitioning between EnabledState and RequestedState, as well as other transitional conditions.
OperatingStatus consists of one of the following values: Unknown, Not Available, In Service, Starting, Stopping, Stopped, Aborted, Dormant, Completed, Migrating, Emmigrating, Immigrating, Snapshotting. Shutting Down, In Test
A Null return indicates the implementation (provider) does not implement this property.
"Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
"None" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).
"Servicing" describes an element being configured, maintained, cleaned, or otherwise administered.
"Starting" describes an element being initialized.
"Stopping" describes an element being brought to an orderly stop.
"Stopped" and "Aborted" are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the state and configuration of the element might need to be updated.
"Dormant" indicates that the element is inactive or quiesced.
"Completed" indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded in the PrimaryStatus so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error).
"Migrating" element is being moved between host elements.
"Immigrating" element is being moved to new host element.
"Emigrating" element is being moved away from host element.
"Shutting Down" describes an element being brought to an abrupt stop.
"In Test" element is performing test functions.
"Transitioning" describes an element that is between states, that is, it is not fully available in either its previous state or its next state. This value should be used if other values indicating a transition to a specific state are not applicable.
"In Service" describes an element that is in service and operational. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_EnabledLogicalElement.EnabledState | None | None |
| ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, .., 0x8000.. | None | None |
| Values | string | Unknown, Not Available, Servicing, Starting, Stopping, Stopped, Aborted, Dormant, Completed, Migrating, Emigrating, Immigrating, Snapshotting, Shutting Down, In Test, Transitioning, In Service, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
| OperationalStatus | uint16 |
| ArrayType | string | Indexed | None | OVERRIDABLE= false
|
| Description | string | Indicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration's values are self-explanatory. However, a few are not and are described here in more detail.
"Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, and so on.
"Predictive Failure" indicates that an element is functioning nominally but predicting a failure in the near future.
"In Service" describes an element being configured, maintained, cleaned, or otherwise administered.
"No Contact" indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.
"Lost Communication" indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable.
"Stopped" and "Aborted" are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the state and configuration of the element might need to be updated.
"Dormant" indicates that the element is inactive or quiesced.
"Supporting Entity in Error" indicates that this element might be "OK" but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower-layer networking problems.
"Completed" indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error).
"Power Mode" indicates that the element has additional power model information contained in the Associated PowerManagementService association.
OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today's environment to the future. This change was not made earlier because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or instrumentation provide both the Status and OperationalStatus properties. Further, the first value of OperationalStatus should contain the primary status for the element. When instrumented, Status (because it is single-valued) should also provide the primary status of the element. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_ManagedSystemElement.StatusDescriptions | None | None |
| ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, .., 0x8000.. | None | None |
| Values | string | Unknown, Other, OK, Degraded, Stressed, Predictive Failure, Error, Non-Recoverable Error, Starting, Stopping, Stopped, In Service, No Contact, Lost Communication, Aborted, Dormant, Supporting Entity in Error, Completed, Power Mode, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
| OtherEnabledState | string |
| Description | string | A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to null when EnabledState is any value other than 1. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_EnabledLogicalElement.EnabledState | None | None |
| PrimaryOwnerContact | string |
| Description | string | A string that provides information on how the primary owner of the Service can be reached (for example, phone number, e-mail address, and so on). | None | TRANSLATABLE= true |
| MappingStrings | string | MIF.DMTF|General Information|001.4 | None | None |
| MaxLen | uint32 | 256 | None | None |
| Write | boolean | true | None | None |
| PrimaryOwnerName | string |
| Description | string | The name of the primary owner for the service, if one is defined. The primary owner is the initial support contact for the Service. | None | TRANSLATABLE= true |
| MappingStrings | string | MIF.DMTF|General Information|001.3 | None | None |
| MaxLen | uint32 | 64 | None | None |
| Write | boolean | true | None | None |
| PrimaryStatus | uint16 |
| Description | string | PrimaryStatus provides a high level status value, intended to align with Red-Yellow-Green type representation of status. It should be used in conjunction with DetailedStatus to provide high level and detailed health status of the ManagedElement and its subcomponents.
PrimaryStatus consists of one of the following values: Unknown, OK, Degraded or Error. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
"OK" indicates the ManagedElement is functioning normally.
"Degraded" indicates the ManagedElement is functioning below normal.
"Error" indicates the ManagedElement is in an Error condition. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_ManagedSystemElement.DetailedStatus, CIM_ManagedSystemElement.HealthState | None | None |
| ValueMap | string | 0, 1, 2, 3, .., 0x8000.. | None | None |
| Values | string | Unknown, OK, Degraded, Error, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
| RequestedState | uint16 |
| Description | string | RequestedState is an integer enumeration that indicates the last requested or desired state for the element, irrespective of the mechanism through which it was requested. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration.
"Unknown" (0) indicates the last requested state for the element is unknown.
Note that the value "No Change" (5) has been deprecated in lieu of indicating the last requested state is "Unknown" (0). If the last requested or desired state is unknown, RequestedState should have the value "Unknown" (0), but may have the value "No Change" (5).Offline (6) indicates that the element has been requested to transition to the Enabled but Offline EnabledState.
It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are "Reboot" (10) and "Reset" (11). Reboot refers to doing a "Shut Down" and then moving to an "Enabled" state. Reset indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests.
This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code.
If knowledge of the last RequestedState is not supported for the EnabledLogicalElement, the property shall be NULL or have the value 12 "Not Applicable". | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_EnabledLogicalElement.EnabledState | None | None |
| ValueMap | string | 0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, .., 32768..65535 | None | None |
| Values | string | Unknown, Enabled, Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot, Reset, Not Applicable, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
| Started | boolean |
| Description | string | Started is a Boolean that indicates whether the Service has been started (TRUE), or stopped (FALSE). | None | TRANSLATABLE= true |
| StartMode | string |
| Deprecated | string | CIM_Service.EnabledDefault | TOSUBCLASS= false | None |
| Description | string | Note: The use of this element is deprecated in lieu of the EnabledDefault property that is inherited from EnabledLogicalElement. The EnabledLogicalElement addresses the same semantics. The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property. To remain compatible with those implementations, StartMode was grandfathered into the schema. Use of the deprecated qualifier allows the maintenance of the existing property but also permits an improved, clarified definition using EnabledDefault.
Deprecated description: StartMode is a string value that indicates whether the Service is automatically started by a System, an Operating System, and so on, or is started only upon request. | None | TRANSLATABLE= true |
| MaxLen | uint32 | 10 | None | None |
| ValueMap | string | Automatic, Manual | None | None |
| Status | string |
| Deprecated | string | CIM_ManagedSystemElement.OperationalStatus | TOSUBCLASS= false | None |
| Description | string | A string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons:
1) Status is more correctly defined as an array. This definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped.
2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values.
3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus. | None | TRANSLATABLE= true |
| MaxLen | uint32 | 10 | None | None |
| ValueMap | string | OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, NonRecover, No Contact, Lost Comm, Stopped | None | None |
| StatusDescriptions | string |
| ArrayType | string | Indexed | None | OVERRIDABLE= false
|
| Description | string | Strings describing the various OperationalStatus array values. For example, if "Stopping" is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_ManagedSystemElement.OperationalStatus | None | None |
| SystemCreationClassName | string |
| Description | string | The CreationClassName of the scoping System. | None | TRANSLATABLE= true |
| Key | boolean | true | None | OVERRIDABLE= false
|
| MaxLen | uint32 | 256 | None | None |
| Propagated | string | CIM_System.CreationClassName | None | OVERRIDABLE= false
|
| SystemName | string |
| Description | string | The Name of the scoping System. | None | TRANSLATABLE= true |
| Key | boolean | true | None | OVERRIDABLE= false
|
| MaxLen | uint32 | 256 | None | None |
| Propagated | string | CIM_System.Name | None | OVERRIDABLE= false
|
| TimeOfLastStateChange | datetime |
| Description | string | The date or time when the EnabledState of the element last changed. If the state of the element has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated. | None | TRANSLATABLE= true |
| TransitioningToState | uint16 |
| Description | string | TransitioningToState indicates the target state to which the instance is transitioning.
A value of 5 "No Change" shall indicate that no transition is in progress.A value of 12 "Not Applicable" shall indicate the implementation does not support representing ongoing transitions.
A value other than 5 or 12 shall identify the state to which the element is in the process of transitioning. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_EnabledLogicalElement.RequestStateChange, CIM_EnabledLogicalElement.RequestedState, CIM_EnabledLogicalElement.EnabledState | None | None |
| ValueMap | string | 0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, .. | None | None |
| Values | string | Unknown, Enabled, Disabled, Shut Down, No Change, Offline, Test, Defer, Quiesce, Reboot, Reset, Not Applicable, DMTF Reserved | None | TRANSLATABLE= true |
| Method Name | Return Type | Qualifiers |
| Name | Data Type | Value | Scope | Flavors |
| AssignAccess() | uint32 |
| Description | string | Grants or removes access to the referenced CIM_OpaqueManagementData instance by the referenced CIM_Identity instance. | None | TRANSLATABLE= true |
| ValueMap | string | 0, 1, 2, 3..32767, 32768..65535 | None | None |
| Values | string | Completed with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Vendor Specified | None | TRANSLATABLE= true |
| Parameters | Qualifiers |
| Name | Data Type | Name | Data Type | Value | Scope | Flavors |
| Identity | CIM_Identity |
| Description | string | Reference to the CIM_Identity instance that is the subject of the access rights modified by this method. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| Required | boolean | true | None | OVERRIDABLE= false
|
| OpaqueManagementData | CIM_OpaqueManagementData |
| Description | string | Reference to the CIM_OpaqueManagementData instance that is the target of the access rights modified by this method. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| Required | boolean | true | None | OVERRIDABLE= false
|
| Activities | uint16 |
| Description | string | The subset of values from the value map that shall be contained in the resulting Activities property of the CIM_AssociatedPrivilege between the CIM_Identity instance referenced by the Identity parameter and the CIM_OpaqueManagementData instance referenced by the OpaqueManagementData parameter. If such an instance of CIM_AssociatedPrivilege does not exist before the method is invoked, the method shall create it. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| ModelCorrespondence | string | CIM_AssociatedPrivilege.Activities | None | None |
| Required | boolean | true | None | OVERRIDABLE= false
|
| ValueMap | string | 5, 6 | None | None |
| Values | string | Read, Write | None | TRANSLATABLE= true |
| Method Name | Return Type | Qualifiers |
| Name | Data Type | Value | Scope | Flavors |
| Create() | uint32 |
| Description | string | Create() creates an instance of CIM_OpaqueManagementData using the property values in the OpaqueManagementData parameter, and allocates the number of bytes of storage specified in the MaxSize property of the OpaqueManagementData parameter. It also optionally allows the client to specify an existing CIM_StorageExtent instance as the basis (storage location) of the new CIM_OpaqueManagementData instance. | None | TRANSLATABLE= true |
| ValueMap | string | 0, 1, 2, 3..4095, 4096, 4097..32767, 32768..65535 | None | None |
| Values | string | Completed with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specified | None | TRANSLATABLE= true |
| Parameters | Qualifiers |
| Name | Data Type | Name | Data Type | Value | Scope | Flavors |
| MaxSize | uint64 |
| Description | string | The requested value of the MaxSize property in the CIM_OpaqueManagementData instance created by this method. The actual property value shall not be less than this value. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| ModelCorrespondence | string | CIM_OpaqueManagementData.MaxSize | None | None |
| Required | boolean | true | None | OVERRIDABLE= false
|
| DataFormat | string |
| Description | string | The value of the DataFormat property in the CIM_OpaqueManagementData instance created by this method. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| ModelCorrespondence | string | CIM_OpaqueManagementData.DataFormat | None | None |
| ElementName | string |
| Description | string | The value of the ElementName property in the CIM_OpaqueManagementData instance created by this method. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| ModelCorrespondence | string | CIM_OpaqueManagementData.ElementName | None | None |
| Owner | CIM_Identity |
| Description | string | Specifies the instance of CIM_Identity or its subclass that shall be the owner of the new CIM_OpaqueManagementData instance. Create() shall associate the new CIM_OpaqueManagementData instance with this CIM_Identity instance using a new instance of CIM_AssociatedPrivilege. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| Required | boolean | true | None | OVERRIDABLE= false
|
| BasedOnExtent | CIM_StorageExtent |
| Description | string | Specifies the instance of CIM_StorageExtent on which the new instance of CIM_OpaqueManagementData shall be based (i.e., in which it shall be stored). If this parameter is NULL, the choice of storage location shall be left to the implementation. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| OpaqueManagementData | CIM_OpaqueManagementData |
| Description | string | Reference to the instance of CIM_OpaqueManagementData created when the method returns a value of 0. | None | TRANSLATABLE= true |
| IN | boolean | false | None | OVERRIDABLE= false
|
| OUT | boolean | true | None | OVERRIDABLE= false
|
| Job | CIM_ConcreteJob |
| Description | string | Reference to the job (may be null if job completed). | None | TRANSLATABLE= true |
| IN | boolean | false | None | OVERRIDABLE= false
|
| OUT | boolean | true | None | OVERRIDABLE= false
|
| Method Name | Return Type | Qualifiers |
| Name | Data Type | Value | Scope | Flavors |
| ExportToURI() | uint32 |
| Description | string | ExportToURI() copies all or some of the bytes of opaque management data in the extent represented by the referenced instance of CIM_OpaqueManagementData to the Uniform Resource Identifier (URI) specified in the ExportURI parameter. The URI scheme implies the protocol that shall be used. Typically, the URI will be a Uniform Resource Locator (URL), but a Uniform Resource Name (URN) is not prohibited.
If 0 is returned, the function completed successfully and no ConcreteJob instance was required. If 4096/0x1000 is returned, a ConcreteJob shall be started to to perform the operation. The Job's reference shall be returned in the output parameter Job. | None | TRANSLATABLE= true |
| ValueMap | string | 0, 1, 2, 3..4095, 4096, 4097..32767, 32768..65535 | None | None |
| Values | string | Completed with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specified | None | TRANSLATABLE= true |
| Parameters | Qualifiers |
| Name | Data Type | Name | Data Type | Value | Scope | Flavors |
| OpaqueManagementData | CIM_OpaqueManagementData |
| Description | string | The CIM_OpaqueManagementData instance that represents the extent that is the target of the operation. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| Required | boolean | true | None | OVERRIDABLE= false
|
| Offset | uint64 |
| Description | string | Offset specifies the byte offset at which to start reading. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| PUnit | string | byte | None | None |
| Required | boolean | true | None | OVERRIDABLE= false
|
| Length | uint64 |
| Description | string | On entry, Length contains the number of bytes to be read, starting at the byte offset in the Offset property. On return, Length contains the number of bytes that were actually read. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| OUT | boolean | true | None | OVERRIDABLE= false
|
| PUnit | string | byte | None | None |
| Required | boolean | true | None | OVERRIDABLE= false
|
| ExportURI | string |
| Description | string | On entry, ExportURI contains a URI based on RFC 3986 that indicates the location to which the service shall copy the specified bytes of opaque management data and from which the client subsequently retrieves them. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| ModelCorrespondence | string | CIM_OpaqueManagementDataCapabilities.SupportedExportURISchemes | None | None |
| Required | boolean | true | None | OVERRIDABLE= false
|
| LockToken | uint8 |
| Description | string | A token that represents a Lock placed on the data in the extent referenced by the OpaqueManagementData parameter, using the Lock() method. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| OctetString | boolean | true | None | OVERRIDABLE= false
|
| Job | CIM_ConcreteJob |
| Description | string | Reference to the job (may be null if job completed). | None | TRANSLATABLE= true |
| IN | boolean | false | None | OVERRIDABLE= false
|
| OUT | boolean | true | None | OVERRIDABLE= false
|
| Method Name | Return Type | Qualifiers |
| Name | Data Type | Value | Scope | Flavors |
| ImportFromURI() | uint32 |
| Description | string | ImportFromURI() modifies all or some of the bytes in the referenced instance of CIM_OpaqueManagementData. The imported data for the operation is copied from the URI specified in the ImportURI parameter. The URI scheme implies the protocol that shall be used. Typically, the URI will be a Uniform Resource Locator (URL), but a Uniform Resource Name (URN) is not prohibited.
Any data already present in the instance outside the range specified by Offset and Length is unchanged.
If 0 is returned, the function completed successfully and no ConcreteJob instance was required. If 4096/0x1000 is returned, a ConcreteJob shall be started to perform the operation. The Job's reference shall be returned in the output parameter Job. | None | TRANSLATABLE= true |
| ValueMap | string | 0, 1, 2, 3..4095, 4096, 4097..32767, 32768..65535 | None | None |
| Values | string | Completed with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specified | None | TRANSLATABLE= true |
| Parameters | Qualifiers |
| Name | Data Type | Name | Data Type | Value | Scope | Flavors |
| OpaqueManagementData | CIM_OpaqueManagementData |
| Description | string | The CIM_OpaqueManagementData instance that represents the extent that is the target of the operation. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| Required | boolean | true | None | OVERRIDABLE= false
|
| Offset | uint64 |
| Description | string | Offset specifies the byte offset at which to start writing. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| PUnit | string | byte | None | None |
| Required | boolean | true | None | OVERRIDABLE= false
|
| Length | uint64 |
| Description | string | On entry, Length contains the number of bytes to be written, starting at the byte offset in the Offset. property. On return, Length contains the number of bytes that were actually written. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| OUT | boolean | true | None | OVERRIDABLE= false
|
| PUnit | string | byte | None | None |
| Required | boolean | true | None | OVERRIDABLE= false
|
| Truncate | boolean |
| Description | string | If the value of the DataSize property of the instance referenced by the OpaqueManagementData parameter is greater than Offset + Length, then a value of TRUE shall indicate that the DataSize property value shall be reduced by this operation to Offset + Length, and a value of FALSE shall indicate that the DataSize property value shall remain unchanged by this operation. If the value of the DataSize property is not greater than Offset + Length, then this parameter shall be ignored. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| ModelCorrespondence | string | CIM_OpaqueManagementData.DataSize | None | None |
| ImportURI | string |
| Description | string | On entry, ImportURI contains a URI based on RFC 3986 that shall be used by the service to retrieve the bytes of opaque management data to be written into the extent represented by the OpaqueManagementData parameter. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| ModelCorrespondence | string | CIM_OpaqueManagementDataCapabilities.SupportedImportURISchemes | None | None |
| Required | boolean | true | None | OVERRIDABLE= false
|
| LockToken | uint8 |
| Description | string | A token that represents a Lock placed on the data in the extent referenced by the OpaqueManagementData parameter, using the Lock() method. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| OctetString | boolean | true | None | OVERRIDABLE= false
|
| Job | CIM_ConcreteJob |
| Description | string | Reference to the job (may be null if job completed). | None | TRANSLATABLE= true |
| IN | boolean | false | None | OVERRIDABLE= false
|
| OUT | boolean | true | None | OVERRIDABLE= false
|
| Method Name | Return Type | Qualifiers |
| Name | Data Type | Value | Scope | Flavors |
| Lock() | uint32 |
| Description | string | Lock() allows a management client to atomically read or write an opaque management data storage extent larger than MaxReadLength or MaxWriteLength, respectively. A server that supports this method shall support the following pattern:
1. Issue Lock() with Lock set to true to lock the CIM_OpaqueManagementData instance.
2. Repeat Read() or Write() as many times as necessary to complete the transfer
3. Issue Lock() with Lock set to false to unlock the CIM_OpaqueManagementData instance
If Lock() with Lock set to true completes successfully, the server shall return a LockToken to the client. Until the lock is removed or expires, the server shall deny OpaqueManagementDataService method requests on the same CIM_OpaqueManagementData instance that do not contain the same LockToken value.
Lock() shall not lock the properties of the OpaqueManagementData instance. The method shall return 0 if successful, 1 if not supported, and any other value if an error occurred. | None | TRANSLATABLE= true |
| ValueMap | string | 0, 1, 2, 3..32767, 32768..65535 | None | None |
| Values | string | Completed with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Vendor Specified | None | TRANSLATABLE= true |
| Parameters | Qualifiers |
| Name | Data Type | Name | Data Type | Value | Scope | Flavors |
| OpaqueManagementData | CIM_OpaqueManagementData |
| Description | string | The CIM_OpaqueManagementData instance that represents the extent that is the target of the operation. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| Required | boolean | true | None | OVERRIDABLE= false
|
| Lock | boolean |
| Description | string | If true, lock the data from access by another management client. If false, release the data. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| Required | boolean | true | None | OVERRIDABLE= false
|
| LockToken | uint8 |
| Description | string | A token that shall be returned to the client as output if Lock is True, and supplied by the client as input if Lock is False. In this way, only the client that set the Lock may remove it or delegate such responsibility to another client. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| OctetString | boolean | true | None | OVERRIDABLE= false
|
| OUT | boolean | true | None | OVERRIDABLE= false
|
| Method Name | Return Type | Qualifiers |
| Name | Data Type | Value | Scope | Flavors |
| Read() | uint32 |
| Description | string | Read() returns all or some of the bytes of opaque management data in the extent represented by the referenced instance of CIM_OpaqueManagementData. | None | TRANSLATABLE= true |
| ValueMap | string | 0, 1, 2, 3..32767, 32768..65535 | None | None |
| Values | string | Completed with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Vendor Specified | None | TRANSLATABLE= true |
| Parameters | Qualifiers |
| Name | Data Type | Name | Data Type | Value | Scope | Flavors |
| OpaqueManagementData | CIM_OpaqueManagementData |
| Description | string | The CIM_OpaqueManagementData instance that represents the extent that is the target of the operation. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| Required | boolean | true | None | OVERRIDABLE= false
|
| Offset | uint64 |
| Description | string | Offset specifies the byte offset at which to start reading. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| PUnit | string | byte | None | None |
| Required | boolean | true | None | OVERRIDABLE= false
|
| Length | uint64 |
| Description | string | On entry, Length shall contain the number of bytes to be read, starting at the byte offset in the Offset property. On return, Length shall contain the number of bytes that were actually read. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| ModelCorrespondence | string | CIM_OpaqueManagementDataCapabilities.MaxReadLength | None | None |
| OUT | boolean | true | None | OVERRIDABLE= false
|
| PUnit | string | byte | None | None |
| Required | boolean | true | None | OVERRIDABLE= false
|
| Data | uint8 |
| Description | string | On return, Data shall contain the bytes of opaque management data read from the extent represented by the OpaqueManagementData parameter. | None | TRANSLATABLE= true |
| IN | boolean | false | None | OVERRIDABLE= false
|
| OctetString | boolean | true | None | OVERRIDABLE= false
|
| OUT | boolean | true | None | OVERRIDABLE= false
|
| LockToken | uint8 |
| Description | string | A token that represents a Lock placed on the data in the extent referenced by the OpaqueManagementData parameter, using the Lock() method. Parameter shall be NULL if data is not locked. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| OctetString | boolean | true | None | OVERRIDABLE= false
|
| Method Name | Return Type | Qualifiers |
| Name | Data Type | Value | Scope | Flavors |
| ReassignOwnership() | uint32 |
| Description | string | Transfers ownership of a CIM_OpaqueManagementData instance to the CIM_Identity instance referenced by the Identity parameter. | None | TRANSLATABLE= true |
| ValueMap | string | 0, 1, 2, 3..32767, 32768..65535 | None | None |
| Values | string | Completed with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Vendor Specified | None | TRANSLATABLE= true |
| Parameters | Qualifiers |
| Name | Data Type | Name | Data Type | Value | Scope | Flavors |
| NewOwner | CIM_Identity |
| Description | string | Reference to the CIM_Identity instance that will become the new owner of the CIM_OpaqueManagementData instance referenced by the OpaqueManagementData parameter. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| Required | boolean | true | None | OVERRIDABLE= false
|
| OpaqueManagementData | CIM_OpaqueManagementData |
| Description | string | Reference to the CIM_OpaqueManagementData instance that is the target of ownership reassignment. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| Required | boolean | true | None | OVERRIDABLE= false
|
| Method Name | Return Type | Qualifiers |
| Name | Data Type | Value | Scope | Flavors |
| Write() | uint32 |
| Description | string | Write() modifies all or some of the bytes in the extent represented by the referenced instance of CIM_OpaqueManagementData. Any data already present in the extent outside the range specified by Offset and Length shall remain unchanged by this operation. | None | TRANSLATABLE= true |
| ValueMap | string | 0, 1, 2, 3..4095, 4096, 4097..32767, 32768..65535 | None | None |
| Values | string | Completed with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specified | None | TRANSLATABLE= true |
| Parameters | Qualifiers |
| Name | Data Type | Name | Data Type | Value | Scope | Flavors |
| OpaqueManagementData | CIM_OpaqueManagementData |
| Description | string | The CIM_OpaqueManagementData instance that represents the extent that is the target of the operation. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| Required | boolean | true | None | OVERRIDABLE= false
|
| Offset | uint64 |
| Description | string | Offset specifies the byte offset at which to start writing. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| PUnit | string | byte | None | None |
| Required | boolean | true | None | OVERRIDABLE= false
|
| Length | uint64 |
| Description | string | On entry, Length contains the number of bytes to be written, starting at the byte offset in the Offset. property. On return, Length contains the number of bytes that were actually written. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| ModelCorrespondence | string | CIM_OpaqueManagementDataCapabilities.MaxWriteLength | None | None |
| OUT | boolean | true | None | OVERRIDABLE= false
|
| PUnit | string | byte | None | None |
| Required | boolean | true | None | OVERRIDABLE= false
|
| Truncate | boolean |
| Description | string | If the value of the DataSize property of the instance referenced by the OpaqueManagementData parameter is greater than Offset + Length, then a value of TRUE shall indicate that the DataSize property value shall be reduced by this operation to Offset + Length, and a value of FALSE shall indicate that the DataSize property value shall remain unchanged by this operation. If the value of the DataSize property is not greater than Offset + Length, then this parameter shall be ignored. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| ModelCorrespondence | string | CIM_OpaqueManagementData.DataSize | None | None |
| Data | uint8 |
| Description | string | On entry, Data contains the bytes of opaque management data to be written into the extent represented by the OpaqueManagementData parameter. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| OctetString | boolean | true | None | OVERRIDABLE= false
|
| Required | boolean | true | None | OVERRIDABLE= false
|
| LockToken | uint8 |
| Description | string | A token that represents a Lock placed on the data in the extent referenced by the OpaqueManagementData parameter, using the Lock() method. | None | TRANSLATABLE= true |
| IN | boolean | true | None | OVERRIDABLE= false
|
| OctetString | boolean | true | None | OVERRIDABLE= false
|
| Job | CIM_ConcreteJob |
| Description | string | Reference to the job (may be null if job completed). | None | TRANSLATABLE= true |
| IN | boolean | false | None | OVERRIDABLE= false
|
| OUT | boolean | true | None | OVERRIDABLE= false
|
Copyright © 2008-2016 VMware, Inc. All rights reserved.