CIM_ComputerSystem, ROOT\Hardware\ms_409

Class | Childs (1) | Methods (2) | Properties (25) | Qualifiers (3) | Instances | Namespaces (11)
Samples: VB Script | C# | VB.Net | Search on:Microsoft


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

CIM_ComputerSystem - child subclasses in ROOT\Hardware\ms_409

Number of classes:1
Class nameChildsPropertiesMethodsClass

CIM_ComputerSystem methods

CIM_ComputerSystem has 2 methods (1 Local, 1 Derived)

RequestStateChangeCIM_EnabledLogicalElementuint32 {'out':True}
SetPowerStateCIM_ComputerSystemuint32 {'out':True}

CIM_ComputerSystem properties

CIM_ComputerSystem has 25 properties (6 Local, 19 Derived)

CaptionCIM_ManagedElement8 [string]
CIM_System8 [string]
DedicatedCIM_ComputerSystem18 [uint16]
DescriptionCIM_ManagedElement8 [string]
ElementNameCIM_ManagedElement8 [string]
EnabledDefaultCIM_EnabledLogicalElement18 [uint16]
EnabledStateCIM_EnabledLogicalElement18 [uint16]
HealthStateCIM_ManagedSystemElement18 [uint16]
IdentifyingDescriptionsCIM_ComputerSystem8 [string]
InstallDateCIM_ManagedSystemElement101 [datetime]
CIM_ManagedSystemElement8 [string]
NameFormatCIM_System8 [string]
OperationalStatusCIM_ManagedSystemElement18 [uint16]
OtherDedicatedDescriptionsCIM_ComputerSystem8 [string]
OtherEnabledStateCIM_EnabledLogicalElement8 [string]
OtherIdentifyingInfoCIM_ComputerSystem8 [string]
PowerManagementCapabilitiesCIM_ComputerSystem18 [uint16]
PrimaryOwnerContactCIM_System8 [string]
PrimaryOwnerNameCIM_System8 [string]
RequestedStateCIM_EnabledLogicalElement18 [uint16]
ResetCapabilityCIM_ComputerSystem18 [uint16]
RolesCIM_System8 [string]
StatusCIM_ManagedSystemElement8 [string]
StatusDescriptionsCIM_ManagedSystemElement8 [string]
TimeOfLastStateChangeCIM_EnabledLogicalElement101 [datetime]

Detailed description of CIM_ComputerSystem methods

Local methods (1) of CIM_ComputerSystem class

SetPowerState method
Returnuint32 {'out':True}
PowerStateuint320-{'Description':'The Desired state for the COmputerSystem.','Values':['Full Power', 'Power Save - Low Power Mode', 'Power Save - Standby', 'Power Save - Other', 'Power Cycle', 'Power Off', 'Hibernate', 'Soft Off']}
Timedatetime1-{'Description':'Time indicates when the power state should be set, either as a regular date-time value or as an interval value (where the interval begins when the method invocation is received.'}
Description'Sets the power state of the computer. The use of this method has been deprecated. Instead, use the SetPowerState method in the associated PowerManagementService class.'
SetPowerState method is in 7 classes of ROOT\Hardware\ms_409 and in 14 namespaces

Derived methods (1) of CIM_ComputerSystem class

