CIM29 Class Declaration
CIM_Directory

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_Directory --> CIM_LogicalFile --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_LogicalFile
NAMECIM_Directory

Class Qualifiers

Class CIM_Directory Qualifiers
NameTypeValueFrom Class
Versionstring2.6.0 CIM_Directory
DescriptionstringDirectory is a type of File that logically groups Files ’ contained ’ in it, and provides path information for the grouped Files. CIM_Directory
DescriptionstringA 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. CIM_LogicalFile
DescriptionstringCIM_LogicalElement is a base class for all the components of a System that represent abstract system components, such as Files, Processes, or LogicalDevices. CIM_LogicalElement
DescriptionstringCIM_ManagedSystemElement is the base class for the System Element hierarchy. Any distinguishable component of a System is a candidate for inclusion in this class. Examples of system components include: - software components such as application servers, databases, and applications - operating system components such as files, processes, and threads - device components such as disk drives, controllers, processors, and printers - physical components such as chips and cards. CIM_ManagedSystemElement
DescriptionstringManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement

Properties

Properties
NameTypeValueQualifiersClassOrigin
CSCreationClassNamestring Key
Propagated
Description
MaxLen
CIM_LogicalFile
CSNamestring Key
Propagated
Description
MaxLen
CIM_LogicalFile
FSCreationClassNamestring Key
Propagated
Description
MaxLen
CIM_LogicalFile
FSNamestring Key
Propagated
Description
MaxLen
CIM_LogicalFile
CreationClassNamestring Key
Description
MaxLen
CIM_LogicalFile
Namestring Key
Override
Description
MaxLen
CIM_LogicalFile
FileSizeuint64 Description
Units
Gauge
CIM_LogicalFile
CreationDatedatetime Description CIM_LogicalFile
LastModifieddatetime Description CIM_LogicalFile
LastAccesseddatetime Description CIM_LogicalFile
Readableboolean Description CIM_LogicalFile
Writeableboolean Description CIM_LogicalFile
Executableboolean Description CIM_LogicalFile
CompressionMethodstring Description CIM_LogicalFile
EncryptionMethodstring Description CIM_LogicalFile
InUseCountuint64 Description
Counter
CIM_LogicalFile
InstallDatedatetime Description
MappingStrings
CIM_ManagedSystemElement
OperationalStatusuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
StatusDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
Statusstring Deprecated
Description
ValueMap
MaxLen
CIM_ManagedSystemElement
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement
ElementNamestring Description CIM_ManagedElement

Property Qualifiers

Property CSCreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_LogicalFile
PropagatedstringCIM_FileSystem.CSCreationClassName CIM_LogicalFile
DescriptionstringThe scoping ComputerSystem ’ s CreationClassName. CIM_LogicalFile
MaxLenuint32256 CIM_LogicalFile

Property CSName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_LogicalFile
PropagatedstringCIM_FileSystem.CSName CIM_LogicalFile
DescriptionstringThe scoping ComputerSystem ’ s Name. CIM_LogicalFile
MaxLenuint32256 CIM_LogicalFile

Property FSCreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_LogicalFile
PropagatedstringCIM_FileSystem.CreationClassName CIM_LogicalFile
DescriptionstringThe scoping FileSystem ’ s CreationClassName. CIM_LogicalFile
MaxLenuint32256 CIM_LogicalFile

Property FSName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_LogicalFile
PropagatedstringCIM_FileSystem.Name CIM_LogicalFile
DescriptionstringThe scoping FileSystem ’ s Name. CIM_LogicalFile
MaxLenuint32256 CIM_LogicalFile

Property CreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_LogicalFile
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. CIM_LogicalFile
MaxLenuint32256 CIM_LogicalFile

Property Name Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_LogicalFile
OverridestringName CIM_LogicalFile
DescriptionstringThe 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. CIM_LogicalFile
MaxLenuint321024 CIM_LogicalFile

Property FileSize Qualifiers
NameTypeValueFrom Class
DescriptionstringSize of the File in bytes. CIM_LogicalFile
UnitsstringBytes CIM_LogicalFile
Gaugebooleantrue CIM_LogicalFile

Property CreationDate Qualifiers
NameTypeValueFrom Class
DescriptionstringFile ’ s creation date. CIM_LogicalFile

Property LastModified Qualifiers
NameTypeValueFrom Class
DescriptionstringTime that the File was last modified. CIM_LogicalFile

Property LastAccessed Qualifiers
NameTypeValueFrom Class
DescriptionstringTime that the File was last accessed. CIM_LogicalFile

Property Readable Qualifiers
NameTypeValueFrom Class
DescriptionstringBoolean indicating that the File can be read. CIM_LogicalFile

Property Writeable Qualifiers
NameTypeValueFrom Class
DescriptionstringBoolean indicating that the File can be written. CIM_LogicalFile

Property Executable Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates the file is executable. CIM_LogicalFile

Property CompressionMethod Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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. CIM_LogicalFile

Property EncryptionMethod Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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. CIM_LogicalFile

