Export (0) Print
Expand All
1 out of 1 rated this helpful - Rate this topic

CIM_UnitaryComputerSystem class

The CIM_UnitaryComputerSystem class represents a desktop, mobile, network computer, server, or other type of single-node computer system.

Important  The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

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

Syntax

class CIM_UnitaryComputerSystem : CIM_ComputerSystem
{
  string   Caption;
  string   CreationClassName;
  string   Description;
  string   InitialLoadInfo[];
  datetime InstallDate;
  string   LastLoadInfo;
  string   Name;
  string   NameFormat;
  uint16   PowerManagementCapabilities[];
  boolean  PowerManagementSupported;
  uint16   PowerState;
  string   PrimaryOwnerContact;
  string   PrimaryOwnerName;
  uint16   ResetCapability;
  string   Roles[];
  string   Status;
};

Members

The CIM_UnitaryComputerSystem class has these types of members:

Methods

The CIM_UnitaryComputerSystem class has these methods.

MethodDescription
SetPowerState

Defines the desired power state for a logical device and when a device should be put into that state. Not implemented by WMI.

 

Properties

The CIM_UnitaryComputerSystem class has these properties.

Caption
Data type: string
Access type: Read-only

Short textual description of the object. This property is inherited from CIM_ManagedSystemElement.

CreationClassName
Data type: string
Access type: Read-only

Name of the class or subclass used in the creation of an instance. When used with other key properties of the class, this property allows all instances of the class and its subclasses to be uniquely identified. This property is inherited from CIM_System.

Description
Data type: string
Access type: Read-only

Textual description of the object. This property is inherited from CIM_ManagedSystemElement.

InitialLoadInfo
Data type: string array
Access type: Read-only

Data needed to find either the initial load device (its key) or the boot service to request the operating system to start. In addition, the load parameters (that is, a path name and parameters) can also be specified.

InstallDate
Data type: datetime
Access type: Read-only

Date and time the object was installed. This property does not need a value to indicate that the object is installed. This property is inherited from CIM_ManagedSystemElement.

LastLoadInfo
Data type: string
Access type: Read-only

Data that identifies either the initial load device (its key) or the boot service that requested the last operating system load. In addition, the load parameters (that is, a path name and parameters) can also be specified.

Name
Data type: string
Access type: Read-only

Label by which the object is known. When subclassed, this property can be overridden to be a key property. This property is inherited from CIM_ManagedSystemElement.

NameFormat
Data type: string
Access type: Read-only

The CIM_ComputerSystem object and its derivatives are top-level objects of CIM that provide the scope for numerous components and require unique CIM_System keys. A heuristic is defined to create the CIM_ComputerSystem name in an attempt to always generate the same system name, independent of discovery protocol. This prevents inventory and management problems where the same asset or entity is discovered multiple times, but cannot be resolved to a single object. This property identifies how the system name was generated by using the subclass heuristic. The heuristic is outlined in the CIM V2 Common Model specification and assumes that the documented rules are traversed to determine and assign a name. The NameFormat values list defines the precedence order for assigning the system name with several rules mapping to the same value. Note that the CIM_ComputerSystem name that is calculated using the heuristic is the system's key value. Other names can be assigned and used for the CIM_ComputerSystem that better suit the business, using aliases. This property is inherited from CIM_System.

Values include the following:

"IP"
"Dial"
"HID"
"NWA"
"HWA"
"X25"
"ISDN"
"IPX"
"DCC"
"ICD"
"E.164"
"SNA"
"OID/OSI"
"Other"
PowerManagementCapabilities
Data type: uint16 array
Access type: Read-only

Array of the specific power-related capabilities of a logical device. This property is inherited from CIM_LogicalDevice.

ValueMeaning
0 (0x0)

Unknown

1 (0x1)

Not Supported

2 (0x2)

Disabled

3 (0x3)

Enabled

The power management features are currently enabled but the exact feature set is unknown or the information is unavailable.

4 (0x4)

Power Saving Modes Entered Automatically

The device can change its power state based on usage or other criteria.

5 (0x5)

Power State Settable

The SetPowerState method is supported. This method is found on the parent CIM_LogicalDevice class and can be implemented. For more information, see Designing Managed Object Format (MOF) Classes.

6 (0x6)

Power Cycling Supported

The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle).

7 (0x7)

Timed Power On Supported

The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle) and Time set to a specific date and time, or interval, for power-on.

 

PowerManagementSupported
Data type: boolean
Access type: Read-only

If TRUE, the device can be power managed, that is, put into a power-save state. If FALSE, the integer value 1 ("Not Supported") should be the only entry in the PowerManagementCapabilities array.

This property does not indicate whether power management features are currently enabled, or if enabled, which features are supported. For more information, see the PowerManagementCapabilities array.

PowerState
Data type: uint16
Access type: Read-only

Current power state of the computer system and its associated operating system.

ValueMeaning
0

Unknown.

1

Full power.

2

Power save — low-power mode.

System is in a power-save state and still functioning, but may exhibit degraded performance.

3

Power save — standby.

System is not functioning, but could be brought to full power quickly.

4

Power save — unknown.

System is known to be in a power-save mode, but its exact status is unknown.

5

Power cycle.

6

Power off.

7

Power save — warning.

System is in a warning state and also in a power-save mode.

8

Power save — hibernate.

9

Power save — soft off.

 

PrimaryOwnerContact
Data type: string
Access type: Read-only

String that provides information on how to reach the primary system owner (for example, phone number, email address, and so on). This property is inherited from CIM_System.

PrimaryOwnerName
Data type: string
Access type: Read-only

Name of the primary system owner. This property is inherited from CIM_System.

ResetCapability
Data type: uint16
Access type: Read-only

If enabled, the unitary computer system can be reset with hardware (for example, with the power and reset buttons). If disabled, hardware reset is not allowed.

ValueMeaning
1

Other

2

Unknown

3

Disabled

4

Enabled

5

Not implemented

 

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

Roles the system plays in the information technology environment. Subclasses of the system can override this property to define explicit role values. Alternately, a working group can describe the heuristics, conventions, and guidelines for specifying roles. For example, for an instance of a networking system, this property might contain the string "Switch" or "Bridge". This property is inherited from CIM_System.

Status
Data type: string
Access type: Read-only

Current status of the object. This property is inherited from CIM_ManagedSystemElement.

Values include the following:

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

Remarks

The CIM_UnitaryComputerSystem class is derived from CIM_ComputerSystem.

WMI does not implement this class. For WMI classes derived from CIM_UnitaryComputerSystem, see Win32 Classes.

This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.

Examples

For script code examples, see WMI Tasks for Scripts and Applications and the TechNet ScriptCenter Script Repository.

For C++ code examples, see WMI C++ Application Examples.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Namespace

\root\CIMV2

MOF

CIMWin32.mof

DLL

CIMWin32.dll

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.