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

NameData TypeValue
DescriptionstringA file or dataset store local to a System (such as a ComputerSystem or an ApplicationSystem) or remotely mounted from a file server.
UMLPackagePathstringCIM::System::FileElements
Versionstring2.45.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
AvailableSpaceuint64
DescriptionstringAvailableSpace indicates the total amount of free space for the FileSystem, in bytes. If unknown, enter 0.
Gaugebooleantrue
MappingStringsstringMIF.DMTF|Host File System|001.14, MIF.DMTF|Partition|002.4
PUnitstringbyte
UnitsstringBytes
BlockSizeuint64
DescriptionstringFileSystems 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.
PUnitstringbyte
UnitsstringBytes
CasePreservedboolean
DescriptionstringIndicates that the case of file names are preserved.
CaseSensitiveboolean
DescriptionstringIndicates that case sensitive file names are supported.
ClusterSizeuint32
DescriptionstringThe 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.
CompressionMethodstring
DescriptionstringA 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.
MappingStringsstringMIF.DMTF|Partition|002.7
CreationClassNamestring
DescriptionstringCreationClassName 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.
Keybooleantrue
MaxLenuint32256
CSCreationClassNamestring
DescriptionstringThe 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.
Keybooleantrue
MaxLenuint32256
PropagatedstringCIM_System.CreationClassName
CSNamestring
DescriptionstringThe 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.
Keybooleantrue
MaxLenuint32256
PropagatedstringCIM_System.Name
EncryptionMethodstring
DescriptionstringA 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.
MappingStringsstringMIF.DMTF|Partition|002.8
FileSystemSizeuint64
DescriptionstringThe FileSystemSize property stores the total size of the File System in bytes. If unknown, enter 0.
MappingStringsstringMIF.DMTF|Host File System|001.13
PUnitstringbyte
UnitsstringBytes
FileSystemTypestring
DescriptionstringString 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.
MappingStringsstringMIF.DMTF|Partition|002.6, MIF.DMTF|Host File System|001.4
IsFixedSizeuint160
DescriptionstringIndicates whether the File size is fixed at creation time (value = 1) - the file size is fixed, (value = 2) - the file is not a fixed size. The default (value = 0) indicates that this information is not specified. If the File size is not fixed, the ResizeIncrement property should specify the growth increment, in bytes.
ModelCorrespondencestringCIM_FileSystem.ResizeIncrement
ValueMapstring0, 1, 2
ValuesstringNot Specified, Fixed Size, Not Fixed Size
MaxFileNameLengthuint32
DescriptionstringInteger indicating the maximum length of a file name within the FileSystem. 0 indicates that there is no limit on file name length.
Namestring
DescriptionstringThe inherited Name serves as key of a FileSystem instance within a ComputerSystem.
Keybooleantrue
MaxLenuint32256
OverridestringName
NumberOfFilesuint64
DescriptionstringThe number of files contained in the FileSystem.
OtherPersistenceTypestring
DescriptionstringA string describing the persistence characteristics when PersistenceType is "Other".
ModelCorrespondencestringCIM_FileSystem.PersistenceType
PersistenceTypeuint16
DescriptionstringAn 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.
ModelCorrespondencestringCIM_FileSystem.OtherPersistenceType
ValueMapstring0, 1, 2, 3, 4
ValuesstringUnknown, Other, Persistent, Temporary, External
ReadOnlyboolean
DescriptionstringIndicates that the FileSystem is designated as read only.
MappingStringsstringMIB.IETF|HOST-RESOURCES-MIB.hrFSAccess, MIF.DMTF|Host File System|001.5
ResizeIncrementuint640
DescriptionstringThe increment size of a resizable File in bytes. If the File is a fixed size, or the resize increment is not specified, the value of this property must be 0.
ModelCorrespondencestringCIM_FileSystem.IsFixedSize
PUnitstringbyte
UnitsstringBytes
Rootstring
DescriptionstringPath name or other information defining the root of the FileSystem.
MappingStringsstringMIB.IETF|HOST-RESOURCES-MIB.hrFSMountPoint, MIF.DMTF|Host File System|001.2
CodeSetuint16[]
DescriptionstringArray defining the character sets or encoding supported by the FileSystem. For example, the values, "ASCII" (2) or "ISO2022" (4), may be specified.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8
ValuesstringUnknown, Other, ASCII, Unicode, ISO2022, ISO8859, Extended UNIX Code, UTF-8, UCS-2

Inherited Properties

NameData Type
Captionstring
CommunicationStatusuint16
Descriptionstring
DetailedStatusuint16
ElementNamestring
EnabledDefaultuint16
EnabledStateuint16
Generationuint64
HealthStateuint16
InstallDatedatetime
InstanceIDstring
OperatingStatusuint16
OtherEnabledStatestring
PrimaryStatusuint16
RequestedStateuint16
Statusstring
TimeOfLastStateChangedatetime
TransitioningToStateuint16
AvailableRequestedStatesuint16[]
OperationalStatusuint16[]
StatusDescriptionsstring[]

Class Methods

Inherited Class Methods

NameReturn Type
RequestStateChangeuint32