CIM_LogicalDevice, ROOT\StandardCimv2\MS_409

Class | Childs (1) | Methods (8) | Properties (38) | Qualifiers (4) | Instances | Namespaces (13)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

An abstraction or emulation of a hardware entity, that may or may not be Realized in physical hardware. Any characteristics of a LogicalDevice that are used to manage its operation or configuration are contained in, or associated with, the LogicalDevice object. Examples of the operational properties of a Printer would be paper sizes supported, or detected errors. Examples of the configuration properties of a Sensor Device would be threshold settings. Various configurations could exist for a LogicalDevice. These configurations could be contained in Setting objects and associated with the LogicalDevice.

CIM_LogicalDevice - child subclasses in ROOT\StandardCimv2\MS_409

Number of classes:1
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_LogicalPort1448----

CIM_LogicalDevice methods

CIM_LogicalDevice has 8 methods (7 Local, 1 Derived)

NameOriginReturn
EnableDeviceCIM_LogicalDeviceuint32 {'out':True}
OnlineDeviceCIM_LogicalDeviceuint32 {'out':True}
QuiesceDeviceCIM_LogicalDeviceuint32 {'out':True}
RequestStateChangeCIM_EnabledLogicalElementuint32 {'out':True}
ResetCIM_LogicalDeviceuint32 {'out':True}
RestorePropertiesCIM_LogicalDeviceuint32 {'out':True}
SavePropertiesCIM_LogicalDeviceuint32 {'out':True}
SetPowerStateCIM_LogicalDeviceuint32 {'out':True}

CIM_LogicalDevice properties

CIM_LogicalDevice has 38 properties (17 Local, 21 Derived)

NameOriginCIMType
AdditionalAvailabilityCIM_LogicalDevice18 [uint16]
AvailabilityCIM_LogicalDevice18 [uint16]
AvailableRequestedStatesCIM_EnabledLogicalElement18 [uint16]
CaptionCIM_ManagedElement8 [string]
CommunicationStatusCIM_ManagedSystemElement18 [uint16]
key
CreationClassName
CIM_LogicalDevice8 [string]
DescriptionCIM_ManagedElement8 [string]
DetailedStatusCIM_ManagedSystemElement18 [uint16]
key
DeviceID
CIM_LogicalDevice8 [string]
ElementNameCIM_ManagedElement8 [string]
EnabledDefaultCIM_EnabledLogicalElement18 [uint16]
EnabledStateCIM_EnabledLogicalElement18 [uint16]
ErrorClearedCIM_LogicalDevice11 [boolean]
ErrorDescriptionCIM_LogicalDevice8 [string]
HealthStateCIM_ManagedSystemElement18 [uint16]
IdentifyingDescriptionsCIM_LogicalDevice8 [string]
InstallDateCIM_ManagedSystemElement101 [datetime]
InstanceIDCIM_ManagedElement8 [string]
LastErrorCodeCIM_LogicalDevice19 [uint32]
MaxQuiesceTimeCIM_LogicalDevice21 [uint64]
NameCIM_ManagedSystemElement8 [string]
OperatingStatusCIM_ManagedSystemElement18 [uint16]
OperationalStatusCIM_ManagedSystemElement18 [uint16]
OtherEnabledStateCIM_EnabledLogicalElement8 [string]
OtherIdentifyingInfoCIM_LogicalDevice8 [string]
PowerManagementCapabilitiesCIM_LogicalDevice18 [uint16]
PowerManagementSupportedCIM_LogicalDevice11 [boolean]
PowerOnHoursCIM_LogicalDevice21 [uint64]
PrimaryStatusCIM_ManagedSystemElement18 [uint16]
RequestedStateCIM_EnabledLogicalElement18 [uint16]
StatusCIM_ManagedSystemElement8 [string]
StatusDescriptionsCIM_ManagedSystemElement8 [string]
StatusInfoCIM_LogicalDevice18 [uint16]
key
SystemCreationClassName
CIM_LogicalDevice8 [string]
key
SystemName
CIM_LogicalDevice8 [string]
TimeOfLastStateChangeCIM_EnabledLogicalElement101 [datetime]
TotalPowerOnHoursCIM_LogicalDevice21 [uint64]
TransitioningToStateCIM_EnabledLogicalElement18 [uint16]

Detailed description of CIM_LogicalDevice methods

Local methods (7) of CIM_LogicalDevice class

EnableDevice method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Enabledboolean0-{'Description':'If TRUE enable the device, if FALSE disable the device.','In':True}
Description'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.'
EnableDevice method is in 4 classes of ROOT\StandardCimv2\MS_409 and in 10 namespaces
OnlineDevice method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Onlineboolean0-{'Description':'If TRUE, take the device online, if FALSE, take the device OFFLINE.','In':True}
Description'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.'
OnlineDevice method is in 4 classes of ROOT\StandardCimv2\MS_409 and in 8 namespaces
QuiesceDevice method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Quiesceboolean0-{'Description':'If set to TRUE then cleanly cease all activity, if FALSE resume activity.','In':True}
Description'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.'
QuiesceDevice method is in 4 classes of ROOT\StandardCimv2\MS_409 and in 8 namespaces
Reset method
Returnuint32 {'out':True}
Description'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.'
Reset method is in 13 classes of ROOT\StandardCimv2\MS_409 and in 19 namespaces
RestoreProperties method
Returnuint32 {'out':True}
Description'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.'
RestoreProperties method is in 4 classes of ROOT\StandardCimv2\MS_409 and in 8 namespaces
SaveProperties method
Returnuint32 {'out':True}
Description'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.'
SaveProperties method is in 4 classes of ROOT\StandardCimv2\MS_409 and in 8 namespaces
SetPowerState method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
PowerStateuint160-{'Description':'The power state to set.','In':True,'Values':['Full Power', 'Power Save - Low Power Mode', 'Power Save - Standby', 'Power Save - Other', 'Power Cycle', 'Power Off']}
Timedatetime1-{'Description':'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.','In':True}
Description'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.'
SetPowerState method is in 4 classes of ROOT\StandardCimv2\MS_409 and in 14 namespaces

Derived methods (1) of CIM_LogicalDevice class

RequestStateChange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RequestedStateuint160-{'Description':'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\'), or 4096 (0x1000) (\'Job Started\'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.','In':True,'Values':['Enabled', 'Disabled', 'Shut Down', 'Offline', 'Test', 'Defer', 'Quiesce', 'Reboot', 'Reset', 'DMTF Reserved', 'Vendor Reserved']}
Jobref:CIM_ConcreteJob1-{'Description':'May contain a reference to the ConcreteJob created to track the state transition initiated by the method invocation.','Out':True}
TimeoutPerioddatetime2-{'Description':'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\' shall be returned.','In':True}
Description'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.
A return code of 0 shall indicate the state change was successfully initiated.
A return code of 3 shall indicate that the state transition cannot complete within the interval specified by the TimeoutPeriod parameter.
A return code of 4096 (0x1000) shall indicate the state change was successfully initiated, a ConcreteJob has been created, and its reference returned in the output parameter Job. Any other return code indicates an error condition.'
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']
RequestStateChange method is in 26 classes of ROOT\StandardCimv2\MS_409 and in 15 namespaces

Detailed description of CIM_LogicalDevice properties

Local properties (17) of CIM_LogicalDevice class

