CIM211 Class Declaration
CIM_UnixFile

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

Class Hierarchy

CIM_UnixFile --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_LogicalElement
NAMECIM_UnixFile

Class Qualifiers

Class CIM_UnixFile Qualifiers
NameTypeValueFrom Class
Versionstring2.6.0 CIM_UnixFile
DescriptionstringThe UnixFile class holds properties that are valid for various subclasses of LogicalFile, in a Unix environment. This is defined as a separate and unique class since it is applicable to Unix files, directories, etc. It is associated via a FileIdentity relationship to these subclasses of LogicalFile. Unless this approach of creating and associating a separate class is used, it is necessary to subclass each of the inheritance hierarchies under LogicalFile, duplicating the properties in this class. The referenced _PC* and _POSIX* constants are defined in unistd.h. Some properties indicate whether the UNIX implementation support a feature such as asynchronous I/O or priority I/O. If supported, sysconf returns the value as defined in the appropriate header file such as unistd.h. If a feature is not supported, then pathconf returns a -1. In this case, the corresponding property should be returned without any value. CIM_UnixFile
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_UnixFile
CSNamestring Key
Propagated
Description
MaxLen
CIM_UnixFile
FSCreationClassNamestring Key
Propagated
Description
MaxLen
CIM_UnixFile
FSNamestring Key
Propagated
Description
MaxLen
CIM_UnixFile
LFCreationClassNamestring Key
Propagated
Description
MaxLen
CIM_UnixFile
LFNamestring Key
Propagated
Description
MaxLen
CIM_UnixFile
UserIDstring Required
Description
CIM_UnixFile
GroupIDstring Required
Description
CIM_UnixFile
SaveTextboolean Description CIM_UnixFile
LinkCountuint64 Description
Counter
CIM_UnixFile
FileInodeNumberstring Description
MappingStrings
CIM_UnixFile
SetUidboolean Description CIM_UnixFile
SetGidboolean Description CIM_UnixFile
LastModifiedInodedatetime Description CIM_UnixFile
LinkMaxuint64 Description
MinValue
MappingStrings
CIM_UnixFile
NameMaxuint64 Description
Units
MinValue
MappingStrings
CIM_UnixFile
PathMaxuint64 Description
Units
MinValue
MappingStrings
CIM_UnixFile
PosixChownRestricteduint64 Description
MappingStrings
CIM_UnixFile
PosixNoTruncuint64 Description
MappingStrings
ModelCorrespondence
CIM_UnixFile
PosixAsyncIouint64 Description
MappingStrings
CIM_UnixFile
PosixPrioIouint64 Description
MappingStrings
CIM_UnixFile
PosixSyncIouint64 Description
MappingStrings
CIM_UnixFile
InstallDatedatetime Description
MappingStrings
CIM_ManagedSystemElement
Namestring Description
MaxLen
CIM_ManagedSystemElement
OperationalStatusuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
StatusDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
Statusstring Deprecated
Description
ValueMap
MaxLen
CIM_ManagedSystemElement
HealthStateuint16 Description
ValueMap
Values
CIM_ManagedSystemElement
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement
ElementNamestring Description CIM_ManagedElement

Property Qualifiers

Property CSCreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_UnixFile
PropagatedstringCIM_LogicalFile.CSCreationClassName CIM_UnixFile
DescriptionstringThe scoping ComputerSystem ’ s CreationClassName. CIM_UnixFile
MaxLenuint32256 CIM_UnixFile

Property CSName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_UnixFile
PropagatedstringCIM_LogicalFile.CSName CIM_UnixFile
DescriptionstringThe scoping ComputerSystem ’ s Name. CIM_UnixFile
MaxLenuint32256 CIM_UnixFile

Property FSCreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_UnixFile
PropagatedstringCIM_LogicalFile.FSCreationClassName CIM_UnixFile
DescriptionstringThe scoping FileSystem ’ s CreationClassName. CIM_UnixFile
MaxLenuint32256 CIM_UnixFile

