The tables below describe the properties supported by the provider. The property tables have 3 columns. The first is the property name including types and units. The second is the property inheritance, including which class or superclass defines the property. The third is a description of the property.
CIM_CapabilitiesCapabilities is an abstract class whose subclasses describe abilities and/or potential for use. For example, one may describe the maximum number of VLANs that can be supported on a system using a subclass of Capabilities. Capabilities are tied to the elements which they describe using the ElementCapabilities association. Note that the cardinality of the ManagedElement reference is Min(1), Max(1). This cardinality mandates the instantiation of the ElementCapabilities association for the referenced instance of Capabilities. ElementCapabilities describes the existence requirements and context for the referenced instance of ManagedElement. Specifically, the ManagedElement MUST exist and provides the context for the Capabilities. Note that Capabilities do not indicate what IS configured or operational, but what CAN or CANNOT exist, be defined or be used. Note that it is possible to describe both supported and excluded abilities and functions (both capabilities and limitations) using this class.
Table 0. CIM_Capabilities properties| Property Name | Property Inheritance | Description |
|---|---|---|
| string InstanceID | Local | Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following 'preferred' algorithm:
|
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| string ElementName | CIM_ManagedElement | The user friendly name for this instance of Capabilities. In addition, the user friendly name can be used as a index property for a search of query. (Note: Name does not have to be unique within a namespace.) |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
A class derived from System that is a special collection of ManagedSystemElements. This collection provides compute capabilities and serves as aggregation point to associate one or more of the following elements: FileSystem, OperatingSystem, Processor and Memory (Volatile and/or NonVolatile Storage).
Table 1. CIM_ComputerSystem properties| Property Name | Property Inheritance | Description |
|---|---|---|
| string[] OtherDedicatedDescriptions | Local | A string describing how or why the system is dedicated when the Dedicated array includes the value 2, "Other". |
| uint16 ResetCapability | Local | If enabled (value = 4), the ComputerSystem can be reset via hardware (e.g. the power and reset buttons). If disabled (value = 3), hardware reset is not allowed. In addition to Enabled and Disabled, other Values for the property are also defined - "Not Implemented" (5), "Other" (1) and "Unknown" (2). |
| string Name | CIM_ManagedSystemElement | The inherited Name serves as key of a System instance in an enterprise environment. |
| uint16 EnabledDefault | CIM_EnabledLogicalElement | An enumerated value indicating an administrator's default/startup configuration for an element's EnabledState. By default, the element is "Enabled" (value=2). |
| string Status | CIM_ManagedSystemElement | 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. |
| string[] IdentifyingDescriptions | Local | 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. |
| string[] OtherIdentifyingInfo | Local | OtherIdentifyingInfo captures additional data, beyond System Name information, that could be used to identify a ComputerSystem. One example would be to hold the Fibre Channel World-Wide Name (WWN) of a node. Note that if only the Fibre Channel name is available and is unique (able to be used as the System key), then this property would be NULL and the WWN would become the System key, its data placed in the Name property. |
| string NameFormat | CIM_System | The ComputerSystem object and its derivatives are Top Level Objects of CIM. They provide the scope for numerous components. Having unique System keys is required. The NameFormat property identifies how the ComputerSystem Name is generated. The NameFormat ValueMap qualifier defines the various mechanisms for assigning the name. Note that another name can be assigned and used for the ComputerSystem that better suit a business, using the inherited ElementName property. |
| datetime InstallDate | CIM_ManagedSystemElement | A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. |
| uint16 RequestedState | CIM_EnabledLogicalElement | RequestedState is an integer enumeration indicating 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/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. |
| uint16[] Dedicated | Local | Enumeration indicating whether the ComputerSystem is a special-purpose System (ie, dedicated to a particular use), versus being 'general purpose'. For example, one could specify that the System is dedicated to "Print" (value=11) or acts as a "Hub" (value=8). A clarification is needed with respect to the value 17 ("Mobile User Device"). An example of a dedicated user device is a mobile phone or a barcode scanner in a store that communicates via radio frequency. These systems are quite limited in functionality and programmability, and are not considered 'general purpose' computing platforms. Alternately, an example of a mobile system that is 'general purpose' (i.e., is NOT dedicated) is a hand-held computer. Although limited in its programmability, new software can be downloaded and its functionality expanded by the user. |
| uint16[] OperationalStatus | CIM_ManagedSystemElement | 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 ManagedSystemElement 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. 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. As always, Status (since it is single-valued) provides the primary status of the element. |
| string OtherEnabledState | CIM_EnabledLogicalElement | A string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1. |
| string PrimaryOwnerName | CIM_System | The name of the primary system owner. The system owner is the primary user of the system. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| string[] Roles | CIM_System | An array (bag) of strings that specify the administrator-defined roles this System plays in the managed environment. Examples might be 'Building 8 print server' or 'Boise user directories'. A single system may perform multiple roles. Note that instrumentation's view of a System's 'roles' is defined by instantiating a specific subclass of System and/or by properties in a subclass. For example, a ComputerSystem's purpose is defined using the Dedicated and OtherDedicatedDescription properties. |
| string ElementName | CIM_ManagedElement | 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 ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. |
| uint16[] PowerManagementCapabilities | Local | An enumerated array describing the power management capabilities of the ComputerSystem. The use of this property has been deprecated. Instead, the PowerCapabilites property in an associated PowerManagementCapabilities class should be used. |
| string PrimaryOwnerContact | CIM_System | A string that provides information on how the primary system owner can be reached (e.g. phone number, email address, ...). |
| string CreationClassName | CIM_System | 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. |
| string[] StatusDescriptions | CIM_ManagedSystemElement | 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. |
| uint16 EnabledState | CIM_EnabledLogicalElement | EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=8) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/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 doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may 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 may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes 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. |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
This class extends LogicalElement to abstract the concept of an element that is enabled and disabled, such as a LogicalDevice or a ServiceAccessPoint.
Table 2. CIM_EnabledLogicalElement properties| Property Name | Property Inheritance | Description |
|---|---|---|
| uint16 EnabledDefault | Local | An enumerated value indicating an administrator's default/startup configuration for an element's EnabledState. By default, the element is "Enabled" (value=2). |
| string Status | CIM_ManagedSystemElement | 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. |
| string Name | CIM_ManagedSystemElement | 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. |
| datetime InstallDate | CIM_ManagedSystemElement | A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. |
| uint16 RequestedState | Local | RequestedState is an integer enumeration indicating 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/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. |
| uint16[] OperationalStatus | CIM_ManagedSystemElement | 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 ManagedSystemElement 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. 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. As always, Status (since it is single-valued) provides the primary status of the element. |
| string OtherEnabledState | Local | A string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| string ElementName | CIM_ManagedElement | 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 ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. |
| string[] StatusDescriptions | CIM_ManagedSystemElement | 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. |
| uint16 EnabledState | Local | EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=8) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/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 doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may 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 may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes 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. |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
HostedDependency defines a ManagedElement in the context of another ManagedElement in which it resides.
Table 3. CIM_HostedDependency properties| Property Name | Property Inheritance | 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.
Table 4. CIM_LogicalDevice properties| Property Name | Property Inheritance | Description |
|---|---|---|
| uint64 PowerOnHours | Local | The number of consecutive hours that this Device has been powered, since its last power cycle. |
| uint16 StatusInfo | Local | The StatusInfo property indicates whether the LogicalDevice 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. |
| uint16 EnabledDefault | CIM_EnabledLogicalElement | An enumerated value indicating an administrator's default/startup configuration for an element's EnabledState. By default, the element is "Enabled" (value=2). |
| string Status | CIM_ManagedSystemElement | 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. |
| string Name | CIM_ManagedSystemElement | 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. |
| uint64 MaxQuiesceTime | Local | 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. |
| uint16[] AdditionalAvailability | Local | 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"). |
| string[] IdentifyingDescriptions | Local | 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. |
| string[] OtherIdentifyingInfo | Local | OtherIdentifyingInfo captures additional data, beyond DeviceID information, that could be used to identify a LogicalDevice. One example would be to hold the OperatingSystem's user friendly name for the Device in this property. |
| datetime InstallDate | CIM_ManagedSystemElement | A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. |
| string SystemCreationClassName | Local | The scoping System's CreationClassName. |
| uint16 RequestedState | CIM_EnabledLogicalElement | RequestedState is an integer enumeration indicating 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/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. |
| uint16[] OperationalStatus | CIM_ManagedSystemElement | 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 ManagedSystemElement 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. 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. As always, Status (since it is single-valued) provides the primary status of the element. |
| boolean ErrorCleared | Local | ErrorCleared is a boolean property indicating that the error reported in LastErrorCode is now cleared. |
| string OtherEnabledState | CIM_EnabledLogicalElement | A string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1. |
| boolean PowerManagementSupported | Local | 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. |
| string DeviceID | Local | An address or other identifying information to uniquely name the LogicalDevice. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| string ElementName | CIM_ManagedElement | 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 ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. |
| uint16[] PowerManagementCapabilities | Local | 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. |
| uint64 TotalPowerOnHours | Local | The total number of hours that this Device has been powered. |
| string CreationClassName | Local | 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. |
| string SystemName | Local | The scoping System's Name. |
| string[] StatusDescriptions | CIM_ManagedSystemElement | 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. |
| string ErrorDescription | Local | 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. |
| uint32 LastErrorCode | Local | LastErrorCode captures the last error code reported by the LogicalDevice. |
| uint16 Availability | Local | The primary availability and status of the Device. (Additional status information can be specified using the AdditionalAvailability 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. |
| uint16 EnabledState | CIM_EnabledLogicalElement | EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=8) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/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 doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may 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 may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes 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. |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
CIM_LogicalElement is a base class for all the components of a System that represent abstract system components, such as Files, Processes, or LogicalDevices.
Table 5. CIM_LogicalElement properties| Property Name | Property Inheritance | Description |
|---|---|---|
| string Status | CIM_ManagedSystemElement | 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. |
| string Name | CIM_ManagedSystemElement | 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. |
| datetime InstallDate | CIM_ManagedSystemElement | A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. |
| uint16[] OperationalStatus | CIM_ManagedSystemElement | 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 ManagedSystemElement 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. 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. As always, Status (since it is single-valued) provides the primary status of the element. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| string ElementName | CIM_ManagedElement | 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 ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. |
| string[] StatusDescriptions | CIM_ManagedSystemElement | 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. |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
ManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema.
Table 6. CIM_ManagedElement properties| Property Name | Property Inheritance | Description |
|---|---|---|
| string Caption | Local | The Caption property is a short textual description (one-line string) of the object. |
| string ElementName | Local | 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 ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. |
| string Description | Local | The Description property provides a textual description of the object. |
CIM_ManagedSystemElement is the base class for the System Element hierarchy. Membership Criteria: Any distinguishable component of a System is a candidate for inclusion in this class. Examples: software components, such as files; and devices, such as disk drives and controllers, and physical components such as chips and cards.
Table 7. CIM_ManagedSystemElement properties| Property Name | Property Inheritance | Description |
|---|---|---|
| string Status | Local | 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. |
| string Name | Local | 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. |
| datetime InstallDate | Local | A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. |
| uint16[] OperationalStatus | Local | 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 ManagedSystemElement 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. 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. As always, Status (since it is single-valued) provides the primary status of the element. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| string ElementName | CIM_ManagedElement | 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 ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. |
| string[] StatusDescriptions | Local | 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. |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
CIM_System represents an entity made up of component parts (defined by the SystemComponent relationship), that operates as a 'functional whole'. Systems are top level objects in the CIM hierarchy, requiring no scoping or weak relationships in order to exist and have context. It should be reasonable to uniquely name and manage a System at an enterprise level. For example, a ComputerSystem is a kind of System that can be uniquely named and independently managed in an enterprise. However, this is not true for the power supply (or the power supply sub-'system') within the computer. Although a System may be viewed as a Collection, this is not the correct model. A Collection is simply a 'bag' that 'holds' its members. A System is a higher level abstraction, built out of its individual components. It is more than a sum of its parts. Note that System is a subclass of EnabledLogicalElement which allows the entire abstraction to be functionally enabled/disabled - at a higher level than enabling/disabling its component parts.
Table 8. CIM_System properties| Property Name | Property Inheritance | Description |
|---|---|---|
| string Name | CIM_ManagedSystemElement | The inherited Name serves as key of a System instance in an enterprise environment. |
| uint16 EnabledDefault | CIM_EnabledLogicalElement | An enumerated value indicating an administrator's default/startup configuration for an element's EnabledState. By default, the element is "Enabled" (value=2). |
| string Status | CIM_ManagedSystemElement | 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. |
| string NameFormat | Local | The System object and its derivatives are Top Level Objects of CIM. They provide the scope for numerous components. Having unique System keys is required. A heuristic can be defined in individual System subclasses to attempt to always generate the same System Name Key. The NameFormat property identifies how the System name was generated, using the subclass' heuristic. |
| datetime InstallDate | CIM_ManagedSystemElement | A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. |
| uint16 RequestedState | CIM_EnabledLogicalElement | RequestedState is an integer enumeration indicating 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/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. |
| uint16[] OperationalStatus | CIM_ManagedSystemElement | 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 ManagedSystemElement 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. 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. As always, Status (since it is single-valued) provides the primary status of the element. |
| string OtherEnabledState | CIM_EnabledLogicalElement | A string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1. |
| string PrimaryOwnerName | Local | The name of the primary system owner. The system owner is the primary user of the system. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| string[] Roles | Local | An array (bag) of strings that specify the administrator-defined roles this System plays in the managed environment. Examples might be 'Building 8 print server' or 'Boise user directories'. A single system may perform multiple roles. Note that instrumentation's view of a System's 'roles' is defined by instantiating a specific subclass of System and/or by properties in a subclass. For example, a ComputerSystem's purpose is defined using the Dedicated and OtherDedicatedDescription properties. |
| string ElementName | CIM_ManagedElement | 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 ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. |
| string PrimaryOwnerContact | Local | A string that provides information on how the primary system owner can be reached (e.g. phone number, email address, ...). |
| string CreationClassName | Local | 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. |
| string[] StatusDescriptions | CIM_ManagedSystemElement | 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. |
| uint16 EnabledState | CIM_EnabledLogicalElement | EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=8) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/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 doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may 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 may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes 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. |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
LogicalDevices may be aggregated by a System. This relationship is made explicit by the SystemDevice association.
Table 9. CIM_SystemDevice properties| Property Name | Property Inheritance | Description |
|---|
A computer system formed by partitioning host system resources in a manner that allows for high flexibility in the assignment of processor, memory, and I/O resources to the system, but does not necessarily provide hardware isolation among partitions.
Table 10. HP_SoftPartitionCS properties| Property Name | Property Inheritance | Description |
|---|---|---|
| string[] OtherDedicatedDescriptions | CIM_ComputerSystem | A string describing how or why the system is dedicated when the Dedicated array includes the value 2, "Other". |
| uint16 MinimumProcessorCount | Local | The minimum number of processors that must be used by this soft partition. When processors are removed from while the partition is running, ProcessorCount may not become smaller than this value. |
| uint16 ResetCapability | CIM_ComputerSystem | If enabled (value = 4), the ComputerSystem can be reset via hardware (e.g. the power and reset buttons). If disabled (value = 3), hardware reset is not allowed. In addition to Enabled and Disabled, other Values for the property are also defined - "Not Implemented" (5), "Other" (1) and "Unknown" (2). |
| string Name | CIM_ManagedSystemElement | The inherited Name serves as key of a System instance in an enterprise environment. |
| uint16 EnabledDefault | CIM_EnabledLogicalElement | An enumerated value indicating an administrator's default/startup configuration for an element's EnabledState. By default, the element is "Enabled" (value=2). |
| string Status | CIM_ManagedSystemElement | 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. |
| string[] IdentifyingDescriptions | CIM_ComputerSystem | 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. |
| string[] OtherIdentifyingInfo | CIM_ComputerSystem | OtherIdentifyingInfo captures additional data, beyond System Name information, that could be used to identify a ComputerSystem. One example would be to hold the Fibre Channel World-Wide Name (WWN) of a node. Note that if only the Fibre Channel name is available and is unique (able to be used as the System key), then this property would be NULL and the WWN would become the System key, its data placed in the Name property. |
| uint8 MinimumMemorySizeUnits | Local | The units used for the MemorySize property. |
| uint64 MaximumMemorySize | Local | The maximum amount of memory that can be assigned to this partition, while it is running. The value may not exceed the amount of memory installed on the host system. |
| uint64 MemorySize | Local | The amount of memory assigned to this partition, in units defined by MemorySizeUnits. The value may not exceed the amount of memory installed on the host system. |
| string NameFormat | CIM_System | The ComputerSystem object and its derivatives are Top Level Objects of CIM. They provide the scope for numerous components. Having unique System keys is required. The NameFormat property identifies how the ComputerSystem Name is generated. The NameFormat ValueMap qualifier defines the various mechanisms for assigning the name. Note that another name can be assigned and used for the ComputerSystem that better suit a business, using the inherited ElementName property. |
| datetime InstallDate | CIM_ManagedSystemElement | A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. |
| uint16 RequestedState | CIM_EnabledLogicalElement | RequestedState is an integer enumeration indicating 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/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. |
| uint16[] Dedicated | CIM_ComputerSystem | Enumeration indicating whether the ComputerSystem is a special-purpose System (ie, dedicated to a particular use), versus being 'general purpose'. For example, one could specify that the System is dedicated to "Print" (value=11) or acts as a "Hub" (value=8). A clarification is needed with respect to the value 17 ("Mobile User Device"). An example of a dedicated user device is a mobile phone or a barcode scanner in a store that communicates via radio frequency. These systems are quite limited in functionality and programmability, and are not considered 'general purpose' computing platforms. Alternately, an example of a mobile system that is 'general purpose' (i.e., is NOT dedicated) is a hand-held computer. Although limited in its programmability, new software can be downloaded and its functionality expanded by the user. |
| uint16[] OperationalStatus | CIM_ManagedSystemElement | 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 ManagedSystemElement 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. 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. As always, Status (since it is single-valued) provides the primary status of the element. |
| string OtherEnabledState | CIM_EnabledLogicalElement | A string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1. |
| uint8 MaximumMemorySizeUnits | Local | The units used for the MaximumMemorySize property. |
| uint8 MemorySizeUnits | Local | The units used for the MemorySize property. |
| string PrimaryOwnerName | CIM_System | The name of the primary system owner. The system owner is the primary user of the system. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| string[] Roles | CIM_System | An array (bag) of strings that specify the administrator-defined roles this System plays in the managed environment. Examples might be 'Building 8 print server' or 'Boise user directories'. A single system may perform multiple roles. Note that instrumentation's view of a System's 'roles' is defined by instantiating a specific subclass of System and/or by properties in a subclass. For example, a ComputerSystem's purpose is defined using the Dedicated and OtherDedicatedDescription properties. |
| uint16 MaximumProcessorCount | Local | The maximum number of processors that may be used by this soft partition. If processors are added while the soft partition is running, ProcessorCount may not exceed this value. The value may not exceed the number of physical processors on the host system. |
| uint16 ProcessorCount | Local | The number of virtual processors used by this soft partition. This value must be at least 1 and may not exceed the number of physical processors on the host system. |
| string ElementName | CIM_ManagedElement | 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 ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. |
| uint16[] PowerManagementCapabilities | CIM_ComputerSystem | An enumerated array describing the power management capabilities of the ComputerSystem. The use of this property has been deprecated. Instead, the PowerCapabilites property in an associated PowerManagementCapabilities class should be used. |
| string PrimaryOwnerContact | CIM_System | A string that provides information on how the primary system owner can be reached (e.g. phone number, email address, ...). |
| string CreationClassName | CIM_System | 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. |
| string[] StatusDescriptions | CIM_ManagedSystemElement | 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. |
| uint16 IOResourceCount | Local | The number of I/O resources explicitly assigned to this partition. Note that the specific I/O resources assignable will depend on the specific type of soft partition, and that there may be other I/O resources that are available to the soft partition implicitly, but are not reflected in this count. For example, if a PCI slot containing a FibreChannel host adapter is assigned to a vPar, then all all storage devices connected to that Fibrechannel network are implicitly available to the vPar. These implicitly available resources are not reflected in the IOResourceCount. |
| uint64 MinimumMemorySize | Local | The minimum amount of memory that can be assigned to this partition, while it is running. The value may not exceed the amount of memory installed on the host system. |
| uint16 EnabledState | CIM_EnabledLogicalElement | EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=8) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/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 doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may 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 may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes 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. |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
The capabilities of the Integrity Virtual Machine (HPVM) configuration on this host system.
Table 11. HPVM_Capabilities properties| Property Name | Property Inheritance | Description |
|---|---|---|
| string InstanceID | CIM_Capabilities | Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following 'preferred' algorithm:
|
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| string ElementName | CIM_ManagedElement | The user friendly name for this instance of Capabilities. In addition, the user friendly name can be used as a index property for a search of query. (Note: Name does not have to be unique within a namespace.) |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
The VM host that can run Virtual Machines.
Table 12. HPVM_DistributedHost properties| Property Name | Property Inheritance | Description |
|---|---|---|
| string[] OtherDedicatedDescriptions | CIM_ComputerSystem | A string describing how or why the system is dedicated when the Dedicated array includes the value 2, "Other". |
| string Name | CIM_ManagedSystemElement | The hostname or IP address for this host system.This can be used as a correlatable ID to find additional information about the host system in the root/cimv2 namespace. |
| uint16 ResetCapability | CIM_ComputerSystem | If enabled (value = 4), the ComputerSystem can be reset via hardware (e.g. the power and reset buttons). If disabled (value = 3), hardware reset is not allowed. In addition to Enabled and Disabled, other Values for the property are also defined - "Not Implemented" (5), "Other" (1) and "Unknown" (2). |
| uint16 EnabledDefault | CIM_EnabledLogicalElement | An enumerated value indicating an administrator's default/startup configuration for an element's EnabledState. By default, the element is "Enabled" (value=2). |
| string Status | CIM_ManagedSystemElement | 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. |
| string[] IdentifyingDescriptions | CIM_ComputerSystem | 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. |
| string[] OtherIdentifyingInfo | CIM_ComputerSystem | OtherIdentifyingInfo captures additional data, beyond System Name information, that could be used to identify a ComputerSystem. One example would be to hold the Fibre Channel World-Wide Name (WWN) of a node. Note that if only the Fibre Channel name is available and is unique (able to be used as the System key), then this property would be NULL and the WWN would become the System key, its data placed in the Name property. |
| string NameFormat | CIM_System | The format of the name for this computer system. This will always be "IP" for this class. |
| datetime InstallDate | CIM_ManagedSystemElement | A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. |
| string ServerIPAddress | Local | Server IP address. |
| uint8 ServerState | Local | Tells whether or not the server has joined this group of VM hosts that can managed the given guests. |
| uint16 RequestedState | CIM_EnabledLogicalElement | RequestedState is an integer enumeration indicating 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/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. |
| uint16[] Dedicated | CIM_ComputerSystem | Enumeration indicating whether the ComputerSystem is a special-purpose System (ie, dedicated to a particular use), versus being 'general purpose'. For example, one could specify that the System is dedicated to "Print" (value=11) or acts as a "Hub" (value=8). A clarification is needed with respect to the value 17 ("Mobile User Device"). An example of a dedicated user device is a mobile phone or a barcode scanner in a store that communicates via radio frequency. These systems are quite limited in functionality and programmability, and are not considered 'general purpose' computing platforms. Alternately, an example of a mobile system that is 'general purpose' (i.e., is NOT dedicated) is a hand-held computer. Although limited in its programmability, new software can be downloaded and its functionality expanded by the user. |
| uint16[] OperationalStatus | CIM_ManagedSystemElement | 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 ManagedSystemElement 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. 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. As always, Status (since it is single-valued) provides the primary status of the element. |
| string ServerHostname | Local | Server hostname. |
| string OtherEnabledState | CIM_EnabledLogicalElement | A string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1. |
| boolean IsLocal | Local | True if this instance is for the local host. |
| string PrimaryOwnerName | CIM_System | The name of the primary system owner. The system owner is the primary user of the system. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| string[] Roles | CIM_System | An array (bag) of strings that specify the administrator-defined roles this System plays in the managed environment. Examples might be 'Building 8 print server' or 'Boise user directories'. A single system may perform multiple roles. Note that instrumentation's view of a System's 'roles' is defined by instantiating a specific subclass of System and/or by properties in a subclass. For example, a ComputerSystem's purpose is defined using the Dedicated and OtherDedicatedDescription properties. |
| string ElementName | CIM_ManagedElement | The hostname of this system. This may have the same value as the Name property |
| uint16[] PowerManagementCapabilities | CIM_ComputerSystem | An enumerated array describing the power management capabilities of the ComputerSystem. The use of this property has been deprecated. Instead, the PowerCapabilites property in an associated PowerManagementCapabilities class should be used. |
| sint32 ServerID | Local | The ID of the server. |
| string PrimaryOwnerContact | CIM_System | A string that provides information on how the primary system owner can be reached (e.g. phone number, email address, ...). |
| string CreationClassName | CIM_System | 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. |
| string[] StatusDescriptions | CIM_ManagedSystemElement | 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. |
| uint16 EnabledState | CIM_EnabledLogicalElement | EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=8) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/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 doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may 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 may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes 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. |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
The entitlement capabilities that can be set when using the installed version of Integrity Virtual Machines (HPVM).
Table 13. HPVM_EntitlementCapabilities properties| Property Name | Property Inheritance | Description |
|---|---|---|
| string InstanceID | CIM_Capabilities | Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following 'preferred' algorithm:
|
| uint8 Delta | Local | The granularity by which the percentage entitlements may be set. In other words, the entitlements in percent form must be a multiple of this property. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| string ElementName | CIM_ManagedElement | The user friendly name for this instance of Capabilities. In addition, the user friendly name can be used as a index property for a search of query. (Note: Name does not have to be unique within a namespace.) |
| uint16 RecommendedMinimumEntitlement | Local | The recommended entitlement, expressed as a percentage. |
| uint16 MinimumEntitlement | Local | The minimum entitlement that may be set, expressed as a percentage. |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
A guest computer system in an Integrity Virtual Machine (HPVM) configuration. A guest system runs an independent operating system instance using virtualized host system resources.
Table 14. HPVM_Guest properties| Property Name | Property Inheritance | Description |
|---|---|---|
| uint8 BootType | Local | This specifies whether or not the Integrity Virutal Machine is set to auto boot or to require a manual boot when the VVM is started. |
| boolean IsOn | Local | True if the guest is on. |
| real32 ActiveProcessorEntitlement | Local | The amount of physical processor resources to which each virtual processor in this guest is entitled in units defined by ProcessorEntitlementUnits. This property is only present when the Guest is up. |
| string Name | CIM_ManagedSystemElement | The name of a guest is its UUID. This value should be globally unique for all guests on all Integrity Virtual Machine (HPVM) configurations on all hosts. |
| string[] AdminGroups | Local | A list of group names for users that are administrators for this guest. |
| uint8 ExpectedOperatingSystemType | Local | The type of operating system that is or is expected to be installed on this guest. This value is manually set during guest creation, but the Integrity Virtual Machines (HPVM) system will update the value based on the last OS booted on the guest. |
| boolean IsStartedOnRemoteHost | Local | True if this guest is running on a remote host VM host. |
| boolean HasGWLMController | Local | True if gWLM is managing this guest. |
| uint8 MaximumMemorySizeUnits | HP_SoftPartitionCS | The units used for the MaximumMemorySize property. |
| uint16 IOResourceCount | HP_SoftPartitionCS | The number of virtual I/O devices assigned to this guest. This can also be determined by counting the number of SystemDevice associations between the guest and HPVM_IODevice instances, and is provided as a shortcut when only a numeric count is needed by a client. |
| uint8 DynMemTargetStartUnits | Local | The units used for the DynMemTargetStartSize property. |
| real32 ProcessorEntitlement | Local | The amount of physical processor resources to which each virtual processor in this guest is entitled in units defined by ProcessorEntitlementUnits. This property contains the value that the was configured by the user. See ActiveProcessorEntitlement to find out the current entitlement of a running guest. |
| uint8 ProcessorEntitlementUnits | Local | The units for the ProcessorEntitlement property. If "Percent", then the entitlement is the percentage of a single physical processor that each virtual processor in this guest. If "Cycles", then the value is the number of host processor cycles per second allocated to each virtual processor in this guest. |
| sint32 ServerID | Local | The ID for the host server that is running this guest. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| real32 ProcessorSpeed | Local | The effective speed of the physical processors used by this guest in MegaHertz. Note that the following relationship is always true: ProcessorSpeed * ProcessorEntitlement (in percent) / 100 = ProcessorEntitlement (in MegaHertz). |
| uint64[] VProcessorCycleUsage | Local | The virtual processor's usage of the physical processors in cycles. |
| real64[] VProcessorPercentUsage | Local | The virtual processor's usage of the physical processors in percent form. |
| boolean ModificationsArePending | Local | True when there are modifications to the configuration. of this guest that have not yet taken effect. This may occur when a guest configuration is modified while it is running. See the Integrity Virtual Machine (HPVM) documentation for more information. |
| boolean IsInEFI | Local | True if the guest is at the EFI. |
| uint8 MemorySizeUnits | HP_SoftPartitionCS | The units used for the MemorySize property. |
| boolean HasServiceGuardController | Local | True if service guard is managing this guest. |
| uint32 ConfigFileMinorVersion | Local | The minor part of the version number for the version of HPVM when this guest's configuration file was last modified. |
| uint64 MemorySize | HP_SoftPartitionCS | The amount of memory assigned to this guest in units defined by MemorySizeUnits. The value may not exceed the amount of memory installed on the host system. |
| uint8[] VProcessorCycleUnits | Local | The units for the VProcessorCycleUsage property. |
| uint16[] PowerManagementCapabilities | CIM_ComputerSystem | An enumerated array describing the power management capabilities of the ComputerSystem. The use of this property has been deprecated. Instead, the PowerCapabilites property in an associated PowerManagementCapabilities class should be used. |
| string ElementName | CIM_ManagedElement | A user-defined name for this guest. This name shall be unique among all guests on a single host. |
| real64 AverageProcessorUsagePercent | Local | This is the average physical processor usage (in percent). |
| boolean IsStartable | Local | False when there is an external controller that does not allow this guest to be booted, otherwise, this value is true. This value will be true if there is no external controller. See the HasExternalController property on HPVM_Host. |
| string[] OperatorGroups | Local | A list of group names for users that are operators for this guest. |
| string[] OtherDedicatedDescriptions | CIM_ComputerSystem | A string describing how or why the system is dedicated when the Dedicated array includes the value 2, "Other". |
| string[] StatusDescriptions | CIM_ManagedSystemElement | 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. |
| uint32 MemoryCurrentSize | Local | The current running memory (DYNAMIC). This value is always in Megabytes. |
| sint32 ManagementServerID | Local | The ID of the server that is making modifications to this guest. This property is not present if no modifications are being made to this guest. See the IsBeingChanged property. |
| sint64 ManagementProcessID | Local | The process ID of application that is modifing this guest. This property is not present if no modifications are being made to this guest. See the IsBeingChanged property. |
| string EffectiveServerVirtUuid | Local | The UUID (Logical) of the HPVM host in an MSE group that is either running this guest, or if the guest is not running has been configured to run this guest. |
| string EffectiveServerUuid | Local | The UUID of the HPVM host in an MSE group that is either running this guest, or if the guest is not running has been configured to run this guest. |
| uint32 MemoryComfySize | Local | The comfortable running memory (DYNAMIC). This value is always in Megabytes. |
| uint64 DynMemMinSize | Local | The dynamic memory low end of range (STATIC). |
| uint64 MinimumMemorySize | HP_SoftPartitionCS | The minimum amount of memory that can be assigned to this guest while the guest is running. The value must be at least the minimum amount of memory required for a single guest HPVM to boot and may not exceed the amount of memory installed on the host system. |
| uint16 GuestID | Local | The numeric ID for this guest. This value is also unique among all guests on a single host. |
| uint16 RequestedState | CIM_EnabledLogicalElement | RequestedState is an integer enumeration indicating 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/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. |
| boolean HasValidConfiguration | Local | True if the guest has a valid configuration. |
| boolean IsInitializing | Local | True if the the guest is in the initial stages of starting. |
| uint32 ConfigFileMajorVersion | Local | The major part of the version number for the version of HPVM when this guest's configuration file was last modified. |
| uint64 DynMemMaxSize | Local | The dynamic memory high end of range (STATIC). |
| uint16 ProcessorCount | HP_SoftPartitionCS | The number of virtual processors used by this guest. This value must be at least 1, may not exceed HPVM_GuestCapabilities.MaximumProcessors, and must be between MinimumProcessorCount and MaximumProcessorCount, inclusive. |
| string NameFormat | CIM_System | The format of the name for this computer system. In an Integrity Virtual Machine (HPVM) configuration all guests will be identified by UUID. This can be used as a correlatable ID to associate data obtained from a provider running on the guest to this guest within the HPVM configuration. See the HPVM_Host class. |
| sint64[] VProcessorID | Local | The virtual processor's ID for this guest. Each element in this array corresponds to an element in the other VProcessor arrays. |
| uint8 MaximumProcessorEntitlementSubUnits | Local | The units for the MaximimProcessorEntitlement property. This property is only present if MaximumProcessorEntitlementUnits is Cycles. |
| uint8 DynMemMaxUnits | Local | The units used for the DynMemMaxSize property. |
| uint8 ActiveProcessorEntitlementSubUnits | Local | The units for the ActiveProcessorEntitlement property. This property is only present if ActiveProcessorEntitlementUnits is Cycles. |
| uint16 MinimumProcessorCount | HP_SoftPartitionCS | The minimum number of virtual processors that must be used by this guest. When virtual processors are removed from a guest while the guest is running, ProcessorCount may not become smaller than this value. |
| string EffectiveServerIpAddress | Local | The IP address of the HPVM host in an MSE group that is either running this guest, or if the guest is not running has been configured to run this guest. |
| string AdminAddress | Local | The hostname or IP address at which a WBEM server may be contacted on the guest. |
| uint16[] OperationalStatus | CIM_ManagedSystemElement | The operational status value for this guest. Values should be interpreted as follows: Unknown - guest status is unknown, Other - guest status is not in this list, OK - the guest is operating normally, without error, Degraded - the guest is starved for resources, Stressed - the scheduler is in stressed mode, Predictive Failure - not used, Error - the guest is crashed or hung, Non-Recoverable Error - an invalid guest configuration file, Starting - the guest is booting, Stopping - the guest is shutting down, Stopped - the guest is down, In Service - not used, No Contact - not used, Lost Communication - not used, Aborted - the guest has crashed, Dormant - not used, Supporting Entity in Error - not used, Completed - not used, Power Mode - not used, DMTF Reserved - not used ,The following values use the Vendor Reserved range of values: Invalid Configuration - guest has invalid configuration file, The first value in the array is the primary status. Additional values may be added to the array to provide additional data. A running guest will have one element, "OK". A crashed guest will be { "Stopped", "Error", "Aborted"}. |
| string OtherEnabledState | CIM_EnabledLogicalElement | A string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1. |
| string ServiceGuardPackage | Local | Contains the name of the service guard package. |
| uint16 ResetCapability | CIM_ComputerSystem | If enabled (value = 4), the ComputerSystem can be reset via hardware (e.g. the power and reset buttons). If disabled (value = 3), hardware reset is not allowed. In addition to Enabled and Disabled, other Values for the property are also defined - "Not Implemented" (5), "Other" (1) and "Unknown" (2). |
| string[] OperatorUsers | Local | A list of user names for users that are operators for this guest. |
| uint8 DynMemMinUnits | Local | The units used for the DynMemMinSize property. |
| uint8 GuestState | Local | The state of the virtual machine (guest). This does not include the state of the operating system running on the virtual machine. |
| string PrimaryOwnerName | CIM_System | The name of the primary system owner. The system owner is the primary user of the system. |
| boolean GuestMemoryControl | Local | Ability of guest to control own dynamic memory size. |
| uint16 EnabledDefault | CIM_EnabledLogicalElement | An enumerated value indicating an administrator's default/startup configuration for an element's EnabledState. By default, the element is "Enabled" (value=2). |
| string[] OtherIdentifyingInfo | CIM_ComputerSystem | OtherIdentifyingInfo captures additional data, beyond System Name information, that could be used to identify a ComputerSystem. One example would be to hold the Fibre Channel World-Wide Name (WWN) of a node. Note that if only the Fibre Channel name is available and is unique (able to be used as the System key), then this property would be NULL and the WWN would become the System key, its data placed in the Name property. |
| string EffectiveServerHostName | Local | The hostname of the HPVM host in an MSE group that is either running this guest, or if the guest is not running has been configured to run this guest. |
| sint32 EffectiveServerId | Local | The ID of the HPVM host in an MSE group that is either running this guest, or if the guest is not running has been configured to run this guest. |
| string SerialNumber | Local | The serial number for this guest HPVM. The serial number is an internally generated value, and is guaranteed to be unique only within the context of a single host. See the Integrity Virtual Machine (HPVM) documentation for more information. |
| string[] AdminUsers | Local | A list of user names for users that are administrators for thisguest. |
| string[] IdentifyingDescriptions | CIM_ComputerSystem | 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. |
| uint32 GracefulStopTimeout | Local | The graceful stop timeout value in seconds. |
| uint8 ProcessorEntitlementSubUnits | Local | The units for the ProcessorEntitlement property. This property is only present if ProcessorEntitlementUnits is Cycles. |
| string PrimaryOwnerContact | CIM_System | A string that provides information on how the primary system owner can be reached (e.g. phone number, email address, ...). |
| sint32 FairShareSchedulerID | Local | The fair share scheular ID for this guest. This property will not be present if there is no ID for this guest. The guest will have no ID if it is down. |
| sint32 MigratingDestinationServerID | Local | The ID of server that this guest is migrating to. This property is not present if guest is not being online migrated. See the IsOnlineMigrating property. |
| uint64[] VProcessorTotalUsage | Local | This is the cumulative usage per processor in cycles. |
| real32 MaximumProcessorEntitlement | Local | The maximum amount of physical processor resources to which each virtual processor in this guest is entitled in units defined by MaximumProcessorEntitlementUnits. |
| uint64 DynMemTargetStartSize | Local | Amount of memory the guest will resize to upon boot (STATIC). |
| uint16 EnabledState | CIM_EnabledLogicalElement | EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=8) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/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 doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may 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 may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes 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. |
| uint64 MaximumMemorySize | HP_SoftPartitionCS | The maximum amount of memory that can be assigned to this guest while the guest is running. The value may not exceed the amount of memory installed on the host system. |
| sint32 MigratingSourceServerID | Local | The ID of server that this guest is migrating from. This property is not present if guest is not being online migrated. See the IsOnlineMigrating property. |
| real64[] VProcessorAverageUsage | Local | This is the average usage per processor in percent. |
| uint16[] Dedicated | CIM_ComputerSystem | Whether this computer systems is a special-purpose system. A guest is a general purpose system. All instances of this class will have exactly one elementcontaining only the value "Not Dedicated" (0) |
| uint8 ConsoleType | Local | Terminal type for the virtual console of this guest. |
| string VProcessorUsageError | Local | Error getting getting the virtual processor's usage information. |
| uint8 MaximumProcessorEntitlementUnits | Local | The units for the MaximumProcessorEntitlement property. If "Percent", then the entitlement is the percentage of a single physical processor that each virtual processor in this guest. If "Cycles", then the value is the number of host processor cycles per second allocated to each virtual processor in this guest. |
| uint32 MemoryTargetSize | Local | The target running memory (DYNAMIC). This value is always in Megabytes. |
| uint32 DynMemoryType | Local | The dynamic memory type. |
| string Description | CIM_ManagedElement | A user-assigned description for this guest. |
| string CreationClassName | CIM_System | 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. |
| boolean IsOnlineMigrating | Local | True if the guest is being migrated to a different VM Host |
| uint8 ActiveProcessorEntitlementUnits | Local | The units for the ProcessorEntitlement property. If "Percent", then the entitlement is the percentage of a single physical processor that each virtual processor in this guest. If "Cycles", then the value is the number of host processor cycles per second allocated to each virtual processor in this guest. This property is only present when the Guest is up. |
| datetime InstallDate | CIM_ManagedSystemElement | A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. |
| string ConfigFileVersion | Local | The version string for the version of HPVM when this guest's configuration file was last modified. |
| uint32 ConfigFilePatchVersion | Local | The patch part of the version number for the version of HPVM when this guest's configuration file was last modified. |
| uint16 MaximumProcessorCount | HP_SoftPartitionCS | The maximum number of virtual processors that may be used by this guest. If virtual processors are added to a guest while the guest is running, ProcessorCount may not exceed this value. The value may not exceed the smaller of the number of physical processors on the host system or HPVM_GuestCapabilities.MaximumProcessors. |
| sint32 ProcessID | Local | The ID for the host OS process in which this guest executes. This can be used as a correlatable ID to obtain information about that process from the CIM_Process provider on the host system. This property will not be present when the guest is down. |
| uint8 MinimumMemorySizeUnits | HP_SoftPartitionCS | The units used for the MemorySize property. |
| string ModelName | Local | The system model name of this guest. The name is is a generated value that does not match the model of the host system or any other known physical system. See the Integrity Virtual Machine (HPVM) documentation for the values of this string. |
| boolean NeedsAttention | Local | True if the there is a problem with the Guest and it needs attention |
| string Status | CIM_ManagedSystemElement | 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. |
| string ActiveProcessorEntitlementError | Local | Error getting getting the active entitlement information. |
| string[] Roles | CIM_System | An array (bag) of strings that specify the administrator-defined roles this System plays in the managed environment. Examples might be 'Building 8 print server' or 'Boise user directories'. A single system may perform multiple roles. Note that instrumentation's view of a System's 'roles' is defined by instantiating a specific subclass of System and/or by properties in a subclass. For example, a ComputerSystem's purpose is defined using the Dedicated and OtherDedicatedDescription properties. |
| boolean IsBeingChanged | Local | True if the guest is being changed. Only one of the servers in the group can make changes to the guest at one time. |
| boolean IsInOS | Local | True if the guest is running an OS. |
| boolean IsDistributed | Local | True if the guest's configuration is distributed to remote VM hosts. |
| uint64 TotalProcessorUsage | Local | This is the cumulative physical processor usage in cycles. |
The capabilities of the Guests that can be run on this version of Integrity Virtual Machines (HPVM).
Table 15. HPVM_GuestCapabilities properties| Property Name | Property Inheritance | Description |
|---|---|---|
| string[] AvioStoreGuestDevices | Local | The list of supported guest storage devices virtualized by AVIO. |
| uint8 GuestOSType | Local | The type of guest OS that these capabilities are about. |
| string[] StorageDeviceTypes | Local | The list of supported storage device types |
| uint16 MaximumProcessors | Local | The maximum number of processors that can be assigned to this type of guest. |
| uint32 MaximumMemory | Local | The maximum possible amount of memory in megabytes that can be assigned to a guest of this type. |
| uint8 GuestArchType | Local | The type of architecture that these capabilities are about. |
| string[] StorageAdaptors | Local | The list of supported storage adaptor types |
| boolean SupportsAvio | Local | True if this guest supports AVIO. |
| uint32 MaximumReservedMemory | Local | The maximum memory in megabytes reserved by the VM Host for this type of guest. |
| uint16 MaximumPciBuses | Local | The maximum supported number of PCI buses. |
| boolean DynamicallyReplaceableMedia | Local | True if this version of Guest supports dynamically replaceable media. A DVD is an example of dynamically replaceable media. |
| string[] AvioLanGuestDevices | Local | The list of supported guest network devices virtualized by AVIO. |
| string MinimumVersion | Local | The minimum OS version supported. |
| string[] SerialDeviceTypes | Local | The list of supported serial device types |
| uint32 MinimumReservedMemory | Local | The minimum memory in megabytes reserved by the VM Host for this type of guest. |
| boolean SupportsDynamicNetworkDeletion | Local | True if this version of Guest supports dynamically deleting a network device. |
| boolean SupportsDynamicProcessorDeletion | Local | True if this version of Guest supports dynamically deleting a processor. |
| string InstanceID | CIM_Capabilities | Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following 'preferred' algorithm:
|
| uint32 RecommendedMemory | Local | The recommended amount of memory in megabytes for this type of guest. |
| boolean SupportsDynamicMemoryAddition | Local | True if this version of Guest supports dynamically adding memory. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| uint8[] DynMemTypes | Local | The types of dynamic memory supported for this type of guest. |
| string ElementName | CIM_ManagedElement | The user friendly name for this instance of Capabilities. In addition, the user friendly name can be used as a index property for a search of query. (Note: Name does not have to be unique within a namespace.) |
| uint32 MinimumMemory | Local | The minimum possible amount of memory in megabytes that can be assigned to a guest of this type. |
| boolean SupportsDynamicNetworkAddition | Local | True if this version of Guest supports dynamically adding a network device. |
| boolean SupportsDynamicProcessorAddition | Local | True if this version of Guest supports dynamically adding a processor. |
| uint32 ReservedMemory | Local | The memory in megabytes reserved by the VM Host for this type of guest. |
| string[] AdaptorArguments | Local | Lists the possible arguments for adaptors. |
| string[] NetworkDeviceTypes | Local | The list of supported network device types |
| boolean SupportsOGM | Local | True if online guest migration (OGM) is supported on this version of Guest. |
| uint16 RecommendedProcessors | Local | The recommended number of processors that should be assigned to this type of guest. |
| boolean SupportsDynamicMemoryDeletion | Local | True if this version of Guest supports dynamically deleting memory. |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
IO devices being used by a guest.
Table 16. HPVM_GuestIODeviceDB properties| Property Name | Property Inheritance | Description |
|---|---|---|
| uint64 PowerOnHours | CIM_LogicalDevice | The number of consecutive hours that this Device has been powered, since its last power cycle. |
| uint16 StatusInfo | CIM_LogicalDevice | The StatusInfo property indicates whether the LogicalDevice 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. |
| uint16 EnabledDefault | CIM_EnabledLogicalElement | An enumerated value indicating an administrator's default/startup configuration for an element's EnabledState. By default, the element is "Enabled" (value=2). |
| string Status | CIM_ManagedSystemElement | 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. |
| string Name | CIM_ManagedSystemElement | 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. |
| string[] AttributeValues | HPVM_IODeviceDB | Values of the attributes for this device. Each element in this array corresponds to an element in the AttributeKeys array. |
| uint8 ResourceType | HPVM_IODeviceDB | The type of I/O resource associated with this device. |
| uint8 ResourceAssociation | HPVM_IODeviceDB | This represents the database entry type. |
| uint64 MaxQuiesceTime | CIM_LogicalDevice | 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. |
| string[] Dependencies | HPVM_IODeviceDB | UUIDs for devices that depend on this device. |
| uint16[] AdditionalAvailability | CIM_LogicalDevice | 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"). |
| string[] IdentifyingDescriptions | CIM_LogicalDevice | 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. |
| string[] OtherIdentifyingInfo | CIM_LogicalDevice | OtherIdentifyingInfo captures additional data, beyond DeviceID information, that could be used to identify a LogicalDevice. One example would be to hold the OperatingSystem's user friendly name for the Device in this property. |
| datetime InstallDate | CIM_ManagedSystemElement | A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. |
| uint8 Shareable | HPVM_IODeviceDB | True if the device is shareable between guests. |
| string SystemCreationClassName | CIM_LogicalDevice | The scoping System's CreationClassName. |
| uint16 RequestedState | CIM_EnabledLogicalElement | RequestedState is an integer enumeration indicating 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/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. |
| uint16[] OperationalStatus | CIM_ManagedSystemElement | 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 ManagedSystemElement 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. 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. As always, Status (since it is single-valued) provides the primary status of the element. |
| boolean ErrorCleared | CIM_LogicalDevice | ErrorCleared is a boolean property indicating that the error reported in LastErrorCode is now cleared. |
| string OtherEnabledState | CIM_EnabledLogicalElement | A string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1. |
| string[] Alias | HPVM_IODeviceDB | Alias for this device. |
| uint8 Exists | HPVM_IODeviceDB | True if the device is known to exist on the VM Host. |
| string DeviceID | CIM_LogicalDevice | The unique ID of this virtual I/O device. |
| boolean PowerManagementSupported | CIM_LogicalDevice | 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. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| string ElementName | CIM_ManagedElement | 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 ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. |
| uint16[] PowerManagementCapabilities | CIM_LogicalDevice | 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. |
| uint64 TotalPowerOnHours | CIM_LogicalDevice | The total number of hours that this Device has been powered. |
| string CreationClassName | CIM_LogicalDevice | 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. |
| string SystemName | CIM_LogicalDevice | The scoping System's Name. |
| string[] AttributeKeys | HPVM_IODeviceDB | Names of the attributes for this device. Each element in this array corresponds to an element in the AttributeValues array. |
| string[] StatusDescriptions | CIM_ManagedSystemElement | 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. |
| string WWID | HPVM_IODeviceDB | World Wide ID for the device. Not all devices have a WWID. When this is the case, the value of this property will be WWID_NULL. |
| string ErrorDescription | CIM_LogicalDevice | 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. |
| uint32 LastErrorCode | CIM_LogicalDevice | LastErrorCode captures the last error code reported by the LogicalDevice. |
| uint16 Availability | CIM_LogicalDevice | The primary availability and status of the Device. (Additional status information can be specified using the AdditionalAvailability 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. |
| uint16 EnabledState | CIM_EnabledLogicalElement | EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=8) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/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 doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may 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 may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes 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. |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
The host system for an Integrity Virtual Machine (HPVM) installation. The host system allocates and schedules physical resources for the use of the guests.
Table 17. HPVM_Host properties| Property Name | Property Inheritance | Description |
|---|---|---|
| string[] OtherDedicatedDescriptions | CIM_ComputerSystem | A string describing how or why the system is dedicated when the Dedicated array includes the value 2, "Other". |
| string ExternalControllerName | Local | The name of the external controller of the VM Host.This property is only present if HasExternalController is true. |
| uint32 MaxHostProcessorPercentage | Local | The maximum processor percentage that can be used by the HPVM host |
| uint8 Role | Local | The role of this system in an Integrity Virtual Machine (HPVM) configuration. If the provider for this class is running on a host system, the result will be "Host", and there will be HPVM_Guest, HPVM_IODevice, and other HPVM-specific instances as well. If the provider is running in in a guest, the result will be "Guest", and only the HPVM_Host instance will be present. If the provider is running on a system that does not have HPVM installed, the result will be "Other". |
| string Name | CIM_ManagedSystemElement | The hostname or IP address for this host system.This can be used as a correlatable ID to find to find additional information about the host system in the root/cimv2 namespace. |
| uint16 ResetCapability | CIM_ComputerSystem | If enabled (value = 4), the ComputerSystem can be reset via hardware (e.g. the power and reset buttons). If disabled (value = 3), hardware reset is not allowed. In addition to Enabled and Disabled, other Values for the property are also defined - "Not Implemented" (5), "Other" (1) and "Unknown" (2). |
| uint16 EnabledDefault | CIM_EnabledLogicalElement | An enumerated value indicating an administrator's default/startup configuration for an element's EnabledState. By default, the element is "Enabled" (value=2). |
| string Status | CIM_ManagedSystemElement | 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. |
| string VMHostVirtSerial | Local | The Serial Number (Logical) string of the VM Host. This property is only present when on a guest (Role = Guest). |
| string VMHostSerial | Local | The Serial Number string of the VM Host. This property is only present when on a guest (Role = Guest). |
| string ExternalControllerURL | Local | The URL of the external controller of the VM Host.This property is only present if HasExternalController is true. |
| boolean HasExternalController | Local | True if there is an external controller that is managing the resources of the VM guests on the VM Host. |
| sint64 SchedulerMode | Local | The mode that the scheduler is in. |
| uint32 ProviderPatchVersion | Local | The patch part of the version number for the HPVM provider software. |
| string[] IdentifyingDescriptions | CIM_ComputerSystem | 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. |
| string[] OtherIdentifyingInfo | CIM_ComputerSystem | OtherIdentifyingInfo captures additional data, beyond System Name information, that could be used to identify a ComputerSystem. One example would be to hold the Fibre Channel World-Wide Name (WWN) of a node. Note that if only the Fibre Channel name is available and is unique (able to be used as the System key), then this property would be NULL and the WWN would become the System key, its data placed in the Name property. |
| uint32 MinimumGuestProcessorPercentage | Local | The minimum percentage of a processor that should be assigned to a guest. |
| string NameFormat | CIM_System | The format of the name for this computer system. This will always be "IP" for this class. |
| datetime InstallDate | CIM_ManagedSystemElement | A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. |
| string VMHostModel | Local | The model of the VM Host. This property is only present when on a guest (Role = Guest). |
| string VMHostMachineUUID | Local | The UUID of the machine that the VM Host is on. This property is only present when on a guest (Role = Guest). |
| sint64 ExternalControllerProcessID | Local | The process ID of the external controller's agent on the VM Host.This property is only present if HasExternalController is true. |
| uint64 AvailableSwapSpace | Local | The amount of swap space in megabytes available on the HPVM Host for new guests. |
| real32 ProcessorSpeed | Local | The speed of the processors on this system in Megahertz. |
| string HPVMVersion | Local | The full version string for the HPVM software. |
| uint32 MinorVersion | Local | The minor part of the version number for the HPVM software. |
| uint16 RequestedState | CIM_EnabledLogicalElement | RequestedState is an integer enumeration indicating 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/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. |
| sint64[] AvailableProcessorCycles | Local | The amount of processor megahertz available to new HPVM guests. The first element in the array is the max number of processors a guest can have. The remaining elements are the available Cycles in megahertz for a guest with the given number of processors as determined by the array index. For example, element 1 contains the available megahertz for a guest with 1 processor. Similarly element 2 contains the data for a guest with 2 processors. |
| uint16[] Dedicated | CIM_ComputerSystem | Whether this computer systems is a special-purpose system. A host should be dedicated to running guests. No applications other than system management utilities should normally run on a host. All instances of this class will have exactly one element containing only the value "HPVM Host" (32568) if running on a licensed HPVM host, or "Not Dedicated" if running on some other system. |
| uint16[] OperationalStatus | CIM_ManagedSystemElement | The operational status value for this host with respect to the installed Integrity Virtual Machine (HPVM) software. The system OperationalStatus may be obtained by querying for the correlated CIM_ComputerSystem in the root/cimv2 namespace. Values should be interpreted as follows: Unknown - host status is unknown, Other - host status is not in this list, OK - the host is normal, without error, Degraded - not used, Stressed - the host HPVM scheduler is in stressed mode, Predictive Failure - not used, Error - Not used, Non-Recoverable Error - not used, Starting - not used, Stopping - not used, Stopped - not used, In Service - not used, No Contact - not used, Lost Communication - not used, Aborted - not used, Dormant - not used, Supporting Entity in Error - not used, Completed - not used, Power Mode - not used, DMTF Reserved - not used, Vendor Reserved - not used. Only one element will be in the array. |
| string VMHostVirtUUID | Local | The UUID (Logical) of the VM Host. This property is only present when on a guest (Role = Guest). |
| string VMHostUUID | Local | The UUID of the VM Host. This property is only present when on a guest (Role = Guest). |
| uint32 ReservedProcessorPercentage | Local | The processor percentage reserved by the HPVM host |
| string OtherEnabledState | CIM_EnabledLogicalElement | A string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1. |
| uint32 ProviderMajorVersion | Local | The major part of the version number for the HPVM provider software. |
| uint32 PatchVersion | Local | The patch part of the version number for the HPVM software. |
| string PrimaryOwnerName | CIM_System | The name of the primary system owner. The system owner is the primary user of the system. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| string[] VMHostIPAddress | Local | The IP addresses of the VM Host. This property is only present when on a guest (Role = Guest). |
| string[] Roles | CIM_System | An array (bag) of strings that specify the administrator-defined roles this System plays in the managed environment. Examples might be 'Building 8 print server' or 'Boise user directories'. A single system may perform multiple roles. Note that instrumentation's view of a System's 'roles' is defined by instantiating a specific subclass of System and/or by properties in a subclass. For example, a ComputerSystem's purpose is defined using the Dedicated and OtherDedicatedDescription properties. |
| string VMHostHostname | Local | The hostname of the VM Host. This property is only present when on a guest (Role = Guest). |
| real32 GuestMemoryOverheadPercentage | Local | The additional memory that is required to boot a guest, given as a percentage of the guest's total memory. |
| uint16 ProcessorCount | Local | The number of processors on this system. |
| string ProviderVersion | Local | The full version string for the HPVM provider software. |
| string ElementName | CIM_ManagedElement | The hostname of this system. This may have the same value as the Name property |
| string[] VMHostIP6Address | Local | The IP 6 addresses of the VM Host. This property is only present when on a guest (Role = Guest). |
| uint16[] PowerManagementCapabilities | CIM_ComputerSystem | An enumerated array describing the power management capabilities of the ComputerSystem. The use of this property has been deprecated. Instead, the PowerCapabilites property in an associated PowerManagementCapabilities class should be used. |
| string ExternalControllerHostname | Local | The hostname of the external controller of the VM Host.This property is only present if HasExternalController is true. |
| sint32 ServerID | Local | The server ID |
| string PrimaryOwnerContact | CIM_System | A string that provides information on how the primary system owner can be reached (e.g. phone number, email address, ...). |
| string CreationClassName | CIM_System | 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. |
| string[] StatusDescriptions | CIM_ManagedSystemElement | 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. |
| uint64 ReservedMemory | Local | The amount of memory reserved by the HPVM host in megabytes. |
| uint64 TotalMemory | Local | The total memory on the host in megabytes. |
| uint32 ProviderMinorVersion | Local | The minor part of the version number for the HPVM provider software. |
| uint32 MajorVersion | Local | The major part of the version number for the HPVM software. |
| string VirtUUID | Local | The UUID (Logical) for this system. If the Role is "Guest", then this value can be used to correlate the system on which this provider is running to an instance of HPVM_Guest from the Integrity Virtual Machine (HPVM) provider on a host system. |
| string UUID | Local | The UUID for this system. If the Role is "Guest", then this value can be used to correlate the system on which this provider is running to an instance of HPVM_Guest from the Integrity Virtual Machine (HPVM) provider on a host system. |
| uint16 EnabledState | CIM_EnabledLogicalElement | EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=8) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/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 doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may 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 may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes 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. |
| uint64 AvailableMemory | Local | The amount of memory available to new HPVM guests in megabytes. |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
The capabilities of the HPVM Host on this version of Integrity Virtual Machine (HPVM).
Table 18. HPVM_HostCapabilities properties| Property Name | Property Inheritance | Description |
|---|---|---|
| boolean SupportsIPv6 | Local | True if IPv6 is supported. |
| boolean SupportsDynamicReplaceMedia | Local | True if this HPVM Host supports dynamically replacing media. |
| boolean SupportsAvioLanLocalnet | Local | True if the localnet vswitch can be used with AVIO LAN. |
| uint32 MaxScsiDevices | Local | The max number of SCSI Devices. |
| uint32 MaxVioStoreDevices | Local | The max number of VIO storage devices per guest. |
| boolean SupportsAvio | Local | True if the HPVM host supports AVIO. |
| string Version | Local | The supported HPVM Host version. |
| string[] BackingSerialDevices | Local | The list of supported serial backing devices. |
| boolean SupportsAttachedTape | Local | True if this HPVM Host supports devices backed by an attachedIO tape. |
| boolean SupportsLocalVSwitch | Local | True if this HPVM Host supports local virtual switches. |
| uint32 MaxAdapterSlots | Local | The max number of adapter slots. |
| uint32 MaxPciBus | Local | The max number of PCI Buses. |
| boolean SupportsMSEgroupName | Local | True if MSE group name is supported. |
| boolean SupportsPPAinfo | Local | True if the PPA info (HostLanDevice) is supported. |
| boolean SupportsAttachedBurner | Local | True if this HPVM Host supports devices backed by an attached IO burner. |
| boolean SupportsAttachedChanger | Local | True if this HPVM Host supports devices backed by an attached IO changer. |
| boolean SupportsDistributedGuests | Local | True if this HPVM Host supports distributed guests. |
| boolean SupportsEnhancedGuestStatus | Local | True if this HPVM Host supplies enhanced guest status. |
| boolean SupportsGuestVLan | Local | True if this HPVM Host supports virtual LANs that are defined in the Guest. |
| uint32 MaxVSwitchPorts | Local | The maximum number of ports on a virtual switch. |
| string InstanceID | CIM_Capabilities | Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following 'preferred' algorithm:
|
| boolean SupportsNonInteractiveQOption | Local | True if this HPVM Host supports the skip the interactive inquiry option '-Q' for the command hpvmstop. |
| boolean SupportsDynamicAddIODevices | Local | True if this HPVM Host supports dynamically adding IO devices. |
| uint32 VLanMaxID | Local | The maximum virtual LAN ID. |
| uint8 HostArchType | Local | The type of architecture for which this set of capabilities is about. |
| uint8 HostOSType | Local | The type of OS for which this set of capabilities is about. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| string[] BackingStorageDevices | Local | The list of supported storage backing devices. |
| uint32 VLanDefaultID | Local | The default virtual LAN ID. |
| string ElementName | CIM_ManagedElement | The user friendly name for this instance of Capabilities. In addition, the user friendly name can be used as a index property for a search of query. (Note: Name does not have to be unique within a namespace.) |
| boolean SupportsMaxMinVcpu | Local | True if Max/Min Vcpu is supported. |
| boolean SupportsDirectIO | Local | True if this HPVM Host supports direct IO. |
| string[] AvioBackDevices | Local | The list of supported storage backing devices for AVIO storage adapters. |
| boolean SupportsEntitlementCapping | Local | True if entitlement capping is supported. |
| uint32 MaxAvioStoreDevices | Local | The max number of AVIO storage devices per guest. |
| boolean SupportsVSwitchVLan | Local | True if this HPVM Host supports virtual LAN for a virtual switches. |
| string[] BackingNetworkDevices | Local | The list of supported network backing devices. |
| boolean SupportsEffectiveServer | Local | True if effective server is supported. |
| boolean SupportsOGM | Local | True if online guest migration (OGM) is supported. |
| boolean SupportsDistributedGuestManagement | Local | True if this HPVM Host supports managing distributed guests. |
| boolean SupportsDynamicDeleteIODevices | Local | True if this HPVM Host supports dynamically deleting IO devices. |
| boolean SupportsApaVSwitch | Local | True if this HPVM Host supports APA virtual switches. |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
The LAN devices on the Integrity Virtual Machine Host.
Table 19. HPVM_HostLanDevice properties| Property Name | Property Inheritance | Description |
|---|---|---|
| string deviceNamePPA | Local | The device name and PPA. |
| uint64 PowerOnHours | CIM_LogicalDevice | The number of consecutive hours that this Device has been powered, since its last power cycle. |
| uint16 StatusInfo | CIM_LogicalDevice | The StatusInfo property indicates whether the LogicalDevice 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. |
| uint16 EnabledDefault | CIM_EnabledLogicalElement | An enumerated value indicating an administrator's default/startup configuration for an element's EnabledState. By default, the element is "Enabled" (value=2). |
| string Status | CIM_ManagedSystemElement | 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. |
| string Name | CIM_ManagedSystemElement | 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. |
| string deviceName | Local | The device name. |
| string altIfaceName | Local | The Alternate interface name (snap). |
| uint32 PPA | Local | A unique PPA value. |
| uint64 MaxQuiesceTime | CIM_LogicalDevice | 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. |
| uint16[] AdditionalAvailability | CIM_LogicalDevice | 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"). |
| string[] IdentifyingDescriptions | CIM_LogicalDevice | 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. |
| string[] OtherIdentifyingInfo | CIM_LogicalDevice | OtherIdentifyingInfo captures additional data, beyond DeviceID information, that could be used to identify a LogicalDevice. One example would be to hold the OperatingSystem's user friendly name for the Device in this property. |
| uint32 HardwareState | Local | The hardware state. |
| datetime InstallDate | CIM_ManagedSystemElement | A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. |
| uint32 mtu | Local | The mtu value. |
| string SystemCreationClassName | CIM_LogicalDevice | The scoping System's CreationClassName. |
| uint16 RequestedState | CIM_EnabledLogicalElement | RequestedState is an integer enumeration indicating 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/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. |
| uint16[] OperationalStatus | CIM_ManagedSystemElement | 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 ManagedSystemElement 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. 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. As always, Status (since it is single-valued) provides the primary status of the element. |
| uint32 ifaceType | Local | The interface type. |
| boolean ErrorCleared | CIM_LogicalDevice | ErrorCleared is a boolean property indicating that the error reported in LastErrorCode is now cleared. |
| string OtherEnabledState | CIM_EnabledLogicalElement | A string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1. |
| uint32 linkState | Local | The link state. |
| uint32 networkManagementID | Local | The network management id value. |
| sint32 parentPPA | Local | The parent's PPA value. |
| string ifaceName | Local | The interface name. |
| uint8 haState | Local | The high availability state. |
| string hardwarePath | Local | The hardware path. |
| string physicalMacAddress | Local | The physical MAC address. |
| string DeviceID | CIM_LogicalDevice | The unique PPA value of the device. |
| boolean PowerManagementSupported | CIM_LogicalDevice | 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. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| uint32 cardInstanceNumber | Local | The card instant number. |
| string ElementName | CIM_ManagedElement | 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 ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. |
| uint16[] PowerManagementCapabilities | CIM_LogicalDevice | 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. |
| uint32 encapsType | Local | The LLC encapsulation methods. |
| string driverName | Local | The driver name. |
| uint64 TotalPowerOnHours | CIM_LogicalDevice | The total number of hours that this Device has been powered. |
| string CreationClassName | CIM_LogicalDevice | 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. |
| string SystemName | CIM_LogicalDevice | The scoping System's Name. |
| string[] StatusDescriptions | CIM_ManagedSystemElement | 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. |
| string macTypeName | Local | The MAC type name. |
| uint32 macType | Local | The MAC type value. |
| string ErrorDescription | CIM_LogicalDevice | 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. |
| uint32 LastErrorCode | CIM_LogicalDevice | LastErrorCode captures the last error code reported by the LogicalDevice. |
| uint16 Availability | CIM_LogicalDevice | The primary availability and status of the Device. (Additional status information can be specified using the AdditionalAvailability 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. |
| uint16 EnabledState | CIM_EnabledLogicalElement | EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=8) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/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 doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may 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 may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes 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. |
| string encapsName | Local | The encapsulation name. |
| uint32 macAddrLength | Local | The length of MAC address. |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
A virtual I/O device for a guest in an Integrity Virtual Machine (HPVM) configuration. The instance contains information about how the virtual I/O device will appear to the guest operating system, and the host resources used to serve the device.
Table 20. HPVM_IODevice properties| Property Name | Property Inheritance | Description |
|---|---|---|
| string HostResource | Local | A specification of the physical host system resource to be used by the virtual I/O device. This, along with HostResourceType, can be used to create a correlatable ID to find information about the host I/O device from the appropriate provider. See the Integrity Virtual Machine (HPVM) documentation and the Description qualifier for HostDeviceType for more information. |
| uint64 PowerOnHours | CIM_LogicalDevice | The number of consecutive hours that this Device has been powered, since its last power cycle. |
| uint16 StatusInfo | CIM_LogicalDevice | The StatusInfo property indicates whether the LogicalDevice 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. |
| uint16 EnabledDefault | CIM_EnabledLogicalElement | An enumerated value indicating an administrator's default/startup configuration for an element's EnabledState. By default, the element is "Enabled" (value=2). |
| string Status | CIM_ManagedSystemElement | 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. |
| string Name | CIM_ManagedSystemElement | 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. |
| uint32 GuestBus | Local | The bus number for the virtual I/O device as it appears to the guest OS. This is chosen by the Integrity Virtual Machine (HPVM) software. |
| uint64 MaxQuiesceTime | CIM_LogicalDevice | 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. |
| uint16[] AdditionalAvailability | CIM_LogicalDevice | 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"). |
| string[] IdentifyingDescriptions | CIM_LogicalDevice | 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. |
| string[] OtherIdentifyingInfo | CIM_LogicalDevice | OtherIdentifyingInfo captures additional data, beyond DeviceID information, that could be used to identify a LogicalDevice. One example would be to hold the OperatingSystem's user friendly name for the Device in this property. |
| uint32 GuestDeviceID | Local | The device ID for the virtual I/O device as it appears to the guest OS. This is chosen by the Integrity Virtual Machine (HPVM) software. |
| datetime InstallDate | CIM_ManagedSystemElement | A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. |
| string SystemCreationClassName | CIM_LogicalDevice | The scoping System's CreationClassName. |
| uint16 RequestedState | CIM_EnabledLogicalElement | RequestedState is an integer enumeration indicating 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/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. |
| uint16[] OperationalStatus | CIM_ManagedSystemElement | 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 ManagedSystemElement 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. 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. As always, Status (since it is single-valued) provides the primary status of the element. |
| boolean ErrorCleared | CIM_LogicalDevice | ErrorCleared is a boolean property indicating that the error reported in LastErrorCode is now cleared. |
| string OtherEnabledState | CIM_EnabledLogicalElement | A string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1. |
| uint32 GuestFunction | Local | The device function for the virtual I/O device as it appears to the guest OS. This is chosen by the Integrity Virtual Machine (HPVM) software. |
| uint16 PortID | Local | This property contains the port number on the virtual switch that is backing this device. This property is only present if this device is backed by a switch. |
| uint32 GuestLUN | Local | The device LUN for the virtual I/O device as it appears to the guest OS. This is chosen by the Integrity Virtual Machine (HPVM) software. |
| uint8 GuestAdapterType | Local | The adapter type of the virtual I/O device as it appears to the guest OS. If an "accelerated" value is configured, the guest OS must contain an Integrity Virtual Machines (HPVM) compatible accelerated driver for the device. |
| string DeviceID | CIM_LogicalDevice | The unique ID of this virtual I/O device. |
| boolean PowerManagementSupported | CIM_LogicalDevice | 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. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| string ElementName | CIM_ManagedElement | 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 ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. |
| uint16[] PowerManagementCapabilities | CIM_LogicalDevice | 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. |
| uint8 GuestDeviceType | Local | The type of device as it appears to the guest OS. If the GuestAdapterType is either of the SCSI alternatives, then the device type may be "Disk", "Tape", "DVD", or "Default". Note that "Default" for a SCSI adapter is the same as "Disk". If the GuestAdapterType is one of the LAN alternatives, then the GuestDeviceType must be "Default" |
| uint64 TotalPowerOnHours | CIM_LogicalDevice | The total number of hours that this Device has been powered. |
| string CreationClassName | CIM_LogicalDevice | 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. |
| string SystemName | CIM_LogicalDevice | The scoping System's Name. |
| string[] StatusDescriptions | CIM_ManagedSystemElement | 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. |
| string GuestDeviceAddressParameters | Local | Additional parameters required to address the device in the context of the guest OS. This is chosen by the Integrity Virtual Machine (HPVM) software. |
| uint32 GuestTarget | Local | The device target for the virtual I/O device as it appears to the guest OS. This is chosen by the Integrity Virtual Machine (HPVM) software. |
| uint8 HostResourceType | Local | The type of physical I/O resource associated with the HostResource property. If the value is "Switch", then HostResource is the name of a virtual switch, and there will also be a CIM_HostedDependency association between the instance and the corresponding HPVM_Switch instance. If the value is "File", "RAM Disk", or "Logical Volume", then HostResource contains the filename of the corresponding file (CIM_File) or file system root (CIM_FileSystem). For "Disk", "DVD", "Tape", or "Raw", HostResource is a guest operating system dependent value, for example, on HP-UX or Linux, this will be the name of a special device file (CIM_DeviceFile). |
| string ErrorDescription | CIM_LogicalDevice | 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. |
| uint32 LastErrorCode | CIM_LogicalDevice | LastErrorCode captures the last error code reported by the LogicalDevice. |
| uint16 Availability | CIM_LogicalDevice | The primary availability and status of the Device. (Additional status information can be specified using the AdditionalAvailability 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. |
| uint16 EnabledState | CIM_EnabledLogicalElement | EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=8) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/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 doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may 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 may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes 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. |
| string ContainingGuest | Local | The name of the guest containing this virtual I/O device. This is provided strictly as a shortcut. There will also be a SystemDevice association between this instance and the containing guest. |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
Data from the HPVM device database about some of the devices on the VM Host.
Table 21. HPVM_IODeviceDB properties| Property Name | Property Inheritance | Description |
|---|---|---|
| uint64 PowerOnHours | CIM_LogicalDevice | The number of consecutive hours that this Device has been powered, since its last power cycle. |
| uint16 StatusInfo | CIM_LogicalDevice | The StatusInfo property indicates whether the LogicalDevice 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. |
| uint16 EnabledDefault | CIM_EnabledLogicalElement | An enumerated value indicating an administrator's default/startup configuration for an element's EnabledState. By default, the element is "Enabled" (value=2). |
| string Status | CIM_ManagedSystemElement | 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. |
| string Name | CIM_ManagedSystemElement | 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. |
| string[] AttributeValues | Local | Values of the attributes for this device. Each element in this array corresponds to an element in the AttributeKeys array. |
| uint8 ResourceType | Local | The type of I/O resource associated with this device. |
| uint8 ResourceAssociation | Local | This represents the database entry type. |
| uint64 MaxQuiesceTime | CIM_LogicalDevice | 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. |
| string[] Dependencies | Local | UUIDs for devices that depend on this device. |
| uint16[] AdditionalAvailability | CIM_LogicalDevice | 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"). |
| string[] IdentifyingDescriptions | CIM_LogicalDevice | 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. |
| string[] OtherIdentifyingInfo | CIM_LogicalDevice | OtherIdentifyingInfo captures additional data, beyond DeviceID information, that could be used to identify a LogicalDevice. One example would be to hold the OperatingSystem's user friendly name for the Device in this property. |
| datetime InstallDate | CIM_ManagedSystemElement | A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. |
| uint8 Shareable | Local | True if the device is shareable between guests. |
| string SystemCreationClassName | CIM_LogicalDevice | The scoping System's CreationClassName. |
| uint16 RequestedState | CIM_EnabledLogicalElement | RequestedState is an integer enumeration indicating 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/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. |
| uint16[] OperationalStatus | CIM_ManagedSystemElement | 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 ManagedSystemElement 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. 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. As always, Status (since it is single-valued) provides the primary status of the element. |
| boolean ErrorCleared | CIM_LogicalDevice | ErrorCleared is a boolean property indicating that the error reported in LastErrorCode is now cleared. |
| string OtherEnabledState | CIM_EnabledLogicalElement | A string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1. |
| string[] Alias | Local | Alias for this device. |
| uint8 Exists | Local | True if the device is known to exist on the VM Host. |
| string DeviceID | CIM_LogicalDevice | The unique ID of this virtual I/O device. |
| boolean PowerManagementSupported | CIM_LogicalDevice | 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. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| string ElementName | CIM_ManagedElement | 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 ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. |
| uint16[] PowerManagementCapabilities | CIM_LogicalDevice | 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. |
| uint64 TotalPowerOnHours | CIM_LogicalDevice | The total number of hours that this Device has been powered. |
| string CreationClassName | CIM_LogicalDevice | 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. |
| string SystemName | CIM_LogicalDevice | The scoping System's Name. |
| string[] AttributeKeys | Local | Names of the attributes for this device. Each element in this array corresponds to an element in the AttributeValues array. |
| string[] StatusDescriptions | CIM_ManagedSystemElement | 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. |
| string WWID | Local | World Wide ID for the device. Not all devices have a WWID. When this is the case, the value of this property will be WWID_NULL. |
| string ErrorDescription | CIM_LogicalDevice | 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. |
| uint32 LastErrorCode | CIM_LogicalDevice | LastErrorCode captures the last error code reported by the LogicalDevice. |
| uint16 Availability | CIM_LogicalDevice | The primary availability and status of the Device. (Additional status information can be specified using the AdditionalAvailability 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. |
| uint16 EnabledState | CIM_EnabledLogicalElement | EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=8) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/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 doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may 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 may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes 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. |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
Gather data from a system for the purposes of rendering the vmmgr user interface screens. Note that this class does not extend any CIM standard classes. This is for two reasons. First, there wasn't a logical choice given the non-standard nature of this class. CIM_Service seemed to be the closest, but it is geared toward a service such as a name server that can be started and stopped. Secondly, this class is not intended to be used by any product beyond the vmmgr product. Therefore, conformance to the CIM standard classes has little benefit.
Table 22. HPVM_InternalDataAcquisition properties| Property Name | Property Inheritance | Description |
|---|
An instance of an MSE Server in a MSE Group.
Table 23. HPVM_MSEServer properties| Property Name | Property Inheritance | Description |
|---|---|---|
| string[] OtherDedicatedDescriptions | CIM_ComputerSystem | A string describing how or why the system is dedicated when the Dedicated array includes the value 2, "Other". |
| string MSEGroupIP | Local | MSE group's IP, this is for future group services. |
| string MSEGroupName | Local | MSE group's name. |
| string Name | CIM_ManagedSystemElement | The MSE server's UUID. This value should be unique for all MSE group servers. This can be used as a correlatable ID to find additional information about the MSE Server in the root/cimv2 namespace. |
| uint16 ResetCapability | CIM_ComputerSystem | If enabled (value = 4), the ComputerSystem can be reset via hardware (e.g. the power and reset buttons). If disabled (value = 3), hardware reset is not allowed. In addition to Enabled and Disabled, other Values for the property are also defined - "Not Implemented" (5), "Other" (1) and "Unknown" (2). |
| uint16 EnabledDefault | CIM_EnabledLogicalElement | An enumerated value indicating an administrator's default/startup configuration for an element's EnabledState. By default, the element is "Enabled" (value=2). |
| string Status | CIM_ManagedSystemElement | 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. |
| string ServerVirtUUID | Local | The MSE server's Virtual UUID. |
| string ServerUUID | Local | The MSE server's UUID. |
| string[] IdentifyingDescriptions | CIM_ComputerSystem | 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. |
| string[] OtherIdentifyingInfo | CIM_ComputerSystem | OtherIdentifyingInfo captures additional data, beyond System Name information, that could be used to identify a ComputerSystem. One example would be to hold the Fibre Channel World-Wide Name (WWN) of a node. Note that if only the Fibre Channel name is available and is unique (able to be used as the System key), then this property would be NULL and the WWN would become the System key, its data placed in the Name property. |
| string NameFormat | CIM_System | The format of the name for this computer system. This will always be "UUID" for this class. |
| datetime InstallDate | CIM_ManagedSystemElement | A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. |
| string ServerIpAddress | Local | The MSE server's IP Address. |
| sint32 ServerState | Local | The MSE server's state. |
| uint16 RequestedState | CIM_EnabledLogicalElement | RequestedState is an integer enumeration indicating 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/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. |
| uint16[] Dedicated | CIM_ComputerSystem | Enumeration indicating whether the ComputerSystem is a special-purpose System (ie, dedicated to a particular use), versus being 'general purpose'. For example, one could specify that the System is dedicated to "Print" (value=11) or acts as a "Hub" (value=8). A clarification is needed with respect to the value 17 ("Mobile User Device"). An example of a dedicated user device is a mobile phone or a barcode scanner in a store that communicates via radio frequency. These systems are quite limited in functionality and programmability, and are not considered 'general purpose' computing platforms. Alternately, an example of a mobile system that is 'general purpose' (i.e., is NOT dedicated) is a hand-held computer. Although limited in its programmability, new software can be downloaded and its functionality expanded by the user. |
| uint16[] OperationalStatus | CIM_ManagedSystemElement | 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 ManagedSystemElement 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. 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. As always, Status (since it is single-valued) provides the primary status of the element. |
| string ServerHostName | Local | The MSE server's hostname. |
| string OtherEnabledState | CIM_EnabledLogicalElement | A string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1. |
| string MSEGroupUUID | Local | MSE group's uuid. |
| string PrimaryOwnerName | CIM_System | The name of the primary system owner. The system owner is the primary user of the system. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| string[] Roles | CIM_System | An array (bag) of strings that specify the administrator-defined roles this System plays in the managed environment. Examples might be 'Building 8 print server' or 'Boise user directories'. A single system may perform multiple roles. Note that instrumentation's view of a System's 'roles' is defined by instantiating a specific subclass of System and/or by properties in a subclass. For example, a ComputerSystem's purpose is defined using the Dedicated and OtherDedicatedDescription properties. |
| string ElementName | CIM_ManagedElement | The MSE server's hostname. |
| uint16[] PowerManagementCapabilities | CIM_ComputerSystem | An enumerated array describing the power management capabilities of the ComputerSystem. The use of this property has been deprecated. Instead, the PowerCapabilites property in an associated PowerManagementCapabilities class should be used. |
| sint32 ServerID | Local | The MSE server's ID. |
| string PrimaryOwnerContact | CIM_System | A string that provides information on how the primary system owner can be reached (e.g. phone number, email address, ...). |
| string CreationClassName | CIM_System | 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. |
| string[] StatusDescriptions | CIM_ManagedSystemElement | 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. |
| boolean IsLocalHost | Local | The MSE server is running on the local host. |
| uint16 EnabledState | CIM_EnabledLogicalElement | EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=8) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/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 doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may 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 may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes 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. |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
IO devices that are marked as restricted. In other words, devices that are not being used by HPVM and should not be used by HPVM.
Table 24. HPVM_RestrictedIODeviceDB properties| Property Name | Property Inheritance | Description |
|---|---|---|
| uint64 PowerOnHours | CIM_LogicalDevice | The number of consecutive hours that this Device has been powered, since its last power cycle. |
| uint16 StatusInfo | CIM_LogicalDevice | The StatusInfo property indicates whether the LogicalDevice 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. |
| uint16 EnabledDefault | CIM_EnabledLogicalElement | An enumerated value indicating an administrator's default/startup configuration for an element's EnabledState. By default, the element is "Enabled" (value=2). |
| string Status | CIM_ManagedSystemElement | 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. |
| string Name | CIM_ManagedSystemElement | 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. |
| string[] AttributeValues | HPVM_IODeviceDB | Values of the attributes for this device. Each element in this array corresponds to an element in the AttributeKeys array. |
| uint8 ResourceType | HPVM_IODeviceDB | The type of I/O resource associated with this device. |
| uint8 ResourceAssociation | HPVM_IODeviceDB | This represents the database entry type. |
| uint64 MaxQuiesceTime | CIM_LogicalDevice | 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. |
| string[] Dependencies | HPVM_IODeviceDB | UUIDs for devices that depend on this device. |
| uint16[] AdditionalAvailability | CIM_LogicalDevice | 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"). |
| string[] IdentifyingDescriptions | CIM_LogicalDevice | 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. |
| string[] OtherIdentifyingInfo | CIM_LogicalDevice | OtherIdentifyingInfo captures additional data, beyond DeviceID information, that could be used to identify a LogicalDevice. One example would be to hold the OperatingSystem's user friendly name for the Device in this property. |
| datetime InstallDate | CIM_ManagedSystemElement | A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. |
| uint8 Shareable | HPVM_IODeviceDB | True if the device is shareable between guests. |
| string SystemCreationClassName | CIM_LogicalDevice | The scoping System's CreationClassName. |
| uint16 RequestedState | CIM_EnabledLogicalElement | RequestedState is an integer enumeration indicating 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/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. |
| uint16[] OperationalStatus | CIM_ManagedSystemElement | 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 ManagedSystemElement 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. 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. As always, Status (since it is single-valued) provides the primary status of the element. |
| boolean ErrorCleared | CIM_LogicalDevice | ErrorCleared is a boolean property indicating that the error reported in LastErrorCode is now cleared. |
| string OtherEnabledState | CIM_EnabledLogicalElement | A string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1. |
| string[] Alias | HPVM_IODeviceDB | Alias for this device. |
| uint8 Exists | HPVM_IODeviceDB | True if the device is known to exist on the VM Host. |
| string DeviceID | CIM_LogicalDevice | The unique ID of this virtual I/O device. |
| boolean PowerManagementSupported | CIM_LogicalDevice | 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. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| string ElementName | CIM_ManagedElement | 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 ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. |
| uint16[] PowerManagementCapabilities | CIM_LogicalDevice | 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. |
| uint64 TotalPowerOnHours | CIM_LogicalDevice | The total number of hours that this Device has been powered. |
| string CreationClassName | CIM_LogicalDevice | 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. |
| string SystemName | CIM_LogicalDevice | The scoping System's Name. |
| string[] AttributeKeys | HPVM_IODeviceDB | Names of the attributes for this device. Each element in this array corresponds to an element in the AttributeValues array. |
| string[] StatusDescriptions | CIM_ManagedSystemElement | 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. |
| string WWID | HPVM_IODeviceDB | World Wide ID for the device. Not all devices have a WWID. When this is the case, the value of this property will be WWID_NULL. |
| string ErrorDescription | CIM_LogicalDevice | 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. |
| uint32 LastErrorCode | CIM_LogicalDevice | LastErrorCode captures the last error code reported by the LogicalDevice. |
| uint16 Availability | CIM_LogicalDevice | The primary availability and status of the Device. (Additional status information can be specified using the AdditionalAvailability 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. |
| uint16 EnabledState | CIM_EnabledLogicalElement | EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=8) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/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 doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may 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 may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes 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. |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
IO devices that are being used by the VM Host.
Table 25. HPVM_ServerIODeviceDB properties| Property Name | Property Inheritance | Description |
|---|---|---|
| uint64 PowerOnHours | CIM_LogicalDevice | The number of consecutive hours that this Device has been powered, since its last power cycle. |
| uint16 StatusInfo | CIM_LogicalDevice | The StatusInfo property indicates whether the LogicalDevice 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. |
| uint16 EnabledDefault | CIM_EnabledLogicalElement | An enumerated value indicating an administrator's default/startup configuration for an element's EnabledState. By default, the element is "Enabled" (value=2). |
| string Status | CIM_ManagedSystemElement | 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. |
| string Name | CIM_ManagedSystemElement | 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. |
| string[] AttributeValues | HPVM_IODeviceDB | Values of the attributes for this device. Each element in this array corresponds to an element in the AttributeKeys array. |
| uint8 ResourceType | HPVM_IODeviceDB | The type of I/O resource associated with this device. |
| uint8 ResourceAssociation | HPVM_IODeviceDB | This represents the database entry type. |
| uint64 MaxQuiesceTime | CIM_LogicalDevice | 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. |
| string[] Dependencies | HPVM_IODeviceDB | UUIDs for devices that depend on this device. |
| uint16[] AdditionalAvailability | CIM_LogicalDevice | 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"). |
| string[] IdentifyingDescriptions | CIM_LogicalDevice | 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. |
| string[] OtherIdentifyingInfo | CIM_LogicalDevice | OtherIdentifyingInfo captures additional data, beyond DeviceID information, that could be used to identify a LogicalDevice. One example would be to hold the OperatingSystem's user friendly name for the Device in this property. |
| datetime InstallDate | CIM_ManagedSystemElement | A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. |
| uint8 Shareable | HPVM_IODeviceDB | True if the device is shareable between guests. |
| string SystemCreationClassName | CIM_LogicalDevice | The scoping System's CreationClassName. |
| uint16 RequestedState | CIM_EnabledLogicalElement | RequestedState is an integer enumeration indicating 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/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. |
| uint16[] OperationalStatus | CIM_ManagedSystemElement | 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 ManagedSystemElement 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. 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. As always, Status (since it is single-valued) provides the primary status of the element. |
| boolean ErrorCleared | CIM_LogicalDevice | ErrorCleared is a boolean property indicating that the error reported in LastErrorCode is now cleared. |
| string OtherEnabledState | CIM_EnabledLogicalElement | A string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1. |
| string[] Alias | HPVM_IODeviceDB | Alias for this device. |
| uint8 Exists | HPVM_IODeviceDB | True if the device is known to exist on the VM Host. |
| string DeviceID | CIM_LogicalDevice | The unique ID of this virtual I/O device. |
| boolean PowerManagementSupported | CIM_LogicalDevice | 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. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| string ElementName | CIM_ManagedElement | 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 ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. |
| uint16[] PowerManagementCapabilities | CIM_LogicalDevice | 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. |
| uint64 TotalPowerOnHours | CIM_LogicalDevice | The total number of hours that this Device has been powered. |
| string CreationClassName | CIM_LogicalDevice | 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. |
| string SystemName | CIM_LogicalDevice | The scoping System's Name. |
| string[] AttributeKeys | HPVM_IODeviceDB | Names of the attributes for this device. Each element in this array corresponds to an element in the AttributeValues array. |
| string[] StatusDescriptions | CIM_ManagedSystemElement | 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. |
| string WWID | HPVM_IODeviceDB | World Wide ID for the device. Not all devices have a WWID. When this is the case, the value of this property will be WWID_NULL. |
| string ErrorDescription | CIM_LogicalDevice | 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. |
| uint32 LastErrorCode | CIM_LogicalDevice | LastErrorCode captures the last error code reported by the LogicalDevice. |
| uint16 Availability | CIM_LogicalDevice | The primary availability and status of the Device. (Additional status information can be specified using the AdditionalAvailability 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. |
| uint16 EnabledState | CIM_EnabledLogicalElement | EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=8) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/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 doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may 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 may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes 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. |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |
A virtual switch in an Integrity Virtual Machine (HPVM) configuration. A virtual switch virtualizes access to physical network resources on the host system while permitting (or preventing) sharing of those resources among guests.
Table 26. HPVM_Switch properties| Property Name | Property Inheritance | Description |
|---|---|---|
| string[] OtherDedicatedDescriptions | CIM_ComputerSystem | A string describing how or why the system is dedicated when the Dedicated array includes the value 2, "Other". |
| string HostResource | Local | The host system resource specification for the network interface card or card aggregation that will be used by the virtual switch. This can be used as a correlatable ID to find additional information about the physical resources from the appropriate provider. See the Integrity Virtual Machine (HPVM) documentation for more information about possible values of this property. |
| string Name | CIM_ManagedSystemElement | The name of the virtual switch. This name is unique in the context of a single VM Host |
| uint16 ResetCapability | CIM_ComputerSystem | If enabled (value = 4), the ComputerSystem can be reset via hardware (e.g. the power and reset buttons). If disabled (value = 3), hardware reset is not allowed. In addition to Enabled and Disabled, other Values for the property are also defined - "Not Implemented" (5), "Other" (1) and "Unknown" (2). |
| uint16 EnabledDefault | CIM_EnabledLogicalElement | An enumerated value indicating an administrator's default/startup configuration for an element's EnabledState. By default, the element is "Enabled" (value=2). |
| string Status | CIM_ManagedSystemElement | 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. |
| uint16[] PortIDs | Local | The port IDs. |
| string[] IdentifyingDescriptions | CIM_ComputerSystem | 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. |
| string[] OtherIdentifyingInfo | CIM_ComputerSystem | OtherIdentifyingInfo captures additional data, beyond System Name information, that could be used to identify a ComputerSystem. One example would be to hold the Fibre Channel World-Wide Name (WWN) of a node. Note that if only the Fibre Channel name is available and is unique (able to be used as the System key), then this property would be NULL and the WWN would become the System key, its data placed in the Name property. |
| string NameFormat | CIM_System | The ComputerSystem object and its derivatives are Top Level Objects of CIM. They provide the scope for numerous components. Having unique System keys is required. The NameFormat property identifies how the ComputerSystem Name is generated. The NameFormat ValueMap qualifier defines the various mechanisms for assigning the name. Note that another name can be assigned and used for the ComputerSystem that better suit a business, using the inherited ElementName property. |
| datetime InstallDate | CIM_ManagedSystemElement | A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. |
| uint16[] VirtualLANIDs | Local | The virtual LAN IDs. |
| uint64 ProcessID | Local | The process ID of the virtual switch on the host. |
| uint8 Mode | Local | The operation mode of the virtual switch. "Shared" switches can be shared among guests. The "Shared" switch is capable of using hardware filtering in the host resource to reduce network traffic routed to any associated guest network interfaces. An "Exclusive" switch may be associated with only one guest network interface. See the Integrity Virtual Machine (HPVM) documentation for more information. |
| uint16 RequestedState | CIM_EnabledLogicalElement | RequestedState is an integer enumeration indicating 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/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. |
| string[] GuestMacAddresses | Local | The mac addresses for the guests that are using this switch. |
| uint16[] Dedicated | CIM_ComputerSystem | Whether this computer system is a special-purpose system. A switch is a special purpose system. All instances of this class will have exactly one elementcontaining only the value "Switch" (5) |
| uint16[] OperationalStatus | CIM_ManagedSystemElement | The operational status value for this virtual switch. Values should be interpreted as follows: Unknown - status is unknown, Other - status is not in this list, OK - the switch is active, Degraded - not used, Stressed - not used, Predictive Failure - not used, Error - not used, Non-Recoverable Error - not used, Starting - not used, Stopping - not used, Stopped - the switch is inactive, In Service - not used, No Contact - not used, Lost Communication - not used, Aborted - not used, Dormant - not used, Supporting Entity in Error - not used, Completed - not used, Power Mode - not used, DMTF Reserved - not used, Vendor Reserved - not used, Note that for a virtual switch, the operational status array will never contain more than one value and will always be either "OK", "Stopped", or "Unknown". |
| string OtherEnabledState | CIM_EnabledLogicalElement | A string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1. |
| boolean[] IsPortConnectedToAGuest | Local | True if the port is connected to a Guest. |
| string PrimaryOwnerName | CIM_System | The name of the primary system owner. The system owner is the primary user of the system. |
| string Caption | CIM_ManagedElement | The Caption property is a short textual description (one-line string) of the object. |
| string[] GuestIPAddresses | Local | The IP addresses for the guests that are using this switch. |
| string[] Roles | CIM_System | An array (bag) of strings that specify the administrator-defined roles this System plays in the managed environment. Examples might be 'Building 8 print server' or 'Boise user directories'. A single system may perform multiple roles. Note that instrumentation's view of a System's 'roles' is defined by instantiating a specific subclass of System and/or by properties in a subclass. For example, a ComputerSystem's purpose is defined using the Dedicated and OtherDedicatedDescription properties. |
| string ElementName | CIM_ManagedElement | 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 ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. |
| boolean[] HasVirtualLAN | Local | True if the port has a virtual LAN configured. |
| string[] ConnectedGuests | Local | The name of the guest that is using this port. |
| uint16[] PowerManagementCapabilities | CIM_ComputerSystem | An enumerated array describing the power management capabilities of the ComputerSystem. The use of this property has been deprecated. Instead, the PowerCapabilites property in an associated PowerManagementCapabilities class should be used. |
| string PrimaryOwnerContact | CIM_System | A string that provides information on how the primary system owner can be reached (e.g. phone number, email address, ...). |
| string CreationClassName | CIM_System | 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. |
| string[] GuestNames | Local | The names of the guests that are using this switch. |
| string[] StatusDescriptions | CIM_ManagedSystemElement | 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. |
| uint16 EnabledState | CIM_EnabledLogicalElement | EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=8) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/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 doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may 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 may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes 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. |
| string Description | CIM_ManagedElement | The Description property provides a textual description of the object. |