# 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

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 FileSystemStatisticalData.
UMLPackagePath | string | CIM::System::FileStatistics
Version | string | 2.45.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 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.
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.
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), 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).
ModelCorrespondence | string | CIM_FileSystemStatisticalData.ElementType
ValueMap | string | 1, 102, 103, 104, .., 0x8000..
Values | string | Other, Local Filesystem, Exported File Share, Exporting Port, DMTF Reserved, Vendor Specific
OtherElementTypeDescriptions | string[]
Description | string | An 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.
ModelCorrespondence | string | CIM_FileSystemStatisticalData.OtherElementTypeDescription
Statistics | string[]
Description | string | The statistics for all the elements as determined by the Elements, ManifestCollection parameters, and StatisticsFormat parameters.
ModelCorrespondence | string | CIM_FileSystemStatisticsService.GetStatisticsCollection(ElementTypes), CIM_FileSystemStatisticsService.GetStatisticsCollection(ManifestCollection), CIM_FileSystemStatisticsService.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_FileSystemStatisticsManifestCollection
Description | string | The 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)

Name | Data Type | Value
--- | --- | ---
Description | string | Creates a new FileSystemStatisticsManifestCollection 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 FileSystemStatisticsManifestCollection.
ManifestCollection | REF CIM_FileSystemStatisticsManifestCollection
Description | string | Reference to the new FileSystemStatisticsManifestCollection.
OUT | boolean | true
Statistics | REF CIM_StatisticsCollection
Description | string | The collection of statistics that will be filtered using the new FileSystemStatisticsManifestCollection.

#### AddOrModifyManifest (uint32)

#### Method Qualifiers (AddOrModifyManifest)

Name | Data Type | Value
--- | --- | ---
Description | string | Method 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.
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 FileSystemStatisticsManifest created or modified by this method.
ElementType | uint16
Description | string | The type of elements whose statistics the FileSystemStatisticsManifest will filter.
ModelCorrespondence | string | CIM_FileSystemStatisticsManifest.ElementType
ValueMap | string | 1, 102, 103, 104, .., 0x8000..
Values | string | Other, Local Filesystem, Exported File Share, Exporting Port, DMTF Reserved, Vendor Specific
OtherElementTypeDescription | string
Description | string | A 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.
MaxLen | uint32 | 64
ModelCorrespondence | string | CIM_FileSystemStatisticsManifest.OtherElementTypeDescription
StatisticsList | string[]
Description | string | The 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
Description | string | The FileSystemStatisticsManifest that is created or modified on successful execution of the method.
OUT | boolean | true
ManifestCollection | REF CIM_FileSystemStatisticsManifestCollection
Description | string | FileSystemStatisticsManifestCollection that the FileSystemStatisticsManifest is or should be a member of.

#### RemoveManifests (uint32)

#### Method Qualifiers (RemoveManifests)

Name | Data Type | Value
--- | --- | ---
Description | string | Extrinsic method that removes manifests from a FileSystemStatisticsManifestCollection.
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_FileSystemStatisticsManifest[]
Description | string | List of FileSystemStatisticsManifests to be removed from the FileSystemStatisticsManifestCollection.
ManifestCollection | REF CIM_FileSystemStatisticsManifestCollection
Description | string | FileSystemStatisticsManifestCollection from which the FileSystemStatisticsManifests will be removed.

### Inherited Class Methods

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