Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_PowerManagementCapabilities --> CIM_Capabilities --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_Capabilities NAME CIM_PowerManagementCapabilities
Class CIM_PowerManagementCapabilities Qualifiers Name Type Value From Class Version string 2.11.0 CIM_PowerManagementCapabilities Description string A class derived from Capabilities that describes the power management aspects of an element (typically a system or device). The power management capabilities of the element are decoupled from a PowerManagementService, because a single service could apply to multiple elements, each with specific capabilities. CIM_PowerManagementCapabilities Description string Capabilities is an abstract class whose subclasses describe abilities and/or potential for use. For example, one may describe the maximum number of VLANs that can be supported on a system using a subclass of Capabilities. Capabilities are tied to the elements which they describe using the ElementCapabilities association. Note that the cardinality of the ManagedElement reference is Min(1), Max(1). This cardinality mandates the instantiation of the ElementCapabilities association for the referenced instance of Capabilities. ElementCapabilities describes the existence requirements and context for the referenced instance of ManagedElement. Specifically, the ManagedElement MUST exist and provides the context for the Capabilities. Note that Capabilities do not indicate what IS configured or operational, but what CAN or CANNOT exist, be defined or be used. Note that it is possible to describe both supported and excluded abilities and functions (both capabilities and limitations) using this class. CIM_Capabilities Description string ManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement
Properties Name Type Value Qualifiers ClassOrigin PowerCapabilities uint16[] Description
ValueMap
Values
MappingStrings
ModelCorrespondenceCIM_PowerManagementCapabilities OtherPowerCapabilitiesDescriptions string[] Description
ModelCorrespondenceCIM_PowerManagementCapabilities PowerStatesSupported uint16[] Experimental
Description
ValueMap
Values
MappingStrings
ModelCorrespondenceCIM_PowerManagementCapabilities PowerChangeCapabilities uint16[] Experimental
Description
ValueMap
Values
ModelCorrespondenceCIM_PowerManagementCapabilities OtherPowerChangeCapabilities string Experimental
Description
ModelCorrespondenceCIM_PowerManagementCapabilities InstanceID string Key
DescriptionCIM_Capabilities ElementName string Required
Override
DescriptionCIM_Capabilities Caption string Description
MaxLenCIM_ManagedElement Description string Description CIM_ManagedElement Property Qualifiers
Property PowerCapabilities Qualifiers Name Type Value From Class Description string An enumeration indicating the specific power-related capabilities of a managed element. Because this is an array, multiple values can be specified. The current values in the enumeration are: 0=Unknown 1=Other 2=Power Saving Modes Entered Automatically, indicating that a managed element can change its power state based on usage or other criteria 3=Power State Settable, indicating that the SetPowerState method is supported 4=Power Cycling Supported, indicating that the SetPowerState method can be invoked with the PowerState input variable set to ’ Power Cycle ’ 5=Timed Power On Supported, indicating that the SetPowerState method can be invoked with the PowerState input variable set to ’ Power Cycle ’ and the Time parameter set to a specific date and time, or interval, for power-on. CIM_PowerManagementCapabilities ValueMap string [See below.] CIM_PowerManagementCapabilities Values string Unknown
Other
Power Saving Modes Entered Automatically
Power State Settable
Power Cycling Supported
Timed Power On SupportedCIM_PowerManagementCapabilities MappingStrings string MIF.DMTF|System Power Controls|001.2 CIM_PowerManagementCapabilities ModelCorrespondence string CIM_PowerManagementCapabilities.OtherPowerCapabilitiesDescriptions
CIM_PowerManagementService.SetPowerStateCIM_PowerManagementCapabilities
Name Value 0 Unknown 1 Other 2 Power Saving Modes Entered Automatically 3 Power State Settable 4 Power Cycling Supported 5 Timed Power On Supported
Property OtherPowerCapabilitiesDescriptions Qualifiers Name Type Value From Class Description string An array of strings that describes the additional power management capabilities of an element, used when the PowerCapabilities array includes the value 1, " Other " . CIM_PowerManagementCapabilities ModelCorrespondence string CIM_PowerManagementCapabilities.PowerCapabilities CIM_PowerManagementCapabilities
Property PowerStatesSupported Qualifiers Name Type Value From Class Description string An enumeration that indicates the power states supported by a managed element. Because this is an array, multiple values can be specified. The current values in the enumeration are: 0=On, corresponding to ACPI state G0 or S0 or D0. 1=Sleep - Light, corresponding to ACPI state G1, S1/S2, or D1. 2=Sleep - Deep, corresponding to ACPI state G1, S3, or D2. 3=Off - Soft, corresponding to ACPI state G2, S5, or D3. 4=Power Cycle (Off - Soft), corresponding to ACPI state G2, S5, or D3, but where the managed element is set to return to power state " On " at a pre-determined time. 5=Hibernate (Off - Soft), corresponding to ACPI state S4, where the state of the managed element is preserved and will be recovered upon powering on. 6=Off - Hard, corresponding to ACPI state G3, S5, or D3. ..=DMTF Reserved. 0x7FFF..0xFFFF = Vendor Specific. CIM_PowerManagementCapabilities ValueMap string [See below.] CIM_PowerManagementCapabilities Values string On
Sleep - Light
Sleep - Deep
Off - Soft
Power Cycle (Off - Soft)
Hibernate (Off - Soft)
Off - Hard
DMTF Reserved
Vendor SpecificCIM_PowerManagementCapabilities MappingStrings string IEEE P1621 | 3.2 CIM_PowerManagementCapabilities ModelCorrespondence string CIM_PowerManagementService.SetPowerState CIM_PowerManagementCapabilities
Name Value 0 On 1 Sleep - Light 2 Sleep - Deep 3 Off - Soft 4 Power Cycle (Off - Soft) 5 Hibernate (Off - Soft) 6 Off - Hard .. DMTF Reserved 0x7FFF..0xFFFF Vendor Specific
Property PowerChangeCapabilities Qualifiers Name Type Value From Class Description string An enumeration indicating the specific power-related capabilities of a managed element. Since this is an array, multiple values may be specified. The current values in the enumeration are: 0 = Unknown 1 = Other 2 = Power Saving Modes Entered Automatically, describing that a managed element can change its power state based on usage or other criteria 3 = Power State Settable, indicating that the RequestPowerStateChange method is supported 4 = Power Cycling Supported, indicating that the RequestPowerStateChange method can be invoked with the PowerState input variable set to ’ Power Cycle (Off Soft) ’ 5 = Timed Power On Supported, indicating that the RequestPowerStateChange method can be invoked with the PowerState input variable set to ’ Power On ’ and the Time parameter set to a specific date and time, or interval, for power-on. CIM_PowerManagementCapabilities ValueMap string [See below.] CIM_PowerManagementCapabilities Values string Unknown
Other
Power Saving Modes Entered Automatically
Power State Settable
Power Cycling Supported
Timed Power On Supported
Off Hard Power Cycling Supported
HW Reset SupportedCIM_PowerManagementCapabilities ModelCorrespondence string CIM_PowerManagementService.RequestPowerStateChange
CIM_PowerManagementCapabilities.OtherPowerChangeCapabilitiesCIM_PowerManagementCapabilities
Name Value 0 Unknown 1 Other 2 Power Saving Modes Entered Automatically 3 Power State Settable 4 Power Cycling Supported 5 Timed Power On Supported 6 Off Hard Power Cycling Supported 7 HW Reset Supported
Property OtherPowerChangeCapabilities Qualifiers Name Type Value From Class Description string A string describing the additional power management capabilities of the element, used when the PowerChangeCapabilities is set to the value 1, " Other " . CIM_PowerManagementCapabilities ModelCorrespondence string CIM_PowerManagementCapabilities.PowerChangeCapabilities CIM_PowerManagementCapabilities
Property InstanceID Qualifiers Name Type Value From Class Key boolean true CIM_Capabilities Description string Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order 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 creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This 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 re-used to identify different underlying (real-world) elements. If the above ’ preferred ’ algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance ’ s NameSpace. For DMTF defined instances, the ’ preferred ’ algorithm MUST be used with the < OrgID > set to ’ CIM ’ . CIM_Capabilities
Property ElementName Qualifiers Name Type Value From Class Required boolean true CIM_Capabilities Override string ElementName CIM_Capabilities Description string The user friendly name for this instance of Capabilities. In addition, the user friendly name can be used as a index property for a search of query. (Note: Name does not have to be unique within a namespace.) CIM_Capabilities
Property Caption Qualifiers Name Type Value From Class Description string The Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement MaxLen uint32 64 CIM_ManagedElement
Property Description Qualifiers Name Type Value From Class Description string The Description property provides a textual description of the object. CIM_ManagedElement
Property ElementName Qualifiers Name Type Value From Class 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. CIM_ManagedElement
Name Type Value Qualifiers Parameters ClassOrigin CreateGoalSettings uint16 Experimental
Description
ValueMap
ValuesTemplateGoalSettings
SupportedGoalSettingsCIM_Capabilities Method Qualifiers
Method CreateGoalSettings Qualifiers Name Type Value From Class Description string Method to create a set of supported SettingData elements, from two sets of SettingData elements, provided by the caller. CreateGoal should be used when the SettingData instances that represents the goal will not persist beyond the execution of the client and where those instances are not intended to be shared with other, non-cooperating clients. Both TemplateGoalSettings and SupportedGoalSettings are represented as strings containing EmbeddedInstances of a CIM_SettingData subclass. These embedded instances do not exist in the infrastructure supporting this method but are maintained by the caller/client. This method should return CIM_Error(s) representing that a single named property of a setting (or other) parameter (either reference or embedded object) has an invalid value or that an invalid combination of named properties of a setting (or other) parameter (either reference or embedded object) has been requested. If the input TemplateGoalSettings is NULL or the empty string, this method returns a default SettingData element that is supported by this Capabilities element. If the TemplateGoalSettings specifies values that cannot be supported, this method shall return an appropriate CIM_Error and should return a best match for a SupportedGoalSettings. The client proposes a goal using the TemplateGoalSettings parameter and gets back Success if the TemplateGoalSettings is exactly supportable. It gets back " Alternative Proposed " if the output SupportedGoalSettings represents a supported alternative. This alternative should be a best match, as defined by the implementation. If the implementation is conformant to a RegisteredProfile, then that profile may specify the algorithms used to determine best match. A client may compare the returned value of each property against the requested value to determine if it is left unchanged, degraded or upgraded. Otherwise, if the TemplateGoalSettings is not applicable an " Invalid Parameter " error is returned. When a mutually acceptable SupportedGoalSettings has been achieved, the client may use the contained SettingData instances as input to methods for creating a new object ormodifying an existing object. Also the embedded SettingData instances returned in the SupportedGoalSettings may be instantiated via CreateInstance, either by a client or as a side-effect of the execution of an extrinsic method for which the returned SupportedGoalSettings is passed as an embedded instance. CIM_Capabilities ValueMap string [See below.] CIM_Capabilities Values string Success
Not Supported
Unknown
Timeout
Failed
Invalid Parameter
Alternative Proposed
DMTF Reserved
Vendor SpecificCIM_Capabilities Parameters
Method CreateGoalSettings Parameters Name Type Qualifiers TemplateGoalSettings string IN
Description
EmbeddedInstanceSupportedGoalSettings string IN
OUT
Description
EmbeddedInstanceParameter Qualifiers
Parameter TemplateGoalSettings Qualifiers Name Type Value From Class IN boolean true CIM_Capabilities Description string If provided, TemplateGoalSettings are elements of class CIM_SettingData, or a derived class, that is used as the template to be matched. . At most, one instance of each SettingData subclass may be supplied. All SettingData instances provided by this property are interpreted as a set, relative to this Capabilities instance. SettingData instances that are not relevant to this instance are ignored. If not provided, it shall be set to NULL. In that case, a SettingData instance representing the default settings of the associated ManagedElement is used. CIM_Capabilities EmbeddedInstance string CIM_SettingData CIM_Capabilities
Parameter SupportedGoalSettings Qualifiers Name Type Value From Class IN boolean true CIM_Capabilities OUT boolean true CIM_Capabilities Description string SupportedGoalSettings are elements of class CIM_SettingData, or a derived class. At most, one instance of each SettingData subclass may be supplied. All SettingData instances provided by this property are interpreted as a set, relative to this Capabilities instance. To enable a client to provide additional information towards achieving the TemplateGoalSettings, an input set of SettingData instances may be provided. If not provided, this property shall be set to NULL on input.. Note that when provided, what property values are changed, and how, is implementation dependent and may be the subject of other standards. If provided, the input SettingData instances must be ones that the implementation is able to support relative to the ManagedElement associated via ElementCapabilities. Typically, the input SettingData instances are created by a previous instantiation of CreateGoalSettings. If the input SupportedGoalSettings is not supported by the implementation, then an " Invalid Parameter " (5) error is returned by this call. In this case, a corresponding CIM_ERROR should also be returned. On output, this property is used to return the best supported match to the TemplateGoalSettings. If the output SupportedGoalSettings matches the input SupportedGoalSettings, then the implementation is unable to improve further towards meeting the TemplateGoalSettings. CIM_Capabilities EmbeddedInstance string CIM_SettingData CIM_Capabilities