Class CIM_UnixFile
extends CIM_LogicalElement

The 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.

Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_UnixFile

Direct Known Subclasses

None.

Class Qualifiers

NameData TypeValueScopeFlavors
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.None TRANSLATABLE= true
Versionstring2.6.0TOSUBCLASS= falseTRANSLATABLE= true

Local Class Properties

NameData TypeQualifiers
NameData TypeValueScopeFlavors
Captionstring
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.None TRANSLATABLE= true
MaxLenuint3264None None
CSCreationClassNamestring
DescriptionstringThe scoping ComputerSystem's CreationClassName.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_LogicalFile.CSCreationClassNameNone OVERRIDABLE= false
CSNamestring
DescriptionstringThe scoping ComputerSystem's Name.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_LogicalFile.CSNameNone OVERRIDABLE= false
Descriptionstring
DescriptionstringThe Description property provides a textual description of the object.None TRANSLATABLE= true
ElementNamestring
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.None TRANSLATABLE= true
FileInodeNumberstring
DescriptionstringFile Inode number, as printed by "ls -i".None TRANSLATABLE= true
MappingStringsstringUNIX.TOG|ls -iNone None
FSCreationClassNamestring
DescriptionstringThe scoping FileSystem's CreationClassName.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_LogicalFile.FSCreationClassNameNone OVERRIDABLE= false
FSNamestring
DescriptionstringThe scoping FileSystem's Name.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_LogicalFile.FSNameNone OVERRIDABLE= false
GroupIDstring
DescriptionstringAn identifier that describes the group that owns this file.None TRANSLATABLE= true
RequiredbooleantrueNone OVERRIDABLE= false
InstallDatedatetime
DescriptionstringA datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.None TRANSLATABLE= true
MappingStringsstringMIF.DMTF|ComponentID|001.5None None
LastModifiedInodedatetime
DescriptionstringThe time that the Inode was last modified. This includes the Inode creation time, state modification, and etc.None TRANSLATABLE= true
LFCreationClassNamestring
DescriptionstringThe scoping LogicalFile's CreationClassName.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_LogicalFile.CreationClassNameNone OVERRIDABLE= false
LFNamestring
DescriptionstringThe scoping LogicalFile's Name.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint321024None None
PropagatedstringCIM_LogicalFile.NameNone OVERRIDABLE= false
LinkCountuint64
CounterbooleantrueNone None
DescriptionstringCount of the number of names for this file.None TRANSLATABLE= true
LinkMaxuint64
DescriptionstringMaximum number of links to a single file.None TRANSLATABLE= true
MappingStringsstringPOSIX.TOG|pathconf|_PC_LINK_MAXNone None
MinValuesint648None None
Namestring
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.None TRANSLATABLE= true
MaxLenuint321024None None
NameMaxuint64
DescriptionstringMaximum number of bytes in a filename, not including terminating null.None TRANSLATABLE= true
MappingStringsstringPOSIX.TOG|pathconf|_POSIX_NAME_MAXNone None
MinValuesint6414None None
UnitsstringBytesNone TRANSLATABLE= true
PathMaxuint64
DescriptionstringMaximum number of bytes in a pathname, including the terminating null character.None TRANSLATABLE= true
MappingStringsstringPOSIX.TOG|pathconf|_POSIX_PATH_MAXNone None
MinValuesint64255None None
UnitsstringBytesNone TRANSLATABLE= true
PosixAsyncIouint64
DescriptionstringIndicates whether asynchronous input or output operations may be performed for the associated file.None TRANSLATABLE= true
MappingStringsstringPOSIX.TOG|pathconf|_PC_ASYNC_IONone None
PosixChownRestricteduint64
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.None TRANSLATABLE= true
MappingStringsstringPOSIX.TOG|pathconf|_PC_CHOWN_RESTRICTEDNone None
PosixNoTruncuint64
DescriptionstringIndicates whether pathname components longer than NameMax generate an error.None TRANSLATABLE= true
MappingStringsstringPOSIX.TOG|pathconf|_PC_NO_TRUNCNone None
ModelCorrespondencestringCIM_UnixFile.NameMaxNone None
PosixPrioIouint64
DescriptionstringIndicates whether prioritized input or output operations may be performed for the associated file.None TRANSLATABLE= true
MappingStringsstringPOSIX.TOG|pathconf|_PC_PRIO_IONone None
PosixSyncIouint64
DescriptionstringIndicates whether synchronised input or output operations may be performed for the associated file.None TRANSLATABLE= true
MappingStringsstringPOSIX.TOG|pathconf|_PC_SYNC_IONone None
SaveTextboolean
DescriptionstringIndicates restricted deletion for directories, or possible implementation defined properties for executable files. For directories this is known as the sticky bit.None TRANSLATABLE= true
SetGidboolean
DescriptionstringIndicates whether the associated file has setgid permissions.None TRANSLATABLE= true
SetUidboolean
DescriptionstringIndicates whether the associated file has setuid permissions.None TRANSLATABLE= true
Statusstring
DeprecatedstringCIM_ManagedSystemElement.OperationalStatusTOSUBCLASS= falseNone
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.None TRANSLATABLE= true
MaxLenuint3210None None
ValueMapstringOK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, NonRecover, No Contact, Lost Comm, StoppedNone None
UserIDstring
DescriptionstringAn Identifer that uniquely describes the owner of this file.None TRANSLATABLE= true
RequiredbooleantrueNone OVERRIDABLE= false
OperationalStatusuint16[]
ArrayTypestringIndexedNone OVERRIDABLE= false
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.None TRANSLATABLE= true
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptionsNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, .., 0x8000..None None
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 ReservedNone TRANSLATABLE= true
StatusDescriptionsstring[]
ArrayTypestringIndexedNone OVERRIDABLE= false
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.None TRANSLATABLE= true
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatusNone None