# Class CIM_LogicalFile
extends CIM_LogicalElement

A LogicalFile is a named collection of data or executable code, or represents a LogicalDevice or Directory. It is located within the context of a FileSystem, on a Storage Extent.

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

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_ManagedSystemElement
|
+--CIM_LogicalElement
|
+--CIM_LogicalFile

## Direct Known Subclasses

CIM_DataFile
CIM_DeviceFile
CIM_Directory
CIM_FIFOPipeFile
CIM_SymbolicLink

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | A LogicalFile is a named collection of data or executable code, or represents a LogicalDevice or Directory. It is located within the context of a FileSystem, on a Storage Extent.
UMLPackagePath | string | CIM::System::FileElements
Version | string | 2.6.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
CompressionMethod | string |

Description

string

A free form string indicating the algorithm or tool used to compress the LogicalFile. 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 LogicalFile is compressed or not, "Compressed" to represent that the File is compressed but either its compression scheme is not known or not disclosed, and "Not Compressed" to represent that the LogicalFile is not compressed.

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
CreationDate | datetime |
Description | string | File's creation date.
CSCreationClassName | string |
Description | string | The scoping ComputerSystem's CreationClassName.
Key | boolean | true
MaxLen | uint32 | 256
Propagated | string | CIM_FileSystem.CSCreationClassName
CSName | string |
Description | string | The scoping ComputerSystem's Name.
Key | boolean | true
MaxLen | uint32 | 256
Propagated | string | CIM_FileSystem.CSName
EncryptionMethod | string |

Description

string

A free form string indicating the algorithm or tool used to encrypt the LogicalFile. 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 LogicalFile is encrypted or not, "Encrypted" to represent that the File is encrypted but either its encryption scheme is not known or not disclosed, and "Not Encrypted" to represent that the LogicalFile is not encrypted.

Executable | boolean |
Description | string | Indicates the file is executable.
FileSize | uint64 |
Description | string | Size of the File in bytes.
Gauge | boolean | true
PUnit | string | byte
Units | string | Bytes
FSCreationClassName | string |
Description | string | The scoping FileSystem's CreationClassName.
Key | boolean | true
MaxLen | uint32 | 256
Propagated | string | CIM_FileSystem.CreationClassName
FSName | string |
Description | string | The scoping FileSystem's Name.
Key | boolean | true
MaxLen | uint32 | 256
Propagated | string | CIM_FileSystem.Name
InUseCount | uint64 |
Counter | boolean | true
Description | string | Integer indicating the number of 'file opens' that are currently active against the File.
LastAccessed | datetime |
Description | string | Time that the File was last accessed.
LastModified | datetime |
Description | string | Time that the File was last modified.
Name | string |

Description

string

The inherited Name serves as part of the key of a LogicalFile instance within a FileSystem. A unique identifier (such as a full path name) is required as a Name value. Since Files are weak to their FileSystem (and not to a Directory which would provide a more granular naming algorithm), care must be taken to make LogicalFile's Name unique for a given Creation ClassName and FileSystem. A full path name is one way to do this.

Key | boolean | true
MaxLen | uint32 | 1024
Override | string | Name
Readable | boolean |
Description | string | Boolean indicating that the File can be read.
Writeable | boolean |
Description | string | Boolean indicating that the File can be written.

### 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
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
OperatingStatus | uint16 | CIM_ManagedSystemElement
PrimaryStatus | uint16 | CIM_ManagedSystemElement
Status | string | CIM_ManagedSystemElement
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods