# Class CIM_LocalFileSystem
extends CIM_FileSystem

A class derived from FileSystem that represents the file store controlled by a ComputerSystem through local means (e.g., direct device driver access). In this case, the file store is managed directly by the ComputerSystem without the need for another computer to act as a file server. This definition does not breakdown in the case of a Clustered File System. In this scenario, the FileSystem is a LocalFileSystem, weak to the Cluster.

### 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
|
+--CIM_LocalFileSystem

## Direct Known Subclasses

CIM_UnixLocalFileSystem

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | A class derived from FileSystem that represents the file store controlled by a ComputerSystem through local means (e.g., direct device driver access). In this case, the file store is managed directly by the ComputerSystem without the need for another computer to act as a file server. This definition does not breakdown in the case of a Clustered File System. In this scenario, the FileSystem is a LocalFileSystem, weak to the Cluster.
UMLPackagePath | string | CIM::System::FileElements
Version | string | 2.45.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
DirectoryServiceUsage | uint16 |
Description | string | This enumerated integer specifies if the filesystem supports security principal information and therefore requires support from a file server that uses one or more directory services. If the filesystem requires such support, there must be a concrete subclass of Dependency between the LocalFileSystem element and the specified file server ComputerSystem. The enumerated values are: "Not Used" indicates that the filesystem will not support security principal information and so will not require support from a directory service. "Optional" indicates that the filesystem may support security principal information. If it does, it will require support from a directory service and the Dependency association described above must exist. "Required" indicates that the filesystem supports security principal information and will require support from a directory service. The Dependency association described above must exist.
ValueMap | string | 0, 1, 2, 3, 4
Values | string | Unknown, Other, Not Used, Optional, Required
LocalAccessDefinitionRequired | uint16 |
Description | string | This enumerated integer specifies if the provider requires that a file system device be made locally accessible before it can be used as a file system. If local access is required to be set up, a vendor could provide a default mechanism, for instance, making "/dev/fs1" available as "/etc/mounts/fs1" automatically in an Unix-like OS, but it can be overridden by the system administrator.If local access is not required, the file system is automatically made available by some default name (for instance, the volume at "C" is also the filesystem "C:"on Windows systems, and cannot be overridden.
ValueMap | string | 0, 1, 2, 3, 4
Values | string | Unknown, Other, Required, Required -- vendor default, Not Required
MultipleDisksSupported | uint16 |
Description | string | This enumerated integer specifies if the file system type is capable of being built on multiple LogicalDisks. If "Supported", the provider can make differential use of the capabilities of the underlying multiple logical disks, for instance, by putting file system meta data on one kind of LogicalDisk and placing file data on another. The CIM_LocalFileSystem can only reside on a single LogicalDisk,but that LogicalDisk could be built up from multiple underlying logical disk using an appropriate profile. This property specifies support for capabilities that make use of that sub-structure.
ValueMap | string | 0, 1, 2, 3
Values | string | Unknown, Other, Supported, Not Supported
PathNameSeparatorString | string |
Description | string | The string is used by this FileSystem for constructing a path name from the sequence of directories that leads to some contained LogicalFile (file or directory). Currently the most commonly used are '\' for Windows and '/' in Unix.

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
AvailableSpace | uint64 | CIM_FileSystem
BlockSize | uint64 | CIM_FileSystem
Caption | string | CIM_ManagedElement
CasePreserved | boolean | CIM_FileSystem
CaseSensitive | boolean | CIM_FileSystem
ClusterSize | uint32 | CIM_FileSystem
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CompressionMethod | string | CIM_FileSystem
CreationClassName | string | CIM_FileSystem
CSCreationClassName | string | CIM_FileSystem
CSName | string | CIM_FileSystem
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
EncryptionMethod | string | CIM_FileSystem
FileSystemSize | uint64 | CIM_FileSystem
FileSystemType | string | CIM_FileSystem
Generation | uint64 | CIM_ManagedElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
IsFixedSize | uint16 | CIM_FileSystem
MaxFileNameLength | uint32 | CIM_FileSystem
Name | string | CIM_FileSystem
NumberOfFiles | uint64 | CIM_FileSystem
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
OtherPersistenceType | string | CIM_FileSystem
PersistenceType | uint16 | CIM_FileSystem
PrimaryStatus | uint16 | CIM_ManagedSystemElement
ReadOnly | boolean | CIM_FileSystem
RequestedState | uint16 | CIM_EnabledLogicalElement
ResizeIncrement | uint64 | CIM_FileSystem
Root | string | CIM_FileSystem
Status | string | CIM_ManagedSystemElement
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
CodeSet | uint16[] | CIM_FileSystem
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Local Class Methods

#### GetFileProperties (uint32)

#### Method Qualifiers (GetFileProperties)

Name | Data Type | Value
--- | --- | ---
Description | string | The GetFileProperties gets a set of file records from a filesystem. As there may be millions of records in this report, a chunking mechanism is.provided so that the client does not become overwhelmed by the quantity of data furnished by the server.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, .., 4097..32767, 32768..65535
Values | string | Success, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Reserved, Vendor Specific

#### Method Parameters (GetFileProperties)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
DirectoryName | string
Description | string | The DirectoryName is an optional pathname for a directory a directory to restrict the data returned. If this parameter is NULL, then files are returned for all filesin the Filesystem.
OUT | boolean | true
Handle | string
Description | string | The initial call to GetFileProperties shall pass in NULL as a Handle. Subsequent calls shall pass back the Handle exactly as received from the server, without modification, asan indication of where to continue the report from.
OUT | boolean | true
NumberOfFiles | uint64
Description | string | The NumberOfFiles is the number of files returned in a block of FileRecs. If NULL the provider will supply a default number (and put that number in the parameter as output).
OUT | boolean | true
FileRecs | string[]
Description | string | This array parameter provides the file records as embedded instances of CIM_LogicalFile.
EmbeddedInstance | string | CIM_LogicalFile
IN | boolean | false
OUT | boolean | true

### Inherited Class Methods

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