Class CIM_FileSystemStatisticsService
extends CIM_StatisticsService

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

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_FileSystemStatisticsService

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 FileSystemStatisticalData.
UMLPackagePathstringCIM::System::FileStatistics
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 FileSystemStatisticsManifestCollection. If both the Elements and FileSystemStatisticsManifestCollection 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 FileSystemStatisticsManifest instances exist in the supplied FileSystemStatisticsManifestCollection. 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), then 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_FileSystemStatisticalData.ElementType
ValueMapstring1, 102, 103, 104, .., 0x8000..
ValuesstringOther, Local Filesystem, Exported File Share, Exporting Port, DMTF Reserved, Vendor Specific
OtherElementTypeDescriptionsstring[]
DescriptionstringAn array of strings that specify the particular "Other" element(s) when the ElementType property above includes the ElementType value of 1 (i.e., "Other"). Each string within this array identifies a separate "Other" element and duplicate string values are NOT allowed. This property should be set to NULL when the ElementType property does not include the value of 1.
ModelCorrespondencestringCIM_FileSystemStatisticalData.OtherElementTypeDescription
Statisticsstring[]
DescriptionstringThe statistics for all the elements as determined by the Elements, ManifestCollection parameters, and StatisticsFormat parameters.
ModelCorrespondencestringCIM_FileSystemStatisticsService.GetStatisticsCollection(ElementTypes), CIM_FileSystemStatisticsService.GetStatisticsCollection(ManifestCollection), CIM_FileSystemStatisticsService.GetStatisticsCollection(StatisticsFormat)
OUTbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
ManifestCollection REF CIM_FileSystemStatisticsManifestCollection
DescriptionstringThe FileSystemStatisticsManifestCollection 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 FileSystemStatisticsManifest instances contained within the FileSystemStatisticsManifestCollection will have data returned by this method. If the supplied FileSystemStatisticsManifestCollection does not contain any FileSystemStatisticsManifest instances, then no statistics will be returned by this method.

CreateManifestCollection (uint32)

Method Qualifiers (CreateManifestCollection)

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

AddOrModifyManifest (uint32)

Method Qualifiers (AddOrModifyManifest)

NameData TypeValue
DescriptionstringMethod that creates or modifies a FileSystemStatisticsManifest for this statistics service. A client supplies a FileSystemStatisticsManifestCollection in which the new FileSystemStatisticsManifest will be placed or an existing FileSystemStatisticsManifest will be modified, the element type of the statistics that the FileSystemStatisticsManifest 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 FileSystemStatisticsManifest created or modified by this method.
ElementTypeuint16
DescriptionstringThe type of elements whose statistics the FileSystemStatisticsManifest will filter.
ModelCorrespondencestringCIM_FileSystemStatisticsManifest.ElementType
ValueMapstring1, 102, 103, 104, .., 0x8000..
ValuesstringOther, Local Filesystem, Exported File Share, Exporting Port, DMTF Reserved, Vendor Specific
OtherElementTypeDescriptionstring
DescriptionstringA string describing the type of element when the ElementType property above is set to 1 (i.e., "Other"). This property should be set to NULL when the ElementType property is any value other than 1.
MaxLenuint3264
ModelCorrespondencestringCIM_FileSystemStatisticsManifest.OtherElementTypeDescription
StatisticsListstring[]
DescriptionstringThe metrics that will be included by the filter. The metrics supplied here are the properties of CIM_FileSystemStatisticalData or one of its subclasses that will remain after the FileSystemStatisticsManifest filter is applied. If this array parameter is empty, then only InstanceID and ElementType will be returned when the manifest is referenced. If this parameter is NULL, then all supported metrics is assumed (i.e., all supported metric properties will be included; note that this would be the FileSystemStatisticsManifest from the default manifest collection).
Manifest REF CIM_FileSystemStatisticsManifest
DescriptionstringThe FileSystemStatisticsManifest that is created or modified on successful execution of the method.
OUTbooleantrue
ManifestCollection REF CIM_FileSystemStatisticsManifestCollection
DescriptionstringFileSystemStatisticsManifestCollection that the FileSystemStatisticsManifest is or should be a member of.

RemoveManifests (uint32)

Method Qualifiers (RemoveManifests)

NameData TypeValue
DescriptionstringExtrinsic method that removes manifests from a FileSystemStatisticsManifestCollection.
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_FileSystemStatisticsManifest[]
DescriptionstringList of FileSystemStatisticsManifests to be removed from the FileSystemStatisticsManifestCollection.
ManifestCollection REF CIM_FileSystemStatisticsManifestCollection
DescriptionstringFileSystemStatisticsManifestCollection from which the FileSystemStatisticsManifests will be removed.

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service