Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

ComputerSystem class

Represents a computer system in an admin domain.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

[Dynamic, Provider("IPMIPrv"), UUID("{a3ec8fe8-83cd-40af-9513-11936d531cea}"), AMENDMENT]
class ComputerSystem : CIM_ComputerSystem
{
  string   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  string   CreationClassName;
  string   Name;
  string   PrimaryOwnerName;
  string   PrimaryOwnerContact;
  string   Roles[];
  string   NameFormat;
  string   OtherIdentifyingInfo[];
  string   IdentifyingDescriptions[];
  uint16   Dedicated[];
  string   OtherDedicatedDescriptions[];
  uint16   ResetCapability;
  uint16   PowerManagementCapabilities[];
  uint16   EnabledState = 5;
  datetime TimeOfLastStateChange;
};

Members

The ComputerSystem class has these types of members:

Methods

The ComputerSystem class has these methods.

MethodDescription
RequestStateChange

Initiates a request to change the state of the computer system.

This method is inherited from CIM_EnabledLogicalElement.

SetPowerState
Note  This method is deprecated. Instead we recommend that you use the SetPowerState property of the CIM_PowerManagementService class.

Sets the power state of the computer system.

This method is inherited from CIM_ComputerSystem.

 

Properties

The ComputerSystem class has these properties.

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

The Caption property is a short textual description (one- line string) of the object.

This property is inherited from CIM_ManagedElement.

CreationClassName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

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.

This property is inherited from CIM_System.

Dedicated
Data type: uint16 array
Access type: Read-only
Qualifiers: MappingStrings ("MIB.IETF|MIB-II.sysServices", "FC-GS.INCITS-T11 | Platform | PlatformType") , ArrayType ("Indexed") , ModelCorrespondence ("CIM_ComputerSystem.OtherDedicatedDescriptions")

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.

This property is inherited from CIM_ComputerSystem.

Not Dedicated (0)
Unknown (1)
Other (2)
Storage (3)
Router (4)
Switch (5)
Layer 3 Switch (6)
Central Office Switch (7)
Hub (8)
Access Server (9)
Firewall (10)
Print (11)
I/O (12)
Web Caching (13)
Management (14)
Block Server (15)
File Server (16)
Mobile User Device (17)
Repeater (18)
Bridge/Extender (19)
Gateway (20)
Storage Virtualizer (21)
Media Library (22)
ExtenderNode (23)
NAS Head (24)
Self-contained NAS (25)
UPS (26)
IP Phone (27)
DMTF Reserved (28–32567)
Vendor Reserved (32568–65535)
Description
Data type: string
Access type: Read-only

The Description property provides a textual description of the object.

This property is inherited from CIM_ManagedElement.

ElementName
Data type: string
Access type: Read-only

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.

This property is inherited from CIM_ManagedElement.

EnabledDefault
Data type: uint16
Access type: Read/write

An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is "Enabled" (value=2).

This property is inherited from CIM_EnabledLogicalElement.

Enabled (2)
Disabled (3)
Not Applicable (5)
Enabled but Offline (6)
No Default (7)
DMTF Reserved (8–32767)
Vendor Reserved (32768–65535)
EnabledState
Data type: uint16
Access type: Read-only

Indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled.System.Xml.XmlElementSystem.Xml.XmlElementSystem.Xml.XmlElement

ValueMeaning
Unknown
0
Other
1
Enabled
2

The element is or could be executing commands, will process any queued commands, and queues new requests.

Disabled
3

The element will not execute commands and will drop any new requests.

Shutting Down
4

The element is in the process of going to a Disabled state.

Not Applicable
5

The element does not support being enabled or disabled.

Enabled but Offline
6

The element might be completing commands, and will drop any new requests.

In Test
7

The element is in a test state.

Deferred
8

The element might be completing commands, but will queue any new requests.

Quiesce
9

The element is enabled but in a restricted mode. The behavior of the element is similar to the Enabled state (2), but it processes only a restricted set of commands. All other requests are queued.

Starting
10

The element is in the process of going to an Enabled state (2). New requests are queued.

DMTF Reserved
11–32767

Reserved.

Vendor Reserved
32768–65535

Reserved.

 

HealthState
Data type: uint16
Access type: Read-only
Qualifiers: Experimental

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.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
OK (5)
Degraded/Warning (10)
Minor failure (15)
Major failure (20)
Critical failure (25)
Non-recoverable error (30)
DMTF Reserved (31–65535)
IdentifyingDescriptions
Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed") , ModelCorrespondence ("CIM_ComputerSystem.OtherIdentifyingInfo")

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.

This property is inherited from CIM_ComputerSystem.

InstallDate
Data type: datetime
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

This property is inherited from CIM_ManagedSystemElement.

Name
Data type: string
Access type: Read-only
Qualifiers: Key, Override ("Name") , MaxLen (256)

