Share via

CIM_UnitaryComputerSystem class

  • Article

A class derived from CIM_ComputerSystem that represents a desktop, mobile, network PC, server or other type of a single node computer system.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

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

Members

The CIM_UnitaryComputerSystem class has these types of members:

Methods

The CIM_UnitaryComputerSystem class has these methods.

Method Description
SetPowerState SetPowerState method defines the desired power state of a computer system and its running operating system, and when the system should be put into that state. The PowerState parameter is specified as one of the valid integer values defined for the property, PowerState. The Time parameter (for all state changes but 5, "Power Cycle") 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). When the PowerState parameter is equal to 5, "Power Cycle", the Time parameter indicates when the system should power on again. power off is immediate. SetPowerState should return 0 if successful, 1 if the specified power state and time requests are not supported, and some other value if any other error occurred.

Properties

The CIM_UnitaryComputerSystem 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_ManagedSystemElement.

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: CIM_Key, MaxLen (256)

The CreationClassName property 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.

Description

Data type: string

Access type: Read-only

The Description property provides a textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

InitialLoadInfo

Data type: string array

Access type: Read-only

This object contains the data needed to find either the initial load device (its key) or the boot service to request the operating system to start up.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

The InstallDate property is 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.

LastLoadInfo

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("MIB.IETF|HOST-RESOURCES-MIB.hrSystemInitialLoadDevice", "MIB.IETF|HOST-RESOURCES-MIB.hrSystemInitialLoadParameters")

The array entry of the InitialLoadInfo property, that holds the data corresponding to booting the currently loaded operating system.

Name

Data type: string

Access type: Read-only

Qualifiers: Override ("Name"), Key, MaxLen (256)

The inherited Name property serves as key of a CIM_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 CIM_ComputerSystem object and its derivatives are Top Level Objects of CIM. They provide the scope for numerous components. Having unique CIM_System keys is required. A heuristic is defined to create the CIM_ComputerSystem name to attempt to always generate the same name, independent of discovery protocol. This prevents inventory and management problems where the same asset or entity is discovered multiple times, but can not be resolved to a single object. Use of the heuristic is optional, but recommended.

The NameFormat property identifies how the computer system name is generated, using a heuristic. The heuristic is outlined, in detail, in the CIM V2 Common Model specification. It assumes that the documented rules are traversed in order, to determine and assign a name. The NameFormat values list defines the precedence order for assigning the computer system name. Several rules do map to the same Value.

Note that the CIM_ComputerSystem Name 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_ComputerSystem.

("Other")

("IP")

("Dial")

("HID")

("NWA")

("HWA")

("X25")

("ISDN")

("IPX")

("DCC")

("ICD")

("E.164")

("SNA")

("OID/OSI")

PowerManagementCapabilities

Data type: uint16 array

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|System Power Controls|001.2")

Indicates the specific power-related capabilities of a computer system and its associated running operating system. The values, 0="Unknown", 1="Not Supported", and 2="Disabled" are self-explanatory. The value, 3="Enabled" indicates that the power management features are currently enabled but the exact feature set is unknown or the information is unavailable. "Power Saving Modes Entered Automatically" (4) describes that a system can change its power state based on usage or other criteria. "Power State Settable" (5) indicates that the SetPowerState method is supported. "Power Cycling Supported" (6) indicates that the SetPowerState method can be invoked with the PowerState parameter set to 5 ("Power Cycle"). "Timed Power On Supported" (7) indicates that the SetPowerState method can be invoked with the PowerState parameter set to 5 ("Power Cycle") and the Time parameter set to a specific date and time, or interval, for power-on.

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)

PowerManagementSupported

Data type: boolean

Access type: Read-only

Boolean indicating that the computer system, with its running operating system, support power management. This boolean does not indicate that power management features are currently enabled, only that the system is capable of power management.

PowerState

Data type: uint16

Access type: Read-only

Indicates the current power state of the computer system and its associated operating system. Regarding the power saving states, these are defined as follows: Value 4 (Unknown) indicates that the system is known to be in a power save mode, but its exact status in this mode is unknown; 2 (Low Power Mode) indicates that the system is in a power save state but still functioning, and may exhibit degraded performance; 3 (Standby) describes that the system is not functioning but could be brought to full power 'quickly'; and value 7 (Warning) indicates that the computerSystem is in a warning state, though also in a power save mode.

Unknown (0)

Full Power (1)

Power Save - Low Power Mode (2)

Power Save - Standby (3)

Power Save - Unknown (4)

Power Cycle (5)

Power Off (6)

Power Save - Warning (7)

PrimaryOwnerContact

Data type: string

Access type: Read-only

Qualifiers: MaxLen (256), MappingStrings ("MIF.DMTF|General Information|001.3")

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-only

Qualifiers: MaxLen (64), MappingStrings ("MIF.DMTF|General Information|001.4")

The name of the primary system owner.

This property is inherited from CIM_System.

ResetCapability

Data type: uint16

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|System Hardware Security|001.4")

If enabled (value = 4), the unitary computer system 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).

Other (1)

Unknown (2)

Disabled (3)

Enabled (4)

Not Implemented (5)

Roles

Data type: string array

Access type: Read-only

A collection of strings that specify the roles this system plays in the IT-environment.

This property is inherited from CIM_System.

Status

Data type: string

Access type: Read-only

Qualifiers: MaxLen (10)

The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are "OK", "Degraded" and "Pred Fail". "Pred Fail" indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are "Error", "Starting", "Stopping" and "Service". The latter, "Service", could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither "OK" nor in one of the other states.

This property is inherited from CIM_ManagedSystemElement.

("OK")

("Error")

("Degraded")

("Unknown")

("Pred Fail")

("Starting")

("Stopping")

("Service")

Requirements
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2008
Namespace
 Root\MicrosoftNLB
MOF
WlbsProv.mof
DLL
WlbsProv.dll

See also

CIM_ComputerSystem