Edit

CIM_FileSystem class

  • Article

The CIM_FileSystem class represents a file or data set local to a computer system or remotely mounted from a file server.

Important

The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

[Abstract, UUID("{4DA18760-E3D0-11d2-8601-0000F8102E5F}"), AMENDMENT]
class CIM_FileSystem : CIM_LogicalElement
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Name;
  string   Status;
  uint64   AvailableSpace;
  uint64   BlockSize;
  boolean  CasePreserved;
  boolean  CaseSensitive;
  uint16   CodeSet[];
  string   CompressionMethod;
  string   CreationClassName;
  string   CSCreationClassName;
  string   CSName;
  string   EncryptionMethod;
  uint64   FileSystemSize;
  uint32   MaxFileNameLength;
  boolean  ReadOnly;
  string   Root;
};

Members

The CIM_FileSystem class has these types of members:

Properties

The CIM_FileSystem class has these properties.

AvailableSpace

Data type: uint64

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Partition|002.4"), Units ("bytes")

Amount of free space, in bytes, for the file system. If unknown, enter 0.

For more information about using uint64 values in scripts, see Scripting in WMI.

BlockSize

Data type: uint64

Access type: Read-only

Qualifiers: Units ("bytes")

Block size of the file system for data storage and retrieval.

For more information about using uint64 values in scripts, see Scripting in WMI.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64), DisplayName ("Caption")

A short textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

CasePreserved

Data type: boolean

Access type: Read-only

If TRUE, the case of file names are preserved.

CaseSensitive

Data type: boolean

Access type: Read-only

If TRUE, case-sensitive file names are supported.

CodeSet

Data type: uint16 array

Access type: Read-only

Array that defines the character sets or encoding supported by the file system.

Unknown (0)

Other (1)

ASCII (2)

Unicode (3)

ISO2022 (4)

ISO8859 (5)

Extended UNIX Code (6)

UTF-8 (7)

UCS-2 (8)

CompressionMethod

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Partition|002.7")

Free-form string that indicates the algorithm or tool used to compress the logical file. If the compression scheme is unknown or not described, use "Unknown". If the logical file is compressed, but the compression scheme is unknown or not described, use "Compressed". If the logical file is not compressed, use "Not Compressed".

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (256)

Name of the class or subclass used in the creation of an instance. When used with other key properties of the class, this property allows all instances of the class and its subclasses to be uniquely identified.

CSCreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (256), Propagated ("CIM_ComputerSystem.CreationClassName")

Scoping computer system's creation class name.

CSName

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (256), Propagated ("CIM_ComputerSystem.Name")

Scoping computer system's name.

Description

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Description")

A textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

EncryptionMethod

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Partition|002.8")

Free-form string that identifies the algorithm or tool used to encrypt a logical file. If the encryption scheme is not indulged (for security reasons, for example), use "Unknown". If the file is encrypted, but either its encryption scheme is unknown or not disclosed, use "Encrypted". If the logical file is not encrypted, use "Not Encrypted".

FileSystemSize

Data type: uint64

Access type: Read-only

Qualifiers: Units ("bytes")

Size of the file system, in bytes. If unknown, enter 0 (zero).

For more information about using uint64 values in scripts, see Scripting in WMI.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5"), DisplayName ("Install Date")

Indicates when the object was installed. Lack of a value does not indicate that the object is not installed.

This property is inherited from CIM_ManagedSystemElement.

MaxFileNameLength

Data type: uint32

Access type: Read-only

Maximum length of a file name within the file system. A value of 0 (zero) indicates that there is no limit to the file name length.

Name

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Name")

Label by which the object is known. When subclassed, this property can be overridden to be a key property.

This property is inherited from CIM_ManagedSystemElement.

ReadOnly

Data type: boolean

Access type: Read-only

Qualifiers: MappingStrings ("MIB.IETF|HOST-RESOURCES-MIB.hrFSAccess")

If TRUE, the file system is designated as read only.

Root

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("MIB.IETF|HOST-RESOURCES-MIB.hrFSMountPoint")

Path name or other information that defines the root of the file system.

Status

Data type: string

Access type: Read-only

Qualifiers: MaxLen (10), DisplayName ("Status")

String that indicates the current status of the object. Operational and non-operational status can be defined. Operational status can include "OK", "Degraded", and "Pred Fail". "Pred Fail" indicates that an element is functioning properly, but is predicting a failure (for example, a SMART-enabled hard disk drive).

Non-operational status can include "Error", "Starting", "Stopping", and "Service". "Service" can apply during disk mirror-resilvering, reloading a user permissions list, or other administrative work. Not all such work is online, but the managed element is neither "OK" nor in one of the other states.

This property is inherited from CIM_ManagedSystemElement.

Values include the following:

OK ("OK")

Error ("Error")

Degraded ("Degraded")

Unknown ("Unknown")

Pred Fail ("Pred Fail")

Starting ("Starting")

Stopping ("Stopping")

Service ("Service")

Stressed ("Stressed")

NonRecover ("NonRecover")

No Contact ("No Contact")

Lost Comm ("Lost Comm")

Remarks

The CIM_FileSystem class is derived from CIM_LogicalElement.

WMI does not implement this class.

This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.

Requirements

Requirement Value
Minimum supported client
 Windows Vista
Minimum supported server
 Windows Server 2008
Namespace
 Root\CIMV2
MOF
CIMWin32.mof
DLL
CIMWin32.dll

See also

CIM_LogicalElement