AdditionalAvailability property
CIMTYPE'uint16'
Description'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").'
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']
AdditionalAvailability property is in 4 classes of ROOT\StandardCimv2\MS_409 and in 8 namespaces
Availability property
CIMTYPE'uint16'
Description'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.'
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']
Availability property is in 4 classes of ROOT\StandardCimv2\MS_409 and in 12 namespaces
CreationClassName property
CIMTYPE'string'
Description'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.'
keyTrue
CreationClassName property is in 47 classes of ROOT\StandardCimv2\MS_409 and in 20 namespaces
DeviceID property
CIMTYPE'string'
Description'An address or other identifying information to uniquely name the LogicalDevice.'
keyTrue
DeviceID property is in 5 classes of ROOT\StandardCimv2\MS_409 and in 21 namespaces
ErrorCleared property
CIMTYPE'boolean'
Description'ErrorCleared is a boolean property indicating that the error reported in LastErrorCode is now cleared.'
ErrorCleared property is in 4 classes of ROOT\StandardCimv2\MS_409 and in 12 namespaces
ErrorDescription property
CIMTYPE'string'
Description'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.'
ErrorDescription property is in 8 classes of ROOT\StandardCimv2\MS_409 and in 142 namespaces
IdentifyingDescriptions property
CIMTYPE'string'
Description'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.'
IdentifyingDescriptions property is in 4 classes of ROOT\StandardCimv2\MS_409 and in 15 namespaces
LastErrorCode property
CIMTYPE'uint32'
Description'LastErrorCode captures the last error code reported by the LogicalDevice.'
LastErrorCode property is in 5 classes of ROOT\StandardCimv2\MS_409 and in 16 namespaces
MaxQuiesceTime property
CIMTYPE'uint64'
Description'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.'
Units'MilliSeconds'
MaxQuiesceTime property is in 4 classes of ROOT\StandardCimv2\MS_409 and in 8 namespaces
OtherIdentifyingInfo property
CIMTYPE'string'
Description'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.'
OtherIdentifyingInfo property is in 4 classes of ROOT\StandardCimv2\MS_409 and in 20 namespaces
PowerManagementCapabilities property
CIMTYPE'uint16'
Description'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.'
Values['Unknown', 'Not Supported', 'Disabled', 'Enabled', 'Power Saving Modes Entered Automatically', 'Power State Settable', 'Power Cycling Supported', 'Timed Power On Supported']
PowerManagementCapabilities property is in 4 classes of ROOT\StandardCimv2\MS_409 and in 14 namespaces
PowerManagementSupported property
CIMTYPE'boolean'
Description'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.'
PowerManagementSupported property is in 4 classes of ROOT\StandardCimv2\MS_409 and in 14 namespaces
PowerOnHours property
CIMTYPE'uint64'
Description'The number of consecutive hours that this Device has been powered, since its last power cycle.'
Units'Hours'
PowerOnHours property is in 4 classes of ROOT\StandardCimv2\MS_409 and in 13 namespaces
StatusInfo property
CIMTYPE'uint16'
Description'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.'
Values['Other', 'Unknown', 'Enabled', 'Disabled', 'Not Applicable']
StatusInfo property is in 4 classes of ROOT\StandardCimv2\MS_409 and in 12 namespaces
SystemCreationClassName property
CIMTYPE'string'
Description'The scoping System\'s CreationClassName.'
keyTrue
SystemCreationClassName property is in 47 classes of ROOT\StandardCimv2\MS_409 and in 20 namespaces
SystemName property
CIMTYPE'string'
Description'The scoping System\'s Name.'
keyTrue
SystemName property is in 66 classes of ROOT\StandardCimv2\MS_409 and in 22 namespaces
TotalPowerOnHours property
CIMTYPE'uint64'
Description'The total number of hours that this Device has been powered.'
Units'Hours'
TotalPowerOnHours property is in 4 classes of ROOT\StandardCimv2\MS_409 and in 10 namespaces

Derived properties (21) of CIM_LogicalDevice class