Property InUseCount Qualifiers
NameTypeValueFrom Class
DescriptionstringInteger indicating the number of ’ file opens ’ that are currently active against the File. CIM_LogicalFile
Counterbooleantrue CIM_LogicalFile

Property InstallDate Qualifiers
NameTypeValueFrom Class
DescriptionstringA datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. CIM_ManagedSystemElement
MappingStringsstringMIF.DMTF|ComponentID|001.5 CIM_ManagedSystemElement

Property Name Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property. CIM_ManagedSystemElement
MaxLenuint321024 CIM_ManagedSystemElement

Property OperationalStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates the current status(es) of the element. Various health and operational statuses are defined. Many of the enumeration ’ s values are self- explanatory. However, a few are not and are described in more detail. " Stressed " indicates that the element is functioning, but needs attention. Examples of " Stressed " states are overload, overheated, etc. " Predictive Failure " indicates that an element is functioning nominally but predicting a failure in the near future. " In Service " describes an element being configured, maintained, cleaned, or otherwise administered. " No Contact " indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. " Lost Communication " indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. " Stopped " and " Aborted " are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the element ’ s state and configuration may need to be updated. " Dormant " indicates that the element is inactive or quiesced. " Supporting Entity in Error " describes that this element may be " OK " but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower layer networking problems. " Completed " indicates the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error. " Power Mode " indicates the element has additional power model information contained in the Associated PowerManagementService association. OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today ’ s environment to the future. This change was not made earlier since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/instrumentation provide BOTH the Status and OperationalStatus properties. Further, the first value of OperationalStatus SHOULD contain the primary status for the element. When instrumented, Status (since it is single-valued) SHOULD also provide the primary status of the element. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
Other
OK
Degraded
Stressed
Predictive Failure
Error
Non-Recoverable Error
Starting
Stopping
Stopped
In Service
No Contact
Lost Communication
Aborted
Dormant
Supporting Entity in Error
Completed
Power Mode
DMTF Reserved
Vendor Reserved
CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptions CIM_ManagedSystemElement

NameValue
0Unknown
1Other
2OK
3Degraded
4Stressed
5Predictive Failure
6Error
7Non-Recoverable Error
8Starting
9Stopping
10Stopped
11In Service
12No Contact
13Lost Communication
14Aborted
15Dormant
16Supporting Entity in Error
17Completed
18Power Mode
..DMTF Reserved
0x8000..Vendor Reserved
Property StatusDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringStrings describing the various OperationalStatus array values. For example, if " Stopping " is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus. CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatus CIM_ManagedSystemElement

Property Status Qualifiers
NameTypeValueFrom Class
DescriptionstringA string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the Deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
MaxLenuint3210 CIM_ManagedSystemElement

NameValue
OK[none]
Error[none]
Degraded[none]
Unknown[none]
Pred Fail[none]
Starting[none]
Stopping[none]
Service[none]
Stressed[none]
NonRecover[none]
No Contact[none]
Lost Comm[none]
Stopped[none]
Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement
MaxLenuint3264 CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object. CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA user-friendly name for the object. This property allows each instance to define a user-friendly name IN ADDITION TO its key properties/identity data, and description information. Note that ManagedSystemElement ’ s Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. CIM_ManagedElement

Methods

Method Qualifiers

Parameters

Parameter Qualifiers

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_MountCIM_DirectoryAntecedent
CIM_DirectoryContainsFileCIM_DirectoryGroupComponent
CIM_ExportCIM_DirectoryDirectory
CIM_ApplicationSystemDirectoryCIM_DirectoryAntecedent
CIM_DatabaseControlFileCIM_LogicalFileDependent
CIM_DirectoryContainsFileCIM_LogicalFilePartComponent
CIM_FileStorageCIM_LogicalFilePartComponent
CIM_DatabaseFileCIM_LogicalFilePartComponent
CIM_FileIdentityCIM_LogicalFileSystemElement
CIM_HelpServiceAvailableToFileCIM_LogicalFileUserOfService
CIM_ResidesOnExtentCIM_LogicalElementDependent
CIM_OperationLogCIM_LogicalElementDependent
CIM_LogicalElementUnitOfWorkDefCIM_LogicalElementAntecedent
CIM_LogicalElementPerformsUoWCIM_LogicalElementAntecedent
CIM_AllocatedFromStoragePoolCIM_LogicalElementDependent
CIM_AssociatedMemoryCIM_LogicalElementDependent
CIM_DiagnosticTestForMSECIM_ManagedSystemElementDependent
CIM_UseOfLogCIM_ManagedSystemElementDependent
CIM_SystemComponentCIM_ManagedSystemElementPartComponent
CIM_RedundancyComponentCIM_ManagedSystemElementPartComponent
CIM_CollectedMSEsCIM_ManagedSystemElementMember
CIM_ActsAsSpareCIM_ManagedSystemElementSpare
CIM_ElementSettingCIM_ManagedSystemElementElement
CIM_ElementConfigurationCIM_ManagedSystemElementElement
CIM_DiagnosticResultForMSECIM_ManagedSystemElementSystemElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_StatisticsCIM_ManagedElementElement
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement