# 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

Name | Data Type | Value
--- | --- | ---
Description | string | A subclass of StatisticsService that provides services for filtering and retrieving statistics from a StatisticsManifestCollection that contains instances of BlockStatisticalData.
UMLPackagePath | string | CIM::Device::StorageStatistics
Version | string | 2.39.0

## Class Properties

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_Service
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
Generation | uint64 | CIM_ManagedElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
LoSID | string | CIM_Service
LoSOrgID | string | CIM_Service
Name | string | CIM_Service
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
PrimaryOwnerContact | string | CIM_Service
PrimaryOwnerName | string | CIM_Service
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
Started | boolean | CIM_Service
StartMode | string | CIM_Service
Status | string | CIM_ManagedSystemElement
SystemCreationClassName | string | CIM_Service
SystemName | string | CIM_Service
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Local Class Methods

#### GetStatisticsCollection (uint32)

#### Method Qualifiers (GetStatisticsCollection)

Name | Data Type | Value
--- | --- | ---
Description | string | Retrieves 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.
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 4096, 4097, 4098, 4099..32767, 32768..65535
Values | string | Job 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)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
StatisticsFormat | uint16
Description | string | Specifies the format of the Statistics output parameter. - CSV = Comma Separated Values.
IN | boolean | true
ValueMap | string | 0, 1, 2, .., 0x8000..
Values | string | Unknown, Other, CSV, DMTF Reserved, Vendor Specific
ElementTypes | uint16[]
Description | string | Element 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).
IN | boolean | true
ModelCorrespondence | string | CIM_BlockStorageStatisticalData.ElementType
ValueMap | string | 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, .., 0x8000..
Values | string | Computer 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
Statistics | string[]
Description | string | The statistics for all the elements as determined by the Elements, ManifestCollection parameters, and StatisticsFormat parameters.
ModelCorrespondence | string | CIM_BlockStatisticsService.GetStatisticsCollection(ElementTypes), CIM_BlockStatisticsService.GetStatisticsCollection(ManifestCollection), CIM_BlockStatisticsService.GetStatisticsCollection(StatisticsFormat)
OUT | boolean | true
Job | REF CIM_ConcreteJob
Description | string | Reference to the job (may be null if job completed).
IN | boolean | false
OUT | boolean | true
ManifestCollection | REF CIM_BlockStatisticsManifestCollection
Description | string | The 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.
IN | boolean | true

#### CreateManifestCollection (uint32)

#### Method Qualifiers (CreateManifestCollection)

Name | Data Type | Value
--- | --- | ---
Description | string | Creates a new BlockStatisticsManifestCollection instance, whose members can serve as a filter for metrics retrieved through the GetStatisticsCollection method.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6..32767, 32768..65535
Values | string | Ok, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Method Reserved, Vendor Specific

#### Method Parameters (CreateManifestCollection)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
ElementName | string
Description | string | Client-defined name for the new BlockStatisticsManifestCollection.
IN | boolean | true
ManifestCollection | REF CIM_BlockStatisticsManifestCollection
Description | string | Reference to the new BlockStatisticsManifestCollection.
OUT | boolean | true
Statistics | REF CIM_StatisticsCollection
Description | string | The collection of statistics that will be filtered using the new BlockStatisticsManifestCollection.
IN | boolean | true

#### AddOrModifyManifest (uint32)

#### Method Qualifiers (AddOrModifyManifest)

Name | Data Type | Value
--- | --- | ---
Description | string | Method 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.
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 4096, 4097, 4098, 4099..32767, 32768..65535
Values | string | Success, 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)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
ElementName | string
Description | string | A client-defined string that identifies the BlockStatisticsManifest created or modified by this method.
IN | boolean | true
ElementType | uint16
Description | string | The type of elements whose statistics the BlockStatisticsManifest will filter.
IN | boolean | true
ModelCorrespondence | string | CIM_BlockStatisticsManifest.ElementType, CIM_BlockStatisticsManifest.RateElementType
ValueMap | string | 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, .., 0x8000..
Values | string | Computer 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
StatisticsList | string[]
Description | string | The 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.
IN | boolean | true
Manifest | REF CIM_BlockStatisticsManifest
Description | string | The BlockStatisticsManifest that is created or modified on successful execution of the method.
OUT | boolean | true
ManifestCollection | REF CIM_BlockStatisticsManifestCollection
Description | string | BlockStatisticsManifestCollection that the BlockStatisticsManifest is or should be a member of.
IN | boolean | true

#### RemoveManifests (uint32)

#### Method Qualifiers (RemoveManifests)

Name | Data Type | Value
--- | --- | ---
Description | string | Extrinsic method that removes manifests from a BlockStatisticsManifestCollection.
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 4096, 4097..32767, 32768..65535
Values | string | Success, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Method Reserved, Manifest not found, Method Reserved, Vendor Specific

#### Method Parameters (RemoveManifests)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Manifests | CIM_BlockStatisticsManifest[]
Description | string | List of BlockStatisticsManifests to be removed from the BlockStatisticsManifestCollection.
IN | boolean | true
ManifestCollection | REF CIM_BlockStatisticsManifestCollection
Description | string | BlockStatisticsManifestCollection from which the BlockStatisticsManifests will be removed.
IN | boolean | true

#### GetRateStatisticsCollection (uint32)

#### Method Qualifiers (GetRateStatisticsCollection)

Name | Data Type | Value
--- | --- | ---
Description | string | Retrieves 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.
Experimental | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 4096, 4097, 4098, 4099..32767, 32768..65535
Values | string | Job 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)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
RateIntervalEndTime | datetime
Description | string | The end time for the rate data interval.If not supplied, the returned data would be for the most recent interval.
IN | boolean | true
RateIntervalStartTime | datetime
Description | string | The start time for the rate data interval.If not supplied, the returned data would be for the most recent interval.
IN | boolean | true
StatisticsFormat | uint16
Description | string | Specifies the format of the Statistics output parameter. - CSV = Comma Separated Values.
IN | boolean | true
ValueMap | string | 0, 1, 2, .., 0x8000..
Values | string | Unknown, Other, CSV, DMTF Reserved, Vendor Specific
RateElementTypes | uint16[]
Description | string | Element 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.
IN | boolean | true
ModelCorrespondence | string | CIM_BlockStorageStatisticalData.RateElementType
ValueMap | string | 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 25, .., 0x8000..
Values | string | 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, Device Masking Group Rate, DMTF Reserved, Vendor Specific
Statistics | string[]
Description | string | The statistics for all the elements as determined by the Elements, ManifestCollection parameters, and StatisticsFormat parameters.
OUT | boolean | true
Job | REF CIM_ConcreteJob
Description | string | Reference to the job (may be null if job completed).
IN | boolean | false
OUT | boolean | true
ManifestCollection | REF CIM_BlockStatisticsManifestCollection
Description | string | The 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.
IN | boolean | true

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
ChangeAffectedElementsAssignedSequence | uint32 | CIM_Service
RequestStateChange | uint32 | CIM_EnabledLogicalElement
StartService | uint32 | CIM_Service
StopService | uint32 | CIM_Service