Class CIM_BlockStatisticsService
extends CIM_StatisticsService

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

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_BlockStatisticsService

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 BlockStatisticalData.
UMLPackagePathstringCIM::Device::StorageStatistics
Versionstring2.39.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 BlockStatisticsManifestCollection. If both the Elements and BlockStatisticsManifestCollection 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 BlockStatisticsManifest instances exist in the supplied BlockStatisticsManifestCollection. 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.
INbooleantrue
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).
INbooleantrue
ModelCorrespondencestringCIM_BlockStorageStatisticalData.ElementType
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, .., 0x8000..
ValuesstringComputer System, Front-end Computer System, Peer Computer System, Back-end Computer System, Front-end Port, Back-end Port, Volume, Extent, Disk Drive, Arbitrary LUs, Remote Replica Group, DMTF Reserved, Vendor Specific
Statisticsstring[]
DescriptionstringThe statistics for all the elements as determined by the Elements, ManifestCollection parameters, and StatisticsFormat parameters.
ModelCorrespondencestringCIM_BlockStatisticsService.GetStatisticsCollection(ElementTypes), CIM_BlockStatisticsService.GetStatisticsCollection(ManifestCollection), CIM_BlockStatisticsService.GetStatisticsCollection(StatisticsFormat)
OUTbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
ManifestCollection REF CIM_BlockStatisticsManifestCollection
DescriptionstringThe BlockStatisticsManifestCollection 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 BlockStatisticsManifest instances contained within the BlockStatisticsManifestCollection will have data returned by this method. If the supplied BlockStatisticsManifestCollection does not contain any BlockStatisticsManifest instances, then no statistics will be returned by this method.
INbooleantrue

CreateManifestCollection (uint32)

Method Qualifiers (CreateManifestCollection)

NameData TypeValue
DescriptionstringCreates a new BlockStatisticsManifestCollection 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 BlockStatisticsManifestCollection.
INbooleantrue
ManifestCollection REF CIM_BlockStatisticsManifestCollection
DescriptionstringReference to the new BlockStatisticsManifestCollection.
OUTbooleantrue
Statistics REF CIM_StatisticsCollection
DescriptionstringThe collection of statistics that will be filtered using the new BlockStatisticsManifestCollection.
INbooleantrue

AddOrModifyManifest (uint32)

Method Qualifiers (AddOrModifyManifest)

NameData TypeValue
DescriptionstringMethod that creates or modifies a BlockStatisticsManifest for this statistics service. A client supplies a BlockStatisticsManifestCollection in which the new BlockStatisticsManifest will be placed or an existing BlockStatisticsManifest will be modified, the element type of the statistics that the BlockStatisticsManifest 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 BlockStatisticsManifest created or modified by this method.
INbooleantrue
ElementTypeuint16
DescriptionstringThe type of elements whose statistics the BlockStatisticsManifest will filter.
INbooleantrue
ModelCorrespondencestringCIM_BlockStatisticsManifest.ElementType, CIM_BlockStatisticsManifest.RateElementType
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, .., 0x8000..
ValuesstringComputer System, Front-end Computer System, Peer Computer System, Back-end Computer System, Front-end Port, Back-end Port, Volume, Extent, Disk Drive, Arbitrary LUs, Remote Replica Group, Computer System Rate, Front-end Computer System Rate, Peer Computer System Rate, Back-end Computer System Rate, Front-end Port Rate, Back-end Port Rate, Volume Rate, Extent Rate, Disk Drive Rate, Arbitrary LUs Rate, Remote Replica Group Rate, 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 BlockStatisticsManifest filter is applied.
INbooleantrue
Manifest REF CIM_BlockStatisticsManifest
DescriptionstringThe BlockStatisticsManifest that is created or modified on successful execution of the method.
OUTbooleantrue
ManifestCollection REF CIM_BlockStatisticsManifestCollection
DescriptionstringBlockStatisticsManifestCollection that the BlockStatisticsManifest is or should be a member of.
INbooleantrue

RemoveManifests (uint32)

Method Qualifiers (RemoveManifests)

NameData TypeValue
DescriptionstringExtrinsic method that removes manifests from a BlockStatisticsManifestCollection.
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_BlockStatisticsManifest[]
DescriptionstringList of BlockStatisticsManifests to be removed from the BlockStatisticsManifestCollection.
INbooleantrue
ManifestCollection REF CIM_BlockStatisticsManifestCollection
DescriptionstringBlockStatisticsManifestCollection from which the BlockStatisticsManifests will be removed.
INbooleantrue

GetRateStatisticsCollection (uint32)

Method Qualifiers (GetRateStatisticsCollection)

NameData TypeValue
DescriptionstringRetrieves rated 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 BlockStatisticsManifestCollection. If both the Elements and BlockStatisticsManifestCollection 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 BlockStatisticsManifest instances exist in the supplied BlockStatisticsManifestCollection. 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.
Experimentalbooleantrue
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 (GetRateStatisticsCollection)

NameTypeQualifiers
NameData TypeValue
RateIntervalEndTimedatetime
DescriptionstringThe end time for the rate data interval.If not supplied, the returned data would be for the most recent interval.
INbooleantrue
RateIntervalStartTimedatetime
DescriptionstringThe start time for the rate data interval.If not supplied, the returned data would be for the most recent interval.
INbooleantrue
StatisticsFormatuint16
DescriptionstringSpecifies the format of the Statistics output parameter. - CSV = Comma Separated Values.
INbooleantrue
ValueMapstring0, 1, 2, .., 0x8000..
ValuesstringUnknown, Other, CSV, DMTF Reserved, Vendor Specific
RateElementTypesuint16[]
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). Note: ValueMap begins with 13 to match the ElementTypes in the capabilities class.
INbooleantrue
ModelCorrespondencestringCIM_BlockStorageStatisticalData.RateElementType
ValueMapstring13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 25, .., 0x8000..
ValuesstringComputer System Rate, Front-end Computer System Rate, Peer Computer System Rate, Back-end Computer System Rate, Front-end Port Rate, Back-end Port Rate, Volume Rate, Extent Rate, Disk Drive Rate, Arbitrary LUs Rate, Remote Replica Group Rate, Device Masking Group Rate, DMTF Reserved, Vendor Specific
Statisticsstring[]
DescriptionstringThe statistics for all the elements as determined by the Elements, ManifestCollection parameters, and StatisticsFormat parameters.
OUTbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
ManifestCollection REF CIM_BlockStatisticsManifestCollection
DescriptionstringThe BlockStatisticsManifestCollection 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 BlockStatisticsManifest instances contained within the BlockStatisticsManifestCollection will have data returned by this method. If the supplied BlockStatisticsManifestCollection does not contain any BlockStatisticsManifest instances, then no statistics will be returned by this method.
INbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service