The inherited Name serves as key of a System instance in an enterprise environment.

This property is inherited from CIM_System.

NameFormat
Data type: string
Access type: Read-only
Qualifiers: Override ("NameFormat")

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.

This property is inherited from CIM_ComputerSystem.

ValueMeaning
"Other"
"IP"
"Dial"
"HID"
"NWA"
"HWA"
"X25"
"ISDN"
"IPX"
"DCC"
"ICD"
"E.164"
"SNA"
"OID/OSI"
"WWN"
"NAA"

 

OperationalStatus
Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed") , ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

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.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
Other (1)
OK (2)
Degraded (3)
Stressed (4)
Predictive Failure (5)
Error (6)
Non-Recoverable Error (7)
Starting (8)
Stopping (9)
Stopped (10)
In Service (11)
No Contact (12)
Lost Communication (13)
Aborted (14)
Dormant (15)
Supporting Entity in Error (16)
Completed (17)
Power Mode (18)
DMTF Reserved (19–32767)
Vendor Reserved (32768–65535)
OtherDedicatedDescriptions
Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed") , ModelCorrespondence ("CIM_ComputerSystem.Dedicated")

A string describing how or why the system is dedicated when the Dedicated array includes the value 2, "Other".

This property is inherited from CIM_ComputerSystem.

OtherEnabledState
Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to null when EnabledState is any value other than 1.

This property is inherited from CIM_EnabledLogicalElement.

OtherIdentifyingInfo
Data type: string array
Access type: Read-only
Qualifiers: MaxLen (256) , ArrayType ("Indexed") , ModelCorrespondence ("CIM_ComputerSystem.IdentifyingDescriptions")

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.

This property is inherited from CIM_ComputerSystem.

PowerManagementCapabilities
Data type: uint16 array
Access type: Read-only
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities.PowerCapabilities") , MappingStrings ("MIF.DMTF|System Power Controls|001.2")

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.

This property is inherited from CIM_ComputerSystem.

Unknown (0)
Not Supported (1)
Disabled (2)
Enabled (3)
Power Saving Modes Entered Automatically (4)
Power State Settable (5)
Power Cycling Supported (6)
Timed Power On Supported (7)
PrimaryOwnerContact
Data type: string
Access type: Read/write
Qualifiers: MaxLen (256) , MappingStrings ("MIF.DMTF|General Information|001.4")

A string that provides information on how the primary system owner can be reached (e.g. phone number, email address, ...).

This property is inherited from CIM_System.

PrimaryOwnerName
Data type: string
Access type: Read/write
Qualifiers: MaxLen (64) , MappingStrings ("MIF.DMTF|General Information|001.3")

The name of the primary system owner. The system owner is the primary user of the system.

This property is inherited from CIM_System.

RequestedState
Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

RequestedState is an integer enumeration that indicates the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the RequestedState of the element is 5 ("No Change"). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration. It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are "Reboot" (10) and "Reset" (11). Reboot refers to doing a "Shut Down" and then moving to an "Enabled" state. Reset indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests. This property is set as the result of a method invocation (such as StartService or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code. A particular instance of CIM_EnabledLogicalElement might not support RequestStateChange. If this occurs, the value 12 ("Not Applicable") is used.

This property is inherited from CIM_EnabledLogicalElement.

Enabled (2)
Disabled (3)
Shut Down (4)
No Change (5)
Offline (6)
Test (7)
Deferred (8)
Quiesce (9)
Reboot (10)
Reset (11)
Not Applicable (12)
DMTF Reserved (13–32767)
Vendor Reserved (32768–65535)
ResetCapability
Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|System Hardware Security|001.4")

Describes the reset capability.

This property is inherited from CIM_ComputerSystem.

ValueMeaning
Other
1

Other.

Unknown
2

Unknown.

Disabled
3

Hardware reset is not allowed.

Enabled
4

The computer system can be reset via hardware (e.g. the power and reset buttons).

Not Implemented
5

Not implemented.

 

Roles
Data type: string array
Access type: Read/write

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.

This property is inherited from CIM_System.

Status
Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus") , MaxLen (10)

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.

This property is inherited from CIM_ManagedSystemElement.

ValueMeaning
"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
"Stressed"
"NonRecover"
"No Contact"
"Lost Comm"
"Stopped"

 

StatusDescriptions
Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed") , ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

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.

This property is inherited from CIM_ManagedSystemElement.

TimeOfLastStateChange
Data type: datetime
Access type: Write-only

The date or time when the enabled state of the element last changed. If the state of the element has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated.System.Xml.XmlElementSystem.Xml.XmlElementSystem.Xml.XmlElement

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2003 R2

Namespace

Root\hardware

MOF

IpmiPrv.mof

DLL

IpmiPrv.dll

See also

CIM_ComputerSystem
IPMI Provider
ComputerSystem

 

 

Show:
© 2015 Microsoft