AvailableRequestedStates property
CIMTYPE'uint16'
Description'AvailableRequestedStates indicates the possible values for the RequestedState parameter of the method RequestStateChange, used to initiate a state change. The values listed shall be a subset of the values contained in the RequestedStatesSupported property of the associated instance of CIM_EnabledLogicalElementCapabilities where the values selected are a function of the current state of the CIM_EnabledLogicalElement. This property may be non-null if an implementation is able to advertise the set of possible values as a function of the current state. This property shall be null if an implementation is unable to determine the set of possible values as a function of the current state.'
Values['Enabled', 'Disabled', 'Shut Down', 'Offline', 'Test', 'Defer', 'Quiesce', 'Reboot', 'Reset', 'DMTF Reserved']
AvailableRequestedStates property is in 25 classes of ROOT\StandardCimv2\MS_409 and in 7 namespaces
Caption property
CIMTYPE'string'
Description'The Caption property is a short textual description (one- line string) of the object.'
Caption property is in 153 classes of ROOT\StandardCimv2\MS_409 and in 37 namespaces
CommunicationStatus property
CIMTYPE'uint16'
Description'CommunicationStatus indicates the ability of the instrumentation to communicate with the underlying ManagedElement. CommunicationStatus consists of one of the following values: Unknown, None, Communication OK, Lost Communication, or No Contact.
A Null return indicates the implementation (provider) does not implement this property.
"Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
"Not Available" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).
"Communication OK " indicates communication is established with the element, but does not convey any quality of service.
"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 Managed Element is known to exist and has been contacted successfully in the past, but is currently unreachable.'
Values['Unknown', 'Not Available', 'Communication OK', 'Lost Communication', 'No Contact', 'DMTF Reserved', 'Vendor Reserved']
CommunicationStatus property is in 61 classes of ROOT\StandardCimv2\MS_409 and in 9 namespaces
Description property
CIMTYPE'string'
Description'The Description property provides a textual description of the object.'
Description property is in 154 classes of ROOT\StandardCimv2\MS_409 and in 142 namespaces
DetailedStatus property
CIMTYPE'uint16'
Description'DetailedStatus compliments PrimaryStatus with additional status detail. It consists of one of the following values: Not Available, No Additional Information, Stressed, Predictive Failure, Error, Non-Recoverable Error, SupportingEntityInError. Detailed status is used to expand upon the PrimaryStatus of the element.
A Null return indicates the implementation (provider) does not implement this property.
"Not Available" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).
"No Additional Information" indicates that the element is functioning normally as indicated by PrimaryStatus = "OK".
"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 normally but a failure is predicted in the near future.
"Non-Recoverable Error " indicates that this element is in an error condition that requires human intervention.
"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.'
Values['Not Available', 'No Additional Information', 'Stressed', 'Predictive Failure', 'Non-Recoverable Error', 'Supporting Entity in Error', 'DMTF Reserved', 'Vendor Reserved']
DetailedStatus property is in 61 classes of ROOT\StandardCimv2\MS_409 and in 9 namespaces
ElementName property
CIMTYPE'string'
Description'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. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class.'
ElementName property is in 153 classes of ROOT\StandardCimv2\MS_409 and in 21 namespaces
EnabledDefault property
CIMTYPE'uint16'
Description'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).'
Values['Enabled', 'Disabled', 'Not Applicable', 'Enabled but Offline', 'No Default', 'Quiesce', 'DMTF Reserved', 'Vendor Reserved']
EnabledDefault property is in 25 classes of ROOT\StandardCimv2\MS_409 and in 10 namespaces
EnabledState property
CIMTYPE'uint16'
Description'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.
Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.'
Values['Unknown', 'Other', 'Enabled', 'Disabled', 'Shutting Down', 'Not Applicable', 'Enabled but Offline', 'In Test', 'Deferred', 'Quiesce', 'Starting', 'DMTF Reserved', 'Vendor Reserved']
EnabledState property is in 25 classes of ROOT\StandardCimv2\MS_409 and in 13 namespaces
HealthState property
CIMTYPE'uint16'
Description'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.'
Values['Unknown', 'OK', 'Degraded/Warning', 'Minor failure', 'Major failure', 'Critical failure', 'Non-recoverable error', 'DMTF Reserved']
HealthState property is in 61 classes of ROOT\StandardCimv2\MS_409 and in 15 namespaces
InstallDate property
CIMTYPE'datetime'
Description'A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed.'
InstallDate property is in 61 classes of ROOT\StandardCimv2\MS_409 and in 23 namespaces
InstanceID property
CIMTYPE'string'
Description'InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below.
To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm:
:
Where and are separated by a colon (:), and where must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the _ structure of Schema class names.) In addition, to ensure uniqueness, must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between and .
is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If not null and the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance.
If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the set to CIM.'
InstanceID property is in 153 classes of ROOT\StandardCimv2\MS_409 and in 21 namespaces
Name property
CIMTYPE'string'
Description'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.'
Name property is in 92 classes of ROOT\StandardCimv2\MS_409 and in 142 namespaces
OperatingStatus property
CIMTYPE'uint16'
Description'OperatingStatus provides a current status value for the operational condition of the element and can be used for providing more detail with respect to the value of EnabledState. It can also provide the transitional states when an element is transitioning from one state to another, such as when an element is transitioning between EnabledState and RequestedState, as well as other transitional conditions.
OperatingStatus consists of one of the following values: Unknown, Not Available, In Service, Starting, Stopping, Stopped, Aborted, Dormant, Completed, Migrating, Emmigrating, Immigrating, Snapshotting. Shutting Down, In Test
A Null return indicates the implementation (provider) does not implement this property.
"Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
"None" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).
"Servicing" describes an element being configured, maintained, cleaned, or otherwise administered.
"Starting" describes an element being initialized.
"Stopping" describes an element being brought to an orderly stop.
"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.
"Completed" indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded in the PrimaryStatus 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).
"Migrating" element is being moved between host elements.
"Immigrating" element is being moved to new host element.
"Emigrating" element is being moved away from host element.
"Shutting Down" describes an element being brought to an abrupt stop.
"In Test" element is performing test functions.
"Transitioning" describes an element that is between states, that is, it is not fully available in either its previous state or its next state. This value should be used if other values indicating a transition to a specific state are not applicable.
"In Service" describes an element that is in service and operational.'
Values['Unknown', 'Not Available', 'Servicing', 'Starting', 'Stopping', 'Stopped', 'Aborted', 'Dormant', 'Completed', 'Migrating', 'Emigrating', 'Immigrating', 'Snapshotting', 'Shutting Down', 'In Test', 'Transitioning', 'In Service', 'DMTF Reserved', 'Vendor Reserved']
OperatingStatus property is in 61 classes of ROOT\StandardCimv2\MS_409 and in 9 namespaces
OperationalStatus property
CIMTYPE'uint16'
Description'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.'
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']
OperationalStatus property is in 61 classes of ROOT\StandardCimv2\MS_409 and in 18 namespaces
OtherEnabledState property
CIMTYPE'string'
Description'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.'
OtherEnabledState property is in 25 classes of ROOT\StandardCimv2\MS_409 and in 11 namespaces
PrimaryStatus property
CIMTYPE'uint16'
Description'PrimaryStatus provides a high level status value, intended to align with Red-Yellow-Green type representation of status. It should be used in conjunction with DetailedStatus to provide high level and detailed health status of the ManagedElement and its subcomponents.
PrimaryStatus consists of one of the following values: Unknown, OK, Degraded or Error. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
"OK" indicates the ManagedElement is functioning normally.
"Degraded" indicates the ManagedElement is functioning below normal.
"Error" indicates the ManagedElement is in an Error condition.'
Values['Unknown', 'OK', 'Degraded', 'Error', 'DMTF Reserved', 'Vendor Reserved']
PrimaryStatus property is in 71 classes of ROOT\StandardCimv2\MS_409 and in 9 namespaces
RequestedState property
CIMTYPE'uint16'
Description'RequestedState is an integer enumeration that indicates the last requested or desired state for the element, irrespective of the mechanism through which it was requested. 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. Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration.
"Unknown" (0) indicates the last requested state for the element is unknown.
Note that the value "No Change" (5) has been deprecated in lieu of indicating the last requested state is "Unknown" (0). If the last requested or desired state is unknown, RequestedState should have the value "Unknown" (0), but may have the value "No Change" (5).Offline (6) indicates that the element has been requested to transition to the Enabled but Offline EnabledState.
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.

If knowledge of the last RequestedState is not supported for the EnabledLogicalElement, the property shall be NULL or have the value 12 "Not Applicable".'
Values['Unknown', 'Enabled', 'Disabled', 'Shut Down', 'No Change', 'Offline', 'Test', 'Deferred', 'Quiesce', 'Reboot', 'Reset', 'Not Applicable', 'DMTF Reserved', 'Vendor Reserved']
RequestedState property is in 25 classes of ROOT\StandardCimv2\MS_409 and in 12 namespaces
Status property
CIMTYPE'string'
Description'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.'
Status property is in 72 classes of ROOT\StandardCimv2\MS_409 and in 42 namespaces
StatusDescriptions property
CIMTYPE'string'
Description'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.'
StatusDescriptions property is in 61 classes of ROOT\StandardCimv2\MS_409 and in 18 namespaces
TimeOfLastStateChange property
CIMTYPE'datetime'
Description'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.'
TimeOfLastStateChange property is in 26 classes of ROOT\StandardCimv2\MS_409 and in 17 namespaces
TransitioningToState property
CIMTYPE'uint16'
Description'TransitioningToState indicates the target state to which the instance is transitioning.
A value of 5 "No Change" shall indicate that no transition is in progress.A value of 12 "Not Applicable" shall indicate the implementation does not support representing ongoing transitions.
A value other than 5 or 12 shall identify the state to which the element is in the process of transitioning.'
Values['Unknown', 'Enabled', 'Disabled', 'Shut Down', 'No Change', 'Offline', 'Test', 'Defer', 'Quiesce', 'Reboot', 'Reset', 'Not Applicable', 'DMTF Reserved']
TransitioningToState property is in 25 classes of ROOT\StandardCimv2\MS_409 and in 7 namespaces

CIM_LogicalDevice Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AMENDMENTTrue
Description'An abstraction or emulation of a hardware entity, that may or may not be Realized in physical hardware. Any characteristics of a LogicalDevice that are used to manage its operation or configuration are contained in, or associated with, the LogicalDevice object. Examples of the operational properties of a Printer would be paper sizes supported, or detected errors. Examples of the configuration properties of a Sensor Device would be threshold settings. Various configurations could exist for a LogicalDevice. These configurations could be contained in Setting objects and associated with the LogicalDevice.'
LOCALE'MS_409'
Version'2.8.0'

CIM_LogicalDevice System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\StandardCimv2\MS_409:CIM_LogicalDevice'___SYSTEM8
__NAMESPACE'ROOT\StandardCimv2\MS_409'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_EnabledLogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT38___SYSTEM3
__RELPATH'CIM_LogicalDevice'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_EnabledLogicalElement'___SYSTEM8
__CLASS'CIM_LogicalDevice'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to CIM_LogicalDevice

Number of classes:1
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_DeviceSAPImplementation120----
comments powered by Disqus
WUtils.com