Class CIM_OperationalPowerStatisticsService
extends CIM_StatisticsService

A subclass of StatisticsService that provides services for filtering and retrieving statistics from a StatisticsManifestCollection that contains instances of OperationalPowerStatisticalData.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_Service
   |
   +--CIM_StatisticsService
   |
   +--CIM_OperationalPowerStatisticsService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringA subclass of StatisticsService that provides services for filtering and retrieving statistics from a StatisticsManifestCollection that contains instances of OperationalPowerStatisticalData.
UMLPackagePathstringCIM::Device::Power
Versionstring2.45.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LoSIDstringCIM_Service
LoSOrgIDstringCIM_Service
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

GetStatisticsCollection (uint32)

Method Qualifiers (GetStatisticsCollection)

NameData TypeValue
DescriptionstringRetrieves statistics in a well-defined bulk format. The collection of statistics returned is determined by the list of element types passed in to the method and the manifests for those types contained in the supplied OperationalPowerManifestCollection. If both the Elements and OperationalPowerManifestCollection parameters are supplied, then the types of elements returned is an intersection of the element types listed in the Elements parameter and the types for which OperationalPowerManifest instances exist in the supplied OperationalPowersManifestCollection. The statistics are returned through a well-defined array of strings, whose format is specified by the StatisticsFormat parameter, that can be parsed to retrieve the desired statistics as well as limited information about the elements that those metrics describe.
ValueMapstring0, 1, 2, 3, 4, 5, .., 4096, 4097, 4098, 4099..32767, 32768..65535
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Method Reserved, Method Parameters Checked - Job Started, Element Not Supported, Statistics Format Not Supported, Method Reserved, Vendor Specific

Method Parameters (GetStatisticsCollection)

NameTypeQualifiers
NameData TypeValue
StatisticsFormatuint16
DescriptionstringSpecifies the format of the Statistics output parameter. - CSV = Comma Separated Values.
ValueMapstring0, 1, 2, .., 0x8000..
ValuesstringUnknown, Other, CSV, DMTF Reserved, Vendor Specific
ElementTypesuint16[]
DescriptionstringElement types for which statistics should be returned. If not supplied (i.e. parameter is null) this parameter is not considered when filtering the instances of StatisticalData that will populate the Statistics output parameter. If the array is not null, but is empty, then no statistics will be returned by this method. A client SHOULD NOT specify this parameter if it is not meaningful (i.e. the service only provides statistics for a single type of element).
ModelCorrespondencestringCIM_OperationalPowerStatisticalData.ElementType
ValueMapstring2, 10, 201, 202, 203, 204, 205, 206, 207, .., 0x8000..
ValuesstringComputer System, Disk Drive, PDU, Power Supply, Fan, CPU, RAID Group, Disk Tray, Controller, DMTF Reserved, Vendor Specific
Statisticsstring[]
DescriptionstringThe statistics for all the elements as determined by the Elements, ManifestCollection parameters, and StatisticsFormat parameters.
ModelCorrespondencestringCIM_OperationalPowerStatisticsService.GetStatisticsCollection(ElementTypes), CIM_OperationalPowerStatisticsService.GetStatisticsCollection(ManifestCollection), CIM_OperationalPowerStatisticsService.GetStatisticsCollection(StatisticsFormat)
OUTbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
ManifestCollection REF CIM_OperationalPowerManifestCollection
DescriptionstringThe OperationalPowerManifestCollection that contains the manifests that list the metrics to be returned for each element type. If not supplied (i.e. parameter is null), then all available statistics will be returned unfiltered. Only elements that match the element type properties (if meaningful) of the OperationalPowerManifest instances contained within the OperationalPowerManifestCollection will have data returned by this method. If the supplied OperationalPowerManifestCollection does not contain any OperationalPowerStatisticsManifest instances, then no statistics will be returned by this method.

CreateManifestCollection (uint32)

Method Qualifiers (CreateManifestCollection)

NameData TypeValue
DescriptionstringCreates a new OperationalPowerManifestCollection instance, whose members can serve as a filter for metrics retrieved through the GetStatisticsCollection method.
ValueMapstring0, 1, 2, 3, 4, 5, 6..32767, 32768..65535
ValuesstringOk, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Method Reserved, Vendor Specific

Method Parameters (CreateManifestCollection)

NameTypeQualifiers
NameData TypeValue
ElementNamestring
DescriptionstringClient-defined name for the new OperationalPowerManifestCollection.
ManifestCollection REF CIM_OperationalPowerManifestCollection
DescriptionstringReference to the new OperationalPowerManifestCollection.
OUTbooleantrue
Statistics REF CIM_StatisticsCollection
DescriptionstringThe collection of statistics that will be filtered using the new OperationalPowerManifestCollection.

AddOrModifyManifest (uint32)

Method Qualifiers (AddOrModifyManifest)

NameData TypeValue
DescriptionstringMethod that creates or modifies a OperationalPowerManifest for this statistics service. A client supplies a OperationalPowerManifestCollection in which the new OperationalPowerManifest will be placed or an existing OperationalPowerManifest will be modified, the element type of the statistics that the OperationalPowerManifest will filter, and a list of metrics, which serves as a filter for statistical data of that element type.
ValueMapstring0, 1, 2, 3, 4, 5, .., 4096, 4097, 4098, 4099..32767, 32768..65535
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Method Reserved, Element Not Supported, Metric not supported, ElementType Parameter Missing, Method Reserved, Vendor Specific

Method Parameters (AddOrModifyManifest)

NameTypeQualifiers
NameData TypeValue
ElementNamestring
DescriptionstringA client-defined string that identifies the OperationalPowerManifest created or modified by this method.
ElementTypeuint16
DescriptionstringThe type of elements whose statistics the OperationalPowerManifest will filter.
ModelCorrespondencestringCIM_OperationalPowerManifest.ElementType
ValueMapstring2, 10, 201, 202, 203, 204, 205, 206, 207, .., 0x8000..
ValuesstringComputer System, Disk Drive, PDU, Power Supply, Fan, CPU, RAID Group, Disk Tray, Controller, DMTF Reserved, Vendor Specific
StatisticsListstring[]
DescriptionstringThe metrics that will be included by the filter. The metrics supplied here are the properties of CIM_StatisticalData or one of its subclasses that will remain after the OperationalPowerManifest filter is applied.
Manifest REF CIM_OperationalPowerManifest
DescriptionstringThe OperationalPowerManifest that is created or modified on successful execution of the method.
OUTbooleantrue
ManifestCollection REF CIM_OperationalPowerManifestCollection
DescriptionstringOperationalPowerManifestCollection that the OperationalPowerManifest is or should be a member of.

RemoveManifests (uint32)

Method Qualifiers (RemoveManifests)

NameData TypeValue
DescriptionstringExtrinsic method that removes manifests from a OperationalPowerManifestCollection.
ValueMapstring0, 1, 2, 3, 4, 5, .., 4096, 4097..32767, 32768..65535
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Method Reserved, Manifest not found, Method Reserved, Vendor Specific

Method Parameters (RemoveManifests)

NameTypeQualifiers
NameData TypeValue
ManifestsCIM_OperationalPowerManifest[]
DescriptionstringList of OperationalPowerManifests to be removed from the OperationalPowerManifestCollection.
ManifestCollection REF CIM_OperationalPowerManifestCollection
DescriptionstringOperationalPowerManifestCollection from which the OperationalPowerManifests will be removed.

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service