# Class CIM_FileSystem
extends CIM_EnabledLogicalElement

A file or dataset store local to a System (such as a ComputerSystem or an ApplicationSystem) or remotely mounted from a file server.

### Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_ManagedSystemElement
|
+--CIM_LogicalElement
|
+--CIM_EnabledLogicalElement
|
+--CIM_FileSystem

## Direct Known Subclasses

CIM_DatabaseStorageArea
CIM_LocalFileSystem
CIM_RemoteFileSystem

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | A file or dataset store local to a System (such as a ComputerSystem or an ApplicationSystem) or remotely mounted from a file server.
UMLPackagePath | string | CIM::System::FileElements
Version | string | 2.7.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
AvailableSpace | uint64 |
Description | string | AvailableSpace indicates the total amount of free space for the FileSystem, in bytes. If unknown, enter 0.
Gauge | boolean | true
MappingStrings | string | MIF.DMTF|Host File System|001.14, MIF.DMTF|Partition|002.4
PUnit | string | byte
Units | string | Bytes
BlockSize | uint64 |
Description | string | FileSystems can read/write data in blocks which are defined independently of the underlying StorageExtents. This property captures the FileSystem's block size for data storage and retrieval.
PUnit | string | byte
Units | string | Bytes
CasePreserved | boolean |
Description | string | Indicates that the case of file names are preserved.
CaseSensitive | boolean |
Description | string | Indicates that case sensitive file names are supported.
ClusterSize | uint32 |

Description

string

The minimum file allocation size (an integral number of blocks), imposed by the FileSystem. (The size of a block is specified in the BlockSize property for the FileSystem.) Minimum allocation size is the smallest amount of storage allocated to a LogicalFile by the FileSystem. This is not a mandatory minimum allocation for all FileSystems. Under stress conditions, some FileSystems may allocate storage in amounts smaller than the ClusterSize.

CompressionMethod | string |

Description

string

A free form string indicating the algorithm or tool used to compress the FileSystem. If it is not possible or not desired to describe the compression scheme (perhaps because it is not known), recommend using the following words: "Unknown" to represent that it is not known whether the FileSystem is compressed or not, "Compressed" to represent that the File System is compressed but either its compression scheme is not known or not disclosed, and "Not Compressed" to represent that the FileSystem is not compressed.

MappingStrings | string | MIF.DMTF|Partition|002.7
CreationClassName | string |
Description | string | CreationClassName indicates the name of the class or the subclass 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.
Key | boolean | true
MaxLen | uint32 | 256
CSCreationClassName | string |

Description

string

The scoping System's CreationClassName. Note that this class was originally defined in the scope of a ComputerSystem, and was later allowed to be scoped by any System (for example, a computer or application system). Unfortunately, the property name, CSCreationClassName, could not be changed (for example, to SystemCreationClass Name) without deprecating the class. This change was not deemed critical to the semantics and therefore did not merit deprecation. So, the property name remains.

Key | boolean | true
MaxLen | uint32 | 256
Propagated | string | CIM_System.CreationClassName
CSName | string |

Description

string

The scoping System's Name. Note that this class was originally defined in the scope of a ComputerSystem, and was later allowed to be scoped by any System (for example, a computer or application system). Unfortunately, the property name, CSName, could not be changed (for example, to SystemName) without deprecating the class. This change was not deemed critical to the semantics and therefore did not merit deprecation. So, the property name remains.

Key | boolean | true
MaxLen | uint32 | 256
Propagated | string | CIM_System.Name
EncryptionMethod | string |

Description

string

A free form string indicating the algorithm or tool used to encrypt the FileSystem. If it is not possible or not desired to describe the encryption scheme (perhaps for security reasons), recommend using the following words: "Unknown" to represent that it is not known whether the FileSystem is encrypted or not, "Encrypted" to represent that the File System is encrypted but either its encryption scheme is not known or not disclosed, and "Not Encrypted" to represent that the FileSystem is not encrypted.

MappingStrings | string | MIF.DMTF|Partition|002.8
FileSystemSize | uint64 |
Description | string | The FileSystemSize property stores the total size of the File System in bytes. If unknown, enter 0.
MappingStrings | string | MIF.DMTF|Host File System|001.13
PUnit | string | byte
Units | string | Bytes
FileSystemType | string |
Description | string | String describing the type of FileSystem and therefore, its conventions. For example, "NTFS" or "S5" may be listed as well as any additional information on the FileSystem's implementation. Since various flavors of FileSystems (like S5) exist, this property is defined as a string.
MappingStrings | string | MIF.DMTF|Partition|002.6, MIF.DMTF|Host File System|001.4
MaxFileNameLength | uint32 |
Description | string | Integer indicating the maximum length of a file name within the FileSystem. 0 indicates that there is no limit on file name length.
Name | string |
Description | string | The inherited Name serves as key of a FileSystem instance within a ComputerSystem.
Key | boolean | true
MaxLen | uint32 | 256
Override | string | Name
NumberOfFiles | uint64 |
Description | string | The number of files contained in the FileSystem.
OtherPersistenceType | string |
Description | string | A string describing the persistence characteristics when PersistenceType is "Other".
ModelCorrespondence | string | CIM_FileSystem.PersistenceType
PersistenceType | uint16 |

Description

string

An enumerated value representing the FileSystem's perception of its own persistence characteristics. This property would typically be set at the time the FileSystem is instantiated and would not be changed by external actions. A value of "Persistent" indicates that the FileSystem is persistent, will be preserved through an orderly shutdown and should be protected. A value of "Temporary" indicates that the FileSystem is non-persistent, should not be protected and may not survive a shutdown. A value of "External" indicates that the FileSystem is controlled outside of the scope of the operating environment and may need to be protected by specialized means. A value of "Other" is provided to allow for additional persistence types, to be described in the OtherPersistenceType attribute, and is expected to be rarely, if ever, used. A value of "Unknown" indicates that the persistence of the FileSystem can not be determined.

ModelCorrespondence | string | CIM_FileSystem.OtherPersistenceType
ValueMap | string | 0, 1, 2, 3, 4
Values | string | Unknown, Other, Persistent, Temporary, External
ReadOnly | boolean |
Description | string | Indicates that the FileSystem is designated as read only.
MappingStrings | string | MIB.IETF|HOST-RESOURCES-MIB.hrFSAccess, MIF.DMTF|Host File System|001.5
Root | string |
Description | string | Path name or other information defining the root of the FileSystem.
MappingStrings | string | MIB.IETF|HOST-RESOURCES-MIB.hrFSMountPoint, MIF.DMTF|Host File System|001.2
CodeSet | uint16[] |
Description | string | Array defining the character sets or encoding supported by the FileSystem. For example, the values, "ASCII" (2) or "ISO2022" (4), may be specified.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8
Values | string | Unknown, Other, ASCII, Unicode, ISO2022, ISO8859, Extended UNIX Code, UTF-8, UCS-2

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
Status | string | CIM_ManagedSystemElement
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
RequestStateChange | uint32 | CIM_EnabledLogicalElement