A MediaAccessDevice represents the ability to access one or more media and use this media to store and retrieve data. | Qualifiers:Version ( "2.6.0" ) UMLPackagePath ( "CIM::Device::StorageDevices" ) | Parameters (local in grey) | | uint64 TotalMountTime ; For a MediaAccessDevice that supports removable Media, the total time (in seconds) that Media have been mounted for data transfer or to clean the Device. For Devices accessing nonremovable Media, such as hard disks, this property is not applicable and should be set to 0. | Units ( "MilliSeconds" ) uint64 LoadTime ; Time in milliseconds from 'load' to being able to read or write a Media. For example, for DiskDrives, this is the interval between a disk not spinning to the disk reporting that it is ready for read/write (ie, the disk spinning at nominal speeds). For TapeDrives, this is the time from a Media being injected to reporting that it is ready for an application. This is usually at the tape's BOT area. | Units ( "MilliSeconds" ) uint64 MaxAccessTime ; Time in milliseconds to move from the first location on the Media to the location that is furthest with respect to time. For a DiskDrive, this represents full seek + full rotational delay. For TapeDrives, this represents a search from the beginning of the tape to the most physically distant point. (The end of a tape may be at its most physically distant point, but this is not necessarily true.) | Counter uint64 MountCount ; For a MediaAccessDevice that supports removable Media, the number of times that Media have been mounted for data transfer or to clean the Device. For Devices accessing nonremovable Media, such as hard disks, this property is not applicable and should be set to 0. | ModelCorrespondence { "CIM_MediaAccessDevice.MaxUnitsBeforeCleaning" , "CIM_MediaAccessDevice.UnitsUsed" } string UnitsDescription ; Defines 'Units' relative to its use in the property, MaxUnitsBeforeCleaning. This describes the criteria used to determine when the MediaAccessDevice should be cleaned. | uint32LockMedia( | | If TRUE, lock the media. If FALSE release the media. Qualifiers:IN
| | boolean Lock | ) Method to lock and unlock the media in a removeable Access Device. The method takes one parameter as input - a boolean indicating whether to lock or unlock. TRUE indicates that the media should be locked in the Device, FALSE indicates that the media should be unlocked. The method returns 0 if successful, 1 if not supported, and any other value if an error occurred. The set of possible return codes should be specified in a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' should be specified as a Values array qualifier on the method. | string ErrorMethodology ; ErrorMethodology is a free-form string describing the type(s) of error detection and correction supported by this Device. | Units ( "Bytes" ) uint64 MaxBlockSize ; Maximum block size, in bytes, for media accessed by this Device. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" } ArrayType ( "Indexed" ) Values { "Unknown" , "Other" , "Sequential Access" , "Random Access" , "Supports Writing" , "Encryption" , "Compression" , "Supports Removeable Media" , "Manual Cleaning" , "Automatic Cleaning" , "SMART Notification" , "Supports Dual Sided Media" , "Predismount Eject Not Required" } MappingStrings { "MIF.DMTF|Storage Devices|001.9" , "MIF.DMTF|Storage Devices|001.11" , "MIF.DMTF|Storage Devices|001.12" , "MIF.DMTF|Disks|003.7" , "MIF.DMTF|Host Disk|001.2" , "MIF.DMTF|Host Disk|001.4" } ModelCorrespondence { "CIM_MediaAccessDevice.CapabilityDescriptions" } uint16 Capabilities [ ] ; Capabilities of the MediaAccessDevice. For example, the Device may support 'Random Access', removeable media and 'Automatic Cleaning'. In this case, the values 3, 7 and 9 would be written to the array. Several of the enumerated values require some explanation: 1) Value 11, Supports Dual Sided Media, distinguishes a Device that can access both sides of dual sided Media, from a Device that reads only a single side and requires the Media to be flipped; and, 2) Value 12, Predismount Eject Not Required, indicates that Media does not have to be explicitly ejected from the Device before being accessed by a PickerElement. | boolean MediaIsLocked ; True indicates that the media is locked in the Device and can not be ejected. For non-removeable Devices, this value should be true. | datetime TimeOfLastMount ; For a MediaAccessDevice that supports removable Media, the most recent date and time that Media was mounted on the Device. For Devices accessing nonremovable Media, such as hard disks, this property has no meaning and is not applicable. | ModelCorrespondence { "CIM_MediaAccessDevice.UnitsDescription" } uint64 MaxUnitsBeforeCleaning ; An unsigned integer indicating the maximum 'units' that can be used, with respect to the AccessDevice, before the Device should be cleaned. The property, UnitsDescription, defines how 'units' should be interpreted. | ValueMap { "1" , "2" , "3" , "4" , "5" , "6" , "7" } Values { "Other" , "Unknown" , "None" , "Read Only" , "Locked Out" , "Boot Bypass" , "Boot Bypass and Read Only" } MappingStrings { "MIF.DMTF|Disks|003.22" } uint16 Security ; An enumeration indicating the operational security defined for the MediaAccessDevice. For example, information that the Device is 'Read Only' (value=4) or 'Boot Bypass' (value=6) can be described using this property. | Gauge ModelCorrespondence { "CIM_MediaAccessDevice.UnitsDescription" , "CIM_MediaAccessDevice.MaxUnitsBeforeCleaning" } uint64 UnitsUsed ; An unsigned integer indicating the currently used 'units' of the AccessDevice, helpful to describe when the Device may require cleaning. The property, UnitsDescription, defines how 'units' should be interpreted. | uint32 NumberOfMediaSupported ; When the MediaAccessDevice supports multiple individual Media, this property defines the maximum number which can be supported or inserted. | datetime LastCleaned ; The date and time on which the Device was last cleaned. | Units ( "KiloBytes per Second" ) uint32 UncompressedDataRate ; The sustained data transfer rate in KB/sec that the Device can read from and write to a Media. This is a sustained, raw data rate. Maximum rates or rates assuming compression should not be reported in this property. | string CompressionMethod ; A free form string indicating the algorithm or tool used by the device to support compression. 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 device supports compression capabilities or not, 'Compressed' to represent that the device supports compression capabilities but either its compression scheme is not known or not disclosed, and 'Not Compressed' to represent that the devices does not support compression capabilities. | Units ( "Bytes" ) uint64 MinBlockSize ; Minimum block size, in bytes, for media accessed by this Device. | Units ( "MilliSeconds" ) uint64 UnloadTime ; Time in milliseconds from being able to read or write a Media to its 'unload'. For example, for DiskDrives, this is the interval between a disk spinning at nominal speeds and a disk not spinning. For TapeDrives, this is the time for a Media to go from its BOT to being fully ejected and accessible to a PickerElement or human operator. | boolean NeedsCleaning ; Boolean indicating that the MediaAccessDevice needs cleaning. Whether manual or automatic cleaning is possible is indicated in the Capabilities array property. | ArrayType ( "Indexed" ) ModelCorrespondence { "CIM_MediaAccessDevice.Capabilities" } string CapabilityDescriptions [ ] ; An array of free-form strings providing more detailed explanations for any of the AccessDevice features indicated in the Capabilities array. Note, each entry of this array is related to the entry in the Capabilities array that is located at the same index. | MappingStrings { "MIF.DMTF|Sequential Access Devices|001.2" , "MIF.DMTF|Host Disk|001.5" } uint64 MaxMediaSize ; Maximum size, in KBytes, of media supported by this Device. KBytes is interpreted as the number of bytes multiplied by 1000 (NOT the number of bytes multiplied by 1024). | Units ( "Bytes" ) uint64 DefaultBlockSize ; Default block size, in bytes, for this Device. | Units ( "MilliSeconds" ) Deprecated { "No value" } uint64 MaxQuiesceTime ; The MaxQuiesceTime property has been deprecated. When evaluating the use of Quiesce, it was determine that this single property is not adequate for describing when a device will automatically exit a quiescent state. In fact, the most likely scenario for a device to exit a quiescent state was determined to be based on the number of outstanding requests queued rather than on a maximum time. This will be re-evaluated and repositioned later. Maximum time in milliseconds, that a Device can run in a 'Quiesced' state. A Device's state is defined in its Availability and AdditionalAvailability properties, where 'Quiesced' is conveyed by the value 21. What occurs at the end of the time limit is device-specific. The Device may unquiesce, may offline or take other action. A value of 0 indicates that a Device can remain quiesced indefinitely. | ArrayType ( "Indexed" ) ModelCorrespondence { "CIM_LogicalDevice.OtherIdentifyingInfo" } string IdentifyingDescriptions [ ] ; An array of free-form strings providing explanations and details behind the entries in the OtherIdentifyingInfo array. Note, each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the same index. | MaxLen ( 256 ) Propagated ( "CIM_System.Name" ) Key string SystemName ; The scoping System's Name. | Counter Units ( "Hours" ) uint64 TotalPowerOnHours ; The total number of hours that this Device has been powered. | Deprecated { "CIM_DeviceErrorData.ErrorDescription" } string ErrorDescription ; ErrorDescription is a free-form string supplying more information about the error recorded in LastErrorCode, and information on any corrective actions that may be taken. | ValueMap { "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , "19" , "20" , "21" } Values { "Other" , "Unknown" , "Running/Full Power" , "Warning" , "In Test" , "Not Applicable" , "Power Off" , "Off Line" , "Off Duty" , "Degraded" , "Not Installed" , "Install Error" , "Power Save - Unknown" , "Power Save - Low Power Mode" , "Power Save - Standby" , "Power Cycle" , "Power Save - Warning" , "Paused" , "Not Ready" , "Not Configured" , "Quiesced" } ModelCorrespondence { "CIM_LogicalDevice.Availability" } uint16 AdditionalAvailability [ ] ; Additional availability and status of the Device, beyond that specified in the Availability property. The Availability property denotes the primary status and availability of the Device. In some cases, this will not be sufficient to denote the complete status of the Device. In those cases, the AdditionalAvailability property can be used to provide further information. For example, a Device's primary Availability may be 'Off line' (value=8), but it may also be in a low power state (AdditonalAvailability value=14), or the Device could be running Diagnostics (AdditionalAvailability value=5, 'In Test'). | uint32SaveProperties() Requests that the Device capture its current configuration, setup and/or state information in a backing store. The goal would be to use this information at a later time (via the RestoreProperties method), to return a Device to its present 'condition'. This method may not be supported by all Devices. The method should return 0 if successful, 1 if the request is not supported, and some other value if any other error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' may also be specified in the subclass as a Values array qualifier. | uint32RestoreProperties() Requests that the Device re-establish its configuration, setup and/or state information from a backing store. The intent is to capture this information at an earlier time (via the SaveProperties method), and use it to return a Device to this earlier 'condition'. This method may not be supported by all Devices. The method should return 0 if successful, 1 if the request is not supported, and some other value if any other error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' may also be specified in the subclass as a Values array qualifier. | ArrayType ( "Indexed" ) MaxLen ( 256 ) ModelCorrespondence { "CIM_LogicalDevice.IdentifyingDescriptions" } string OtherIdentifyingInfo [ ] ; OtherIdentifyingInfo captures additional data, beyond DeviceID information, that could be used to identify a LogicalDevice. One example would be to hold the Operating System's user friendly name for the Device in this property. | Deprecated { "CIM_EnabledLogicalElement.RequestStateChange" } uint32OnlineDevice( | | If TRUE, take the device online, if FALSE, take the device OFFLINE. Qualifiers:IN
| | boolean Online |
)
The OnlineDevice method has been deprecated in lieu of the more general RequestStateChange method that directly overlaps with the functionality provided by this method. Requests that the LogicalDevice be brought online ('Online' input parameter = TRUE) or taken offline (= FALSE). 'Online' indicates that the Device is ready to accept requests, and is operational and fully functioning. In this case, the Device's Availability property would be set to a value of 3 ('Running/Full Power'). 'Offline' indicates that a Device is powered up and operational, but not processing functional requests. In an offline state, a Device may be capable of running diagnostics or generating operational alerts. For example, when the 'Offline' button is pushed on a Printer, the Device is no longer available to process print jobs, but could be available for diagnostics or maintenance. If this method is successful, the Device's Availability and AdditionalAvailability properties should reflect the updated status. If a failure occurs trying to bring the Device online or offline, it should remain in its current state. IE, the request, if unsuccessful, should not leave the Device in an indeterminate state. When bringing a Device back 'Online', from an 'Offline' mode, the Device should be restored to its last 'Online' state, if at all possible. Only a Device that has an EnabledState/StatusInfo of 'Enabled' and has been configured can be brought online or taken offline. OnlineDevice should return 0 if successful, 1 if the request is not supported at all, 2 if the request is not supported due to the current state of the Device, and some other value if any other error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' may also be specified in the subclass as a Values array qualifier. Note that this method's function overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (i.e., a persisted value) of the last state request. Invoking the OnlineDevice method should set the RequestedState property appropriately. | Deprecated { "CIM_DeviceErrorData.LastErrorCode" } uint32 LastErrorCode ; LastErrorCode captures the last error code reported by the LogicalDevice. | Deprecated { "CIM_PowerManagementService.SetPowerState" } uint32SetPowerState( | | The power state to set. Qualifiers:ValueMap { "1" , "2" , "3" , "4" , "5" , "6" }
Values { "Full Power" , "Power Save - Low Power Mode" , "Power Save - Standby" , "Power Save - Other" , "Power Cycle" , "Power Off" }
IN
| | uint16 PowerState | | | Time indicates when the power state should be set, either as a regular date-time value or as an interval value (where the interval begins when the method invocation is received. Qualifiers:IN
| | datetime Time |
)
Sets the power state of the Device. The use of this method has been deprecated. Instead, use the SetPowerState method in the associated PowerManagementService class. | ValueMap { "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , "19" , "20" , "21" } Values { "Other" , "Unknown" , "Running/Full Power" , "Warning" , "In Test" , "Not Applicable" , "Power Off" , "Off Line" , "Off Duty" , "Degraded" , "Not Installed" , "Install Error" , "Power Save - Unknown" , "Power Save - Low Power Mode" , "Power Save - Standby" , "Power Cycle" , "Power Save - Warning" , "Paused" , "Not Ready" , "Not Configured" , "Quiesced" } MappingStrings { "MIF.DMTF|Operational State|006.5" , "MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus" , "MIF.DMTF|Host Device|001.5" } ModelCorrespondence { "CIM_LogicalDevice.AdditionalAvailability" } uint16 Availability ; The primary availability and status of the Device. (Additional status information can be specified using the Additional Availability array property.) For example, the Availability property indicates that the Device is running and has full power (value=3), or is in a warning (4), test (5), degraded (10) or power save state (values 13-15 and 17). Regarding the Power Save states, these are defined as follows: Value 13 ('Power Save - Unknown') indicates that the Device is known to be in a power save mode, but its exact status in this mode is unknown; 14 ('Power Save - Low Power Mode') indicates that the Device is in a power save state but still functioning, and may exhibit degraded performance; 15 ('Power Save - Standby') describes that the Device is not functioning but could be brought to full power 'quickly'; and value 17 ('Power Save - Warning') indicates that the Device is in a warning state, though also in a power save mode. | Deprecated { "CIM_EnabledLogicalElement.RequestStateChange" } uint32EnableDevice( | | If TRUE enable the device, if FALSE disable the device. Qualifiers:IN
| | boolean Enabled |
)
The EnableDevice method has been deprecated in lieu of the more general RequestStateChange method that directly overlaps with the functionality provided by this method. Requests that the LogicalDevice be enabled ('Enabled' input parameter = TRUE) or disabled (= FALSE). If successful, the Device's StatusInfo/EnabledState properties should reflect the desired state (enabled/disabled). Note that this method's function overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (i.e., a persisted value) of the last state request. Invoking the EnableDevice method should set the RequestedState property appropriately. The return code should be 0 if the request was successfully executed, 1 if the request is not supported and some other value if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' may also be specified in the subclass as a Values array qualifier. | ValueMap { "1" , "2" , "3" , "4" , "5" } Values { "Other" , "Unknown" , "Enabled" , "Disabled" , "Not Applicable" } MappingStrings { "MIF.DMTF|Operational State|006.4" } Deprecated { "CIM_EnabledLogicalElement.EnabledState" } uint16 StatusInfo ; The StatusInfo property indicates whether the Logical Device is in an enabled (value = 3), disabled (value = 4) or some other (1) or unknown (2) state. If this property does not apply to the LogicalDevice, the value, 5 ('Not Applicable'), should be used. StatusInfo has been deprecated in lieu of a more clearly named property with additional enumerated values (EnabledState), that is inherited from ManagedSystemElement. If a Device is ('Enabled')(value=3), it has been powered up, and is configured and operational. The Device may or may not be functionally active, depending on whether its Availability (or AdditionalAvailability) indicate that it is ('Running/Full Power')(value=3) or ('Off line') (value=8). In an enabled but offline mode, a Device may be performing out-of-band requests, such as running Diagnostics. If ('Disabled') StatusInfo value=4), a Device can only be 'enabled' or powered off. In a personal computer environment, ('Disabled') means that the Device's driver is not available in the stack. In other environments, a Device can be disabled by removing its configuration file. A disabled device is physically present in a System and consuming resources, but can not be communicated with until a load of a driver, a load of a configuration file or some other 'enabling' activity has occurred. | Deprecated { "CIM_PowerManagementCapabilities" } boolean PowerManagementSupported ; Boolean indicating that the Device can be power managed. The use of this property has been deprecated. Instead, the existence of an associated PowerManagementCapabilities class (associated using the ElementCapabilities relationhip) indicates that power management is supported. | MaxLen ( 64 ) Key string DeviceID ; An address or other identifying information to uniquely name the LogicalDevice. | MaxLen ( 256 ) Propagated ( "CIM_System.CreationClassName" ) Key string SystemCreationClassName ; The scoping System's CreationClassName. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" } Values { "Unknown" , "Not Supported" , "Disabled" , "Enabled" , "Power Saving Modes Entered Automatically" , "Power State Settable" , "Power Cycling Supported" , "Timed Power On Supported" } Deprecated { "CIM_PowerManagementCapabilities.PowerCapabilities" } uint16 PowerManagementCapabilities [ ] ; An enumerated array describing the power management capabilities of the Device. The use of this property has been deprecated. Instead, the PowerCapabilites property in an associated PowerManagementCapabilities class should be used. | Counter Units ( "Hours" ) uint64 PowerOnHours ; The number of consecutive hours that this Device has been powered, since its last power cycle. | Deprecated { "CIM_ManagedSystemElement.OperationalStatus" } boolean ErrorCleared ; ErrorCleared is a boolean property indicating that the error reported in LastErrorCode is now cleared. | 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. | Deprecated { "CIM_EnabledLogicalElement.RequestStateChange" } uint32QuiesceDevice( | | If set to TRUE then cleanly cease all activity, if FALSE resume activity. Qualifiers:IN
| | boolean Quiesce |
)
The QuiesceDevice method has been deprecated in lieu of the more general RequestStateChange method that directly overlaps with the functionality provided by this method. Requests that the LogicalDevice cleanly cease all current activity ('Quiesce' input parameter = TRUE) or resume activity (= FALSE). For this method to quiesce a Device, that Device should have an Availability (or Additional Availability) of 'Running/Full Power' (value=3) and an EnabledStatus/StatusInfo of 'Enabled'. For example, if quiesced, a Device may then be offlined for diagnostics, or disabled for power off and hot swap. For the method to 'unquiesce' a Device, that Device should have an Availability (or AdditionalAvailability) of 'Quiesced' (value=21) and an EnabledStatus/StatusInfo of 'Enabled'. In this case, the Device would be returned to an 'Enabled' and 'Running/Full Power' status. The method's return code should indicate the success or failure of the quiesce. It should return 0 if successful, 1 if the request is not supported at all, 2 if the request is not supported due to the current state of the Device, and some other value if any other error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' may also be specified in the subclass as a Values array qualifier. | uint32Reset() Requests a reset of the LogicalDevice. The return value should be 0 if the request was successfully executed, 1 if the request is not supported and some other value if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' may also be specified in the subclass as a Values array qualifier. | 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. | 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. | ValueMap { "2" , "3" , "5" , "6" , "7" , "8..32767" , "32768..65535" } Values { "Enabled" , "Disabled" , "Not Applicable" , "Enabled but Offline" , "No Default" , "DMTF Reserved" , "Vendor Reserved" } Write 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). | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "4096" , "4097" , "4098" , "4099" , "4100..32767" , "32768..65535" } 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" } 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:ValueMap { "2" , "3" , "4" , "6" , "7" , "8" , "9" , "10" , "11" , ".." , "32768..65535" }
Values { "Enabled" , "Disabled" , "Shut Down" , "Offline" , "Test" , "Defer" , "Quiesce" , "Reboot" , "Reset" , "DMTF Reserved" , "Vendor Reserved" }
ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState" }
IN
| | 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. | ValueMap { "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , ".." , "32768..65535" } Values { "Enabled" , "Disabled" , "Shut Down" , "No Change" , "Offline" , "Test" , "Deferred" , "Quiesce" , "Reboot" , "Reset" , "Not Applicable" , "DMTF Reserved" , "Vendor Reserved" } ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" } 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. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11..32767" , "32768..65535" } 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" } 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. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , ".." , "0x8000.." } ArrayType ( "Indexed" ) 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" } uint16 OperationalStatus [ ] ; Indicates 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. | ArrayType ( "Indexed" ) ModelCorrespondence { "CIM_ManagedSystemElement.OperationalStatus" } 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. | ValueMap { "OK" , "Error" , "Degraded" , "Unknown" , "Pred Fail" , "Starting" , "Stopping" , "Service" , "Stressed" , "NonRecover" , "No Contact" , "Lost Comm" , "Stopped" } MaxLen ( 10 ) Deprecated { "CIM_ManagedSystemElement.OperationalStatus" } 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 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. | MappingStrings { "MIF.DMTF|ComponentID|001.5" } datetime InstallDate ; A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed. | MaxLen ( 1024 ) string Name ; The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property. | ValueMap { "0" , "5" , "10" , "15" , "20" , "25" , "30" , ".." } Values { "Unknown" , "OK" , "Degraded/Warning" , "Minor failure" , "Major failure" , "Critical failure" , "Non-recoverable error" , "DMTF Reserved" } uint16 HealthState ; Indicates 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. | 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. | 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. |
| | | | |
|