RequestStateChange method
Returnuint32 {'out':True}
RequestedStateuint160-{'Description':'The state requested for the element. This information will be placed into the instance's RequestedState property if the RequestStateChange method's return code is 0, 3, or 4096 (0x1000) - 'Completed with No Error', 'Timeout', or 'Job Started' respectively. Refer to the description of the EnabledState and RequestedState properties for the detailed meanings of the RequestedState values.','Values':['Enabled', 'Disabled', 'Shut Down', 'Offline', 'Test', 'Defer', 'Quiesce', 'Reboot', 'Reset', 'DMTF Reserved', 'Vendor Reserved']}
Jobref:CIM_ConcreteJob1-{'Description':'Reference to the job (may be null if task completed).'}
TimeoutPerioddatetime2-{'Description':'A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format MUST be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation doesn't support this parameter. A return code of 'Use Of Timeout Parameter Not Supported' MUST be returned.'}
Description'Requests that the element's state be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the element's EnabledState and RequestedState will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten/lost.
If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition.'
Values['Completed with No Error', 'Not Supported', 'Unknown/Unspecified Error', 'Can NOT complete within Timeout Period', 'Failed', 'Invalid Parameter', 'In Use', 'DMTF Reserved', 'Method Parameters Checked - Job Started', 'Invalid State Transition', 'Use of Timeout Parameter Not Supported', 'Busy', 'Method Reserved', 'Vendor Specific']
RequestStateChange method is in 14 classes of ROOT\Hardware\ms_409 and in 15 namespaces

Detailed description of CIM_ComputerSystem properties

Local properties (6) of CIM_ComputerSystem class

Dedicated property
Description'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.'
Values['Not Dedicated', 'Unknown', 'Other', 'Storage', 'Router', 'Switch', 'Layer 3 Switch', 'Central Office Switch', 'Hub', 'Access Server', 'Firewall', 'Print', 'I/O', 'Web Caching', 'Management', 'Block Server', 'File Server', 'Mobile User Device', 'Repeater', 'Bridge/Extender', 'Gateway', 'Storage Virtualizer', 'Media Library', 'ExtenderNode', 'NAS Head', 'Self-contained NAS', 'UPS', 'IP Phone', 'DMTF Reserved', 'Vendor Reserved']
Dedicated property is in 2 classes of ROOT\Hardware\ms_409 and in 8 namespaces
IdentifyingDescriptions property
Description'An array of free-form strings providing explanations and details behind the entries in the OtherIdentifying Info array. Note, each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the same index.'
IdentifyingDescriptions property is in 7 classes of ROOT\Hardware\ms_409 and in 15 namespaces
OtherDedicatedDescriptions property
Description'A string describing how or why the system is dedicated when the Dedicated array includes the value 2, "Other".'
OtherDedicatedDescriptions property is in 2 classes of ROOT\Hardware\ms_409 and in 6 namespaces
OtherIdentifyingInfo property
Description'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.'
OtherIdentifyingInfo property is in 7 classes of ROOT\Hardware\ms_409 and in 20 namespaces
PowerManagementCapabilities property
Description'An enumerated array describing the power management capabilities of the ComputerSystem. The use of this property has been deprecated. Instead, the Power Capabilites property in an associated PowerManagement Capabilities class should be used.'
Values['Unknown', 'Not Supported', 'Disabled', 'Enabled', 'Power Saving Modes Entered Automatically', 'Power State Settable', 'Power Cycling Supported', 'Timed Power On Supported']
PowerManagementCapabilities property is in 7 classes of ROOT\Hardware\ms_409 and in 14 namespaces
ResetCapability property
Description'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).'
Values['Other', 'Unknown', 'Disabled', 'Enabled', 'Not Implemented']
ResetCapability property is in 2 classes of ROOT\Hardware\ms_409 and in 10 namespaces

Derived properties (19) of CIM_ComputerSystem class

Caption property
Description'The Caption property is a short textual description (one- line string) of the object.'
Caption property is in 33 classes of ROOT\Hardware\ms_409 and in 37 namespaces
CreationClassName property
Description'CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.'
CreationClassName property is in 16 classes of ROOT\Hardware\ms_409 and in 20 namespaces
Description property
Description'The Description property provides a textual description of the object.'
Description property is in 34 classes of ROOT\Hardware\ms_409 and in 142 namespaces
ElementName property
Description'A user-friendly name for the object. This property allows each instance to define a user-friendly name IN ADDITION TO its key properties/identity data, and description information.
Note that 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.'
ElementName property is in 33 classes of ROOT\Hardware\ms_409 and in 21 namespaces
EnabledDefault property
Description'An enumerated value indicating an administrator's default/startup configuration for an element's Enabled State. By default, the element is "Enabled" (value=2).'
Values['Enabled', 'Disabled', 'Not Applicable', 'Enabled but Offline', 'No Default', 'DMTF Reserved', 'Vendor Reserved']
EnabledDefault property is in 14 classes of ROOT\Hardware\ms_409 and in 10 namespaces
EnabledState property
Description'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=10) 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.'
Values['Unknown', 'Other', 'Enabled', 'Disabled', 'Shutting Down', 'Not Applicable', 'Enabled but Offline', 'In Test', 'Deferred', 'Quiesce', 'Starting', 'DMTF Reserved', 'Vendor Reserved']
EnabledState property is in 14 classes of ROOT\Hardware\ms_409 and in 13 namespaces
HealthState property
Description'Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. The following continuum is defined:
"Non-recoverable Error" (30) - The element has completed failed and recovery is not possible. All functionality provided by this element has been lost.
"Critical Failure" (25) - The element is non-functional and recovery MAY NOT be possible.
"Major Failure" (20) - The element is failing. It is possible the some or all of the functionality of this component is degraded or not working.
"Minor Failure" (15) - All functionality is available but some MAY be degraded.
"Degraded/Warning" (10) - The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element may not be operating at optimal performance or it may be reporting recoverable errors.
"OK" (5) - The element is fully functional and is operating within normal operational parameters and without error.
"Unknown" (0) - The implementation can not report on HealthState at this time.
DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.'
Values['Unknown', 'OK', 'Degraded/Warning', 'Minor failure', 'Major failure', 'Critical failure', 'Non-recoverable error', 'DMTF Reserved']
HealthState property is in 18 classes of ROOT\Hardware\ms_409 and in 15 namespaces
InstallDate property
Description'A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.'
InstallDate property is in 18 classes of ROOT\Hardware\ms_409 and in 23 namespaces
Name property
Description'The inherited Name serves as key of a System instance in an enterprise environment.'
Name property is in 26 classes of ROOT\Hardware\ms_409 and in 142 namespaces
NameFormat property
Description'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.'
NameFormat property is in 5 classes of ROOT\Hardware\ms_409 and in 21 namespaces
OperationalStatus property
Description'Indicates the current status(es) of the element. Various operational statuses are defined. Many of the enumeration's values are self- explanatory. However, a few are not and are described in more detail.
"Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, etc.
"Predictive Failure" indicates that an element is functioning nominally but predicting a failure in the near future.
"In Service" describes an element being configured, maintained, cleaned, or otherwise administered.
"No Contact" indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.
"Lost Communication" indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable.
"Stopped" and "Aborted" are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the element's state and configuration may need to be updated.
"Dormant" indicates that the element is inactive or quiesced.
"Supporting Entity in Error" describes that this element may be "OK" but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower layer networking problems.
"Completed" indicates the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error.
"Power Mode" indicates the element has additional power model information contained in the Associated PowerManagementService association.
OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today's environment to the future. This change was not made earlier since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/instrumentation provide BOTH the Status and OperationalStatus properties. Further, the first value of OperationalStatus SHOULD contain the primary status for the element. When instrumented, Status (since it is single-valued) SHOULD also provide the primary status of the element.'
Values['Unknown', 'Other', 'OK', 'Degraded', 'Stressed', 'Predictive Failure', 'Error', 'Non-Recoverable Error', 'Starting', 'Stopping', 'Stopped', 'In Service', 'No Contact', 'Lost Communication', 'Aborted', 'Dormant', 'Supporting Entity in Error', 'Completed', 'Power Mode', 'DMTF Reserved', 'Vendor Reserved']
OperationalStatus property is in 18 classes of ROOT\Hardware\ms_409 and in 18 namespaces
OtherEnabledState property
Description'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.'
OtherEnabledState property is in 14 classes of ROOT\Hardware\ms_409 and in 11 namespaces
PrimaryOwnerContact property
Description'A string that provides information on how the primary system owner can be reached (e.g. phone number, email address, ...).'
PrimaryOwnerContact property is in 5 classes of ROOT\Hardware\ms_409 and in 15 namespaces
PrimaryOwnerName property
Description'The name of the primary system owner. The system owner is the primary user of the system.'
PrimaryOwnerName property is in 5 classes of ROOT\Hardware\ms_409 and in 15 namespaces
RequestedState property
Description'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.

It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are "Reboot" (10) and "Reset" (11). The former, Reboot, refers to doing a "Shut Down" and then moving to an "Enabled" state. The latter, Reset, indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. The former, Shut Down, requests an orderly transition to the Disabled state, and MAY involve removing power, to completely erase any existing state. The latter, the Disabled state, requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests.

This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or 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.

It is possible that a particular instance of EnabledLogicalElement may not support RequestedStateChange. If this occurs, the value 12 ("Not Applicable") is used.'
Values['Enabled', 'Disabled', 'Shut Down', 'No Change', 'Offline', 'Test', 'Deferred', 'Quiesce', 'Reboot', 'Reset', 'Not Applicable', 'DMTF Reserved', 'Vendor Reserved']
RequestedState property is in 14 classes of ROOT\Hardware\ms_409 and in 12 namespaces
Roles property
Description'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.'
Roles property is in 5 classes of ROOT\Hardware\ms_409 and in 17 namespaces
Status property
Description'A string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This 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.'
Status property is in 18 classes of ROOT\Hardware\ms_409 and in 42 namespaces
StatusDescriptions property
Description'Strings describing the various OperationalStatus array values. For example, if "Stopping" is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus.'
StatusDescriptions property is in 18 classes of ROOT\Hardware\ms_409 and in 18 namespaces
TimeOfLastStateChange property
Description'The date/time when the element's EnabledState last changed. If the state of the element has not changed and this property is populated, then it MUST be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property MUST NOT be updated.'
TimeOfLastStateChange property is in 14 classes of ROOT\Hardware\ms_409 and in 17 namespaces

CIM_ComputerSystem Qualifiers

Description'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).'

CIM_ComputerSystem System properties

__DERIVATION['CIM_System', 'CIM_EnabledLogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement', 'CIM_ManagedElement']___SYSTEM8

Similar Classes to CIM_ComputerSystem

Number of classes:8
Class nameChildsPropertiesMethodsClass
comments powered by Disqus