A file or dataset store local to a System (such as a ComputerSystem or an ApplicationSystem) or remotely mounted from a file server. | Qualifiers:Version ( "2.7.0" ) | Parameters (local in grey) | | Units ( "Bytes" ) uint64 BlockSize ; FileSystems 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. | Propagated ( "CIM_System.CreationClassName" ) MaxLen ( 256 ) Key string CSCreationClassName ; The 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. | Values { "Unknown" , "Other" , "ASCII" , "Unicode" , "ISO2022" , "ISO8859" , "Extended UNIX Code" , "UTF-8" , "UCS-2" } ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" } uint16 CodeSet [ ] ; Array defining the character sets or encoding supported by the FileSystem. For example, the values, 'ASCII' (2) or 'ISO2022' (4), may be specified. | boolean CasePreserved ; Indicates that the case of file names are preserved. | MaxLen ( 256 ) Override ( "Name" ) Key string Name ; The inherited Name serves as key of a FileSystem instance within a ComputerSystem. | MappingStrings { "MIF.DMTF|Partition|002.8" } string EncryptionMethod ; A 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. | uint64 NumberOfFiles ; The number of files contained in the FileSystem. | MappingStrings { "MIF.DMTF|Partition|002.7" } string CompressionMethod ; A 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. | boolean CaseSensitive ; Indicates that case sensitive file names are supported. | MaxLen ( 256 ) Key string CreationClassName ; 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. | MappingStrings { "MIB.IETF|HOST-RESOURCES-MIB.hrFSMountPoint" , "MIF.DMTF|Host File System|001.2" } string Root ; Path name or other information defining the root of the FileSystem. | uint32 ClusterSize ; The 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. | Gauge MappingStrings { "MIF.DMTF|Host File System|001.14" , "MIF.DMTF|Partition|002.4" } Units ( "Bytes" ) uint64 AvailableSpace ; AvailableSpace indicates the total amount of free space for the FileSystem, in bytes. If unknown, enter 0. | uint32 MaxFileNameLength ; Integer indicating the maximum length of a file name within the FileSystem. 0 indicates that there is no limit on file name length. | Propagated ( "CIM_System.Name" ) MaxLen ( 256 ) Key string CSName ; The 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. | MappingStrings { "MIB.IETF|HOST-RESOURCES-MIB.hrFSAccess" , "MIF.DMTF|Host File System|001.5" } boolean ReadOnly ; Indicates that the FileSystem is designated as read only. | ModelCorrespondence { "CIM_FileSystem.PersistenceType" } string OtherPersistenceType ; A string describing the persistence characteristics when PersistenceType is 'Other'. | MappingStrings { "MIF.DMTF|Partition|002.6" , "MIF.DMTF|Host File System|001.4" } string FileSystemType ; String 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. | Values { "Unknown" , "Other" , "Persistent" , "Temporary" , "External" } ModelCorrespondence { "CIM_FileSystem.OtherPersistenceType" } ValueMap { "0" , "1" , "2" , "3" , "4" } uint16 PersistenceType ; An 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. | MappingStrings { "MIF.DMTF|Host File System|001.13" } Units ( "Bytes" ) uint64 FileSystemSize ; The FileSystemSize property stores the total size of the File System in bytes. If unknown, enter 0. | ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" } string OtherEnabledState ; A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ('Other'). This property must be set to null when EnabledState is any value other than 1. | Values { "Unknown" , "Other" , "Enabled" , "Disabled" , "Shutting Down" , "Not Applicable" , "Enabled but Offline" , "In Test" , "Deferred" , "Quiesce" , "Starting" , "DMTF Reserved" , "Vendor Reserved" } ModelCorrespondence { "CIM_EnabledLogicalElement.OtherEnabledState" } ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11..32767" , "32768..65535" } uint16 EnabledState = 5 ; EnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled and disabled states: Enabled (2) indicates that the element is or could be executing commands, will process any queued commands, and queues new requests. Disabled (3) indicates that the element will not execute commands and will drop any new requests. Shutting Down (4) indicates that the element is in the process of going to a Disabled state. Not Applicable (5) indicates the element does not support being enabled or disabled. Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests. Test (7) indicates that the element is in a test state. Deferred (8) indicates that the element might be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The behavior of the element is similar to the Enabled state, but it processes only a restricted set of commands. All other requests are queued. Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued. | datetime TimeOfLastStateChange ; The date or time when the EnabledState of the element last changed. If the state of the element has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated. | Values { "Completed with No Error" , "Not Supported" , "Unknown or Unspecified Error" , "Cannot complete within Timeout Period" , "Failed" , "Invalid Parameter" , "In Use" , "DMTF Reserved" , "Method Parameters Checked - Job Started" , "Invalid State Transition" , "Use of Timeout Parameter Not Supported" , "Busy" , "Method Reserved" , "Vendor Specific" } ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState" } ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "4096" , "4097" , "4098" , "4099" , "4100..32767" , "32768..65535" } uint32RequestStateChange( | | The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), 3 ('Timeout'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values. Qualifiers:Values { "Enabled" , "Disabled" , "Shut Down" , "Offline" , "Test" , "Defer" , "Quiesce" , "Reboot" , "Reset" , "DMTF Reserved" , "Vendor Reserved" }
IN
ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState" }
ValueMap { "2" , "3" , "4" , "6" , "7" , "8" , "9" , "10" , "11" , ".." , "32768..65535" }
| | uint16 RequestedState | | | Reference to the job (can be null if the task is completed). Qualifiers:OUT
IN ( false )
| | CIM_ConcreteJob REF Job | | | A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' must be returned. Qualifiers:IN
| | datetime TimeoutPeriod | ) Requests that the state of the element be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the EnabledState and RequestedState of the element will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or lost. If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition. | Values { "Enabled" , "Disabled" , "Shut Down" , "No Change" , "Offline" , "Test" , "Deferred" , "Quiesce" , "Reboot" , "Reset" , "Not Applicable" , "DMTF Reserved" , "Vendor Reserved" } ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" } ValueMap { "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , ".." , "32768..65535" } uint16 RequestedState = 12 ; RequestedState is an integer enumeration that indicates the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. Note that when EnabledState is set to 5 ('Not Applicable'), then this property has no meaning. By default, the RequestedState of the element is 5 ('No Change'). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration. It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are 'Reboot' (10) and 'Reset' (11). Reboot refers to doing a 'Shut Down' and then moving to an 'Enabled' state. Reset indicates that the element is first 'Disabled' and then 'Enabled'. The distinction between requesting 'Shut Down' and 'Disabled' should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code. A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ('Not Applicable') is used. | Values { "Enabled" , "Disabled" , "Not Applicable" , "Enabled but Offline" , "No Default" , "DMTF Reserved" , "Vendor Reserved" } Write ValueMap { "2" , "3" , "5" , "6" , "7" , "8..32767" , "32768..65535" } uint16 EnabledDefault = 2 ; An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is 'Enabled' (value=2). | ModelCorrespondence { "CIM_ManagedSystemElement.OperationalStatus" } ArrayType ( "Indexed" ) string StatusDescriptions [ ] ; Strings 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. | Values { "Unknown" , "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" } ModelCorrespondence { "CIM_ManagedSystemElement.StatusDescriptions" } ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , ".." , "0x8000.." } ArrayType ( "Indexed" ) uint16 OperationalStatus [ ] ; Indicates 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. | MappingStrings { "MIF.DMTF|ComponentID|001.5" } datetime InstallDate ; A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. | MaxLen ( 10 ) Deprecated { "CIM_ManagedSystemElement.OperationalStatus" } ValueMap { "OK" , "Error" , "Degraded" , "Unknown" , "Pred Fail" , "Starting" , "Stopping" , "Service" , "Stressed" , "NonRecover" , "No Contact" , "Lost Comm" , "Stopped" } string Status ; A 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. | MaxLen ( 64 ) string Caption ; The Caption property is a short textual description (one- line string) of the object. | string Description ; The Description property provides a textual description of the object. | string ElementName ; A 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. |
| | | | |
|