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

[Provider("IPMIPrv"), Dynamic]class ComputerSystem : CIM_ComputerSystem
{
  string   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  string   Name;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  uint16   EnabledState;
  string   OtherEnabledState;
  uint16   RequestedState;
  uint16   EnabledDefault;
  datetime TimeOfLastStateChange;
  string   CreationClassName;
  string   Name;
  string   PrimaryOwnerName;
  string   PrimaryOwnerContact;
  string   Roles[];
  string   NameFormat;
  string   OtherIdentifyingInfo[];
  string   IdentifyingDescriptions[];
  uint16   Dedicated[];
  string   OtherDedicatedDescriptions[];
  uint16   ResetCapability;
  uint16   PowerManagementCapabilities[];
};

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) , Dynamic

A short description of the computer system, that is a concatenation of "BMC" and the device ID of the computer system.

Example: "BMC 32". This property is inherited from CIM_ManagedElement.

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

The name of the class used to create the ComputerSystem instance.

Fixed value: "ComputerSystem". This property is inherited from CIM_System.

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

An array that indicates whether the computer system is a special purpose system dedicated to one type of specific task.

Fixed value: "14—Management". This property is inherited from CIM_ComputerSystem.

This property contains one of the following values:

ValueMeaning
0

Not Dedicated

1

Unknown

2

Other

3

Storage

4

Router

5

Switch

6

Layer 3 Switch

7

Central Office Switch

8

Hub

9

Access Server

10

Firewall

11

Print

12

I/O

13

Web Caching

14

Management

15

Block Server

16

File Server

17

Mobile User Device

18

Repeater

19

Bridge/Extender

20

Gateway

21

Virtual Storage

22

Media Library

23

Extender Node

24

NAS Head

25

Self-contained NAS

26

UPS

27

IP Phone

28–32567

DMTF Reserved

32568–65535

Vendor Reserved

 

Description
Data type: string
Access type: Read-only

A description of the computer system, that is a concatenation of the following values:

  • BMC device ID
  • IPMI version
  • BMC firmware revision
  • BMC auxiliary firmware revision

Example: "BMC 32 - IPMI v1.5 - fw v0.30.0.0.0.0"

This property is inherited from CIM_ManagedElement.

ElementName
Data type: string
Access type: Read-only

The user-friendly name of the computer system, that is a concatenation of "IPMI Controller" and the device ID of the computer system.

Example: "IPMI Controller 32".

This property is inherited from CIM_ManagedElement.

EnabledDefault
Data type: uint16
Access type: Write-only

Indicates the default startup configuration for the EnabledState property.

Default value: "2". This property is inherited from CIM_EnabledLogicalElement.

This property contains one of the following values:

ValueMeaning
2

Enabled

3

Disabled

5

Not Applicable

6

Enabled but Offline

7

No Default

8

Quiesce

9–32767

DMTF Reserved

32768–65535

Vendor Reserved

 

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

Indicates whether the computer system is enabled or in another related state.

Default value: "5" (not applicable). This property is inherited from CIM_EnabledLogicalElement.

This property contains one of the following values:

ValueMeaning
0

Unknown

1

Other

2

Enabled

3

Disabled

4

Shutting Down

5

Not Applicable

6

Enabled but Offline

7

In Test

8

Deferred

9

Quiesce

10

Starting

11–32767

DMTF Reserved

32768–65535

Vendor Reserved

 

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

Indicates the current health of the computer system.

This property is inherited from CIM_ManagedSystemElement.

This property contains one of the following values:

ValueMeaning
0

Unknown

5

OK

10

Degraded/Warning

15

Minor failure

20

Major failure

25

Critical failure

30

Non-recoverable error

31–32767

DMTF Reserved

32768–65535

Vendor Specific

 

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

An array of strings that describes the information in the OtherIdentifying info array. Each array item in IdentifyingDescriptions describes the information of the corresponding array item in OtherIdentifying.

Fixed value: "Manufacturer ID—". This property is inherited from CIM_ComputerSystem.

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

The datetime value that indicates when the computer system was installed.

This property is inherited from CIM_ManagedSystemElement.

Name
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (1024)

The label of the computer system. This property value can contain the same value as the UserID property.

This property is inherited from CIM_ManagedSystemElement.

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

The user-friendly name of the computer system. This property contains the same value as the ElementName property.

Fixed value: "Management Access Point (MAP) Addressing Root". This property is inherited from CIM_System.

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

A string that defines of how the Name property is generated.

Fixed value: "Other". This property is inherited from CIM_ComputerSystem.

This property contains one of the following values:

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)

An array that contains the operational status of the computer system.

This property is inherited from CIM_ManagedSystemElement.

This property can contain the following values:

ValueMeaning
0

Unknown

1

Other

2

OK

3

Degraded

4

Stressed

5

Predictive Failure

6

Error

7

Non-Recoverable Error

8

Starting

9

Stopping

10

Stopped

11

In Service

12

No Contact

13

Lost Communication

14

Aborted

15

Dormant

16

Supporting Entity in Error

17

Completed

18

Power Mode

19

DMTF Reserved

20

Vendor Reserved

 

OtherDedicatedDescriptions
Data type: string array
Access type: Read-only
Qualifiers: ArrayType (Indexed) , ModelCorrespondence (CIM_ComputerSystem.Dedicated)

An array that contains a description of the Dedicated property when Dedicated contains the value "2" (other).

This property is inherited from CIM_ComputerSystem.

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

Describes the value of the EnabledState property when EnabledState is set to "1" (other).

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)

An array that contains additional information that identifies the computer system, other than the system name. This value is a concatenation of the BMC manufacturer ID (found in device ID response byte 8-10) and BMC product ID (found in device ID response byte 11-12).

Example: 11102-12345. 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)

Note  This property is deprecated and should not be used.

An array that describes the power management capabilities of the computer system.

This property is inherited from CIM_ComputerSystem.

ValueMeaning
0

Unknown

1

Not Supported

2

Disabled

3

Enabled

4

Power Saving Modes Entered Automatically

5

Power State Configurable

6

Power Cycling Supported

7

Timed Power On Supported

 

PrimaryOwnerContact
Data type: string
Access type: Write-only
Qualifiers: MaxLen (256) , MappingStrings (MIF.DMTF|General Information|001.4)

A set of contact information of the primary system owner.

This property is inherited from CIM_System.

PrimaryOwnerName
Data type: string
Access type: Write-only
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 computer system.

This property is inherited from CIM_System.

RequestedState
Data type: uint16
Access type: Read-only

Indicates the last requested state of the computer system. The actual state of the computer system is represented by the EnabledState property.

Default value: "12".

This property is inherited from CIM_EnabledLogicalElement.

This property contains one of the following values:

ValueMeaning
2

Enabled

3

Disabled

4

Shut Down

5

No Change

6

Offline

7

Test

8

Deferred

9

Quiesce

10

Reboot

11

Reset

12

Not Applicable

13–32767

DMTF Reserved

32768–65535

Vendor Reserved

 

ResetCapability
Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings (MIF.DMTF|System Hardware Security|001.4)

Indicates whether a hardware reset of the computer system is allowed. The default value is "3" (disabled).

This property is inherited from CIM_ComputerSystem.

This property contains one of the following values:

ValueMeaning
1

Other

2

Unknown

3

Disabled

4

Enabled

5

Not Implemented

 

Roles
Data type: string array
Access type: Write-only

An array of strings that contains the administrator defined roles of the computer system in a managed environment.

Fixed value: "Hardware Management Controller". This property is inherited from CIM_System.

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

Note  This property is deprecated. Instead, use OperationalStatus.

The status of the computer system.

This property is inherited from CIM_ManagedSystemElement.

This property contains one of the following values:

ValueMeaning
OK

The computer system is functioning without errors.

Error

The computer system experienced an error.

Degraded

The computer system is functioning but some features are turned off.

Unknown

The status of the computer system is unknown.

Pred Fail

The computer system experienced a predictive failure.

Starting

The computer system is being started.

Stopping

The computer system is being shut down.

Service

The computer system is being serviced.

Stressed

The computer system is having performance issues.

NonRecover

The computer system has an error and cannot recover.

No Contact

There is no contact with the computer system.

Lost Comm

Communication with the computer system has been lost.

Stopped

The computer system is not running, however, it might be possible to restart the computer system.

 

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

An array of strings that describe the details of the corresponding array values in the OperationalStatus property.

This property is inherited from CIM_ManagedSystemElement.

TimeOfLastStateChange
Data type: datetime
Access type: Read-only

The datetime of the last change to the value of the EnabledState property.

This property is inherited from CIM_EnabledLogicalElement.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2003 R2

Namespace

\root\hardware

MOF

IpmiPrv.mof

DLL

IpmiPrv.dll

See also

IPMI Provider
ComputerSystem

 

 

Show:
© 2014 Microsoft