Property FSName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_UnixFile
PropagatedstringCIM_LogicalFile.FSName CIM_UnixFile
DescriptionstringThe scoping FileSystem ’ s Name. CIM_UnixFile
MaxLenuint32256 CIM_UnixFile

Property LFCreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_UnixFile
PropagatedstringCIM_LogicalFile.CreationClassName CIM_UnixFile
DescriptionstringThe scoping LogicalFile ’ s CreationClassName. CIM_UnixFile
MaxLenuint32256 CIM_UnixFile

Property LFName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_UnixFile
PropagatedstringCIM_LogicalFile.Name CIM_UnixFile
DescriptionstringThe scoping LogicalFile ’ s Name. CIM_UnixFile
MaxLenuint321024 CIM_UnixFile

Property UserID Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_UnixFile
DescriptionstringAn Identifer that uniquely describes the owner of this file. CIM_UnixFile

Property GroupID Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_UnixFile
DescriptionstringAn identifier that describes the group that owns this file. CIM_UnixFile

Property SaveText Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates restricted deletion for directories, or possible implementation defined properties for executable files. For directories this is known as the sticky bit. CIM_UnixFile

Property LinkCount Qualifiers
NameTypeValueFrom Class
DescriptionstringCount of the number of names for this file. CIM_UnixFile
Counterbooleantrue CIM_UnixFile

Property FileInodeNumber Qualifiers
NameTypeValueFrom Class
DescriptionstringFile Inode number, as printed by " ls -i " . CIM_UnixFile
MappingStringsstringUNIX.TOG|ls -i CIM_UnixFile

Property SetUid Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates whether the associated file has setuid permissions. CIM_UnixFile

Property SetGid Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates whether the associated file has setgid permissions. CIM_UnixFile

Property LastModifiedInode Qualifiers
NameTypeValueFrom Class
DescriptionstringThe time that the Inode was last modified. This includes the Inode creation time, state modification, and etc. CIM_UnixFile

Property LinkMax Qualifiers
NameTypeValueFrom Class
DescriptionstringMaximum number of links to a single file. CIM_UnixFile
MinValuesint648 CIM_UnixFile
MappingStringsstringPOSIX.TOG|pathconf|_PC_LINK_MAX CIM_UnixFile

Property NameMax Qualifiers
NameTypeValueFrom Class
DescriptionstringMaximum number of bytes in a filename, not including terminating null. CIM_UnixFile
UnitsstringBytes CIM_UnixFile
MinValuesint6414 CIM_UnixFile
MappingStringsstringPOSIX.TOG|pathconf|_POSIX_NAME_MAX CIM_UnixFile

Property PathMax Qualifiers
NameTypeValueFrom Class
DescriptionstringMaximum number of bytes in a pathname, including the terminating null character. CIM_UnixFile
UnitsstringBytes CIM_UnixFile
MinValuesint64255 CIM_UnixFile
MappingStringsstringPOSIX.TOG|pathconf|_POSIX_PATH_MAX CIM_UnixFile

Property PosixChownRestricted Qualifiers
NameTypeValueFrom Class
DescriptionstringThe use of chown() is restricted to a process with appropriate privileges. chown() is used to change the group ID of a file. The group ID can be changed to the effective group ID or one of its supplementary group IDs. CIM_UnixFile
MappingStringsstringPOSIX.TOG|pathconf|_PC_CHOWN_RESTRICTED CIM_UnixFile

Property PosixNoTrunc Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates whether pathname components longer than NameMax generate an error. CIM_UnixFile
MappingStringsstringPOSIX.TOG|pathconf|_PC_NO_TRUNC CIM_UnixFile
ModelCorrespondencestringCIM_UnixFile.NameMax CIM_UnixFile

Property PosixAsyncIo Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates whether asynchronous input or output operations may be performed for the associated file. CIM_UnixFile
MappingStringsstringPOSIX.TOG|pathconf|_PC_ASYNC_IO CIM_UnixFile

Property PosixPrioIo Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates whether prioritized input or output operations may be performed for the associated file. CIM_UnixFile
MappingStringsstringPOSIX.TOG|pathconf|_PC_PRIO_IO CIM_UnixFile

Property PosixSyncIo Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates whether synchronised input or output operations may be performed for the associated file. CIM_UnixFile
MappingStringsstringPOSIX.TOG|pathconf|_PC_SYNC_IO CIM_UnixFile

Property InstallDate Qualifiers
NameTypeValueFrom Class
DescriptionstringA datetime value that indicates when the object was installed. 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 statuses of the element. Various operational statuses are defined. Many of the enumeration ’ s values are self-explanatory. However, a few are not and are described here in more detail. " Stressed " indicates that the element is functioning, but needs attention. Examples of " Stressed " states are overload, overheated, and so on. " 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 state and configuration of the element might need to be updated. " Dormant " indicates that the element is inactive or quiesced. " Supporting Entity in Error " indicates that this element might 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 that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error). " Power Mode " indicates that 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 because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or 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 (because 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 definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. 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 HealthState Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. The following continuum is defined: " Non-recoverable Error " (30) - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost. " Critical Failure " (25) - The element is non-functional and recovery might not be possible. " Major Failure " (20) - The element is failing. It is possible that some or all of the functionality of this component is degraded or not working. " Minor Failure " (15) - All functionality is available but some might be degraded. " Degraded/Warning " (10) - The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors. " OK " (5) - The element is fully functional and is operating within normal operational parameters and without error. " Unknown " (0) - The implementation cannot report on HealthState at this time. DMTF has reserved the unused portion of the continuum for additional HealthStates in the future. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
OK
Degraded/Warning
Minor failure
Major failure
Critical failure
Non-recoverable error
DMTF Reserved
CIM_ManagedSystemElement

NameValue
0Unknown
5OK
10Degraded/Warning
15Minor failure
20Major failure
25Critical failure
30Non-recoverable error
..DMTF Reserved
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 the Name property of ManagedSystemElement 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 can 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_FileIdentityCIM_UnixFileSameElement
CIM_LogicalElementPerformsUoWCIM_LogicalElementAntecedent
CIM_ImportedShareRootCIM_LogicalElementAntecedent
CIM_ImportedShareRootCIM_LogicalElementDependent
CIM_LogicalElementUnitOfWorkDefCIM_LogicalElementAntecedent
CIM_SharedElementRootCIM_LogicalElementAntecedent
CIM_OperationLogCIM_LogicalElementDependent
CIM_AllocatedFromStoragePoolCIM_LogicalElementDependent
CIM_ResidesOnExtentCIM_LogicalElementDependent
CIM_AssociatedMemoryCIM_LogicalElementDependent
CIM_AttachedElementCIM_LogicalElementSystemElement
CIM_AttachedElementCIM_LogicalElementSameElement
CIM_MountedElementCIM_LogicalElementSystemElement
CIM_MountedElementCIM_LogicalElementSameElement
CIM_ImportedShareCIM_LogicalElementSystemElement
CIM_ImportedShareCIM_LogicalElementSameElement
CIM_SharedElementCIM_LogicalElementSystemElement
CIM_RedundancyComponentCIM_ManagedSystemElementPartComponent
CIM_SystemComponentCIM_ManagedSystemElementPartComponent
CIM_UseOfLogCIM_ManagedSystemElementDependent
CIM_DiagnosticTestForMSECIM_ManagedSystemElementDependent
CIM_CollectedMSEsCIM_ManagedSystemElementMember
CIM_DiagnosticResultForMSECIM_ManagedSystemElementSystemElement
CIM_ElementConfigurationCIM_ManagedSystemElementElement
CIM_ElementSettingCIM_ManagedSystemElementElement
CIM_ActsAsSpareCIM_ManagedSystemElementSpare
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement