Class CIM_BlockStatisticsService


CIM_ManagedElement
\_CIM_ManagedSystemElement
  \_CIM_LogicalElement
    \_CIM_EnabledLogicalElement
      \_CIM_Service
        \_CIM_StatisticsService


Description

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

Subclasses

IBMTSDS_PerformanceStatisticsService

Referenced By


Properties

IdTypeRangeDescription
Key
CreationClassName string
Max Length256
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.
Name string
Max Length256
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.
SystemCreationClassName string
Max Length256
The CreationClassName of the scoping System.
SystemName string
Max Length256
The Name of the scoping System.
Read Only
Read Write
 
Inherited from class CIM_ManagedElement
Caption, Description, ElementName
 
Inherited from class CIM_ManagedSystemElement
HealthState, InstallDate, Name, OperationalStatus, Status, StatusDescriptions
 
Inherited from class CIM_EnabledLogicalElement
EnabledState, OtherEnabledState, RequestedState, TimeOfLastStateChange, EnabledDefault
 
Inherited from class CIM_Service
Started, StartMode, PrimaryOwnerContact, PrimaryOwnerName
 

Method Summary

NameDescription
AddOrModifyManifestMethod that creates or modifies a BlockStatisticsManifest for this statistics service.
CreateManifestCollectionCreates a new BlockStatisticsManifestCollection instance, whose members can serve as a filter for metrics retrieved through the GetStatisticsCollection method.
GetStatisticsCollectionRetrieves statistics in a well-defined bulk format.
RemoveManifestsExtrinsic method that removes manifests from a BlockStatisticsManifestCollection.
 
Inherited from class CIM_EnabledLogicalElement
RequestStateChange
 
Inherited from class CIM_Service
StartService, StopService
 

Method Detail


AddOrModifyManifest

Description

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.

Parameters

IdTypeRangeDescription
In
ManifestCollection CIM_BlockStatisticsManifestCollection
BlockStatisticsManifestCollection that the BlockStatisticsManifest is or should be a member of.
ElementType uint16
The type of elements whose statistics the BlockStatisticsManifest will filter.
ElementName string
A client-defined string that identifies the BlockStatisticsManifest created or modified by this method.
StatisticsList 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.
Manifest CIM_BlockStatisticsManifest
The BlockStatisticsManifest that is created or modified on successful execution of the method.
out
Manifest CIM_BlockStatisticsManifest
The BlockStatisticsManifest that is created or modified on successful execution of the method.
Return Codes
none

CreateManifestCollection

Description

Creates a new BlockStatisticsManifestCollection instance, whose members can serve as a filter for metrics retrieved through the GetStatisticsCollection method.

Parameters

IdTypeRangeDescription
In
Statistics CIM_StatisticsCollection
The collection of statistics that will be filtered using the new BlockStatisticsManifestCollection.
ElementName string
Client-defined name for the new BlockStatisticsManifestCollection.
ManifestCollection CIM_BlockStatisticsManifestCollection
Reference to the new BlockStatisticsManifestCollection.
out
ManifestCollection CIM_BlockStatisticsManifestCollection
Reference to the new BlockStatisticsManifestCollection.
Return Codes
none

GetStatisticsCollection

Description

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.

Parameters

IdTypeRangeDescription
In
ElementTypes uint16
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).
ManifestCollection CIM_BlockStatisticsManifestCollection
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.
StatisticsFormat uint16
Specifies the format of the Statistics output parameter.- CSV = Comma Separated Values.
Statistics string
The statistics for all the elements as determined by the Elements, ManifestCollection parameters, and StatisticsFormat parameters.
out
Job CIM_ConcreteJob
Reference to the job (may be null if job completed).
Statistics string
The statistics for all the elements as determined by the Elements, ManifestCollection parameters, and StatisticsFormat parameters.
Return Codes
none

RemoveManifests

Description

Extrinsic method that removes manifests from a BlockStatisticsManifestCollection.

Parameters

IdTypeRangeDescription
In
ManifestCollection CIM_BlockStatisticsManifestCollection
BlockStatisticsManifestCollection from which the BlockStatisticsManifests will be removed.
Manifests CIM_BlockStatisticsManifest
List of BlockStatisticsManifests to be removed from the BlockStatisticsManifestCollection.
out
none
Return Codes
none