Share via


CIM_ComputerSystem class

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

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

Syntax

[Abstract, UUID("{DB2EBD10-5113-44a1-96E6-52A4FB4210E1}"), AMENDMENT]
class CIM_ComputerSystem : CIM_System
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Status;
  string   CreationClassName;
  string   Name;
  string   PrimaryOwnerContact;
  string   PrimaryOwnerName;
  string   Roles[];
  string   NameFormat;
  string   OtherIdentifyingInfo[];
  string   IdentifyingDescriptions[];
  uint16   Dedicated[];
};

Members

The CIM_ComputerSystem class has these types of members:

Properties

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

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: CIM_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

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

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)

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.

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 OtherIdentifyingInfo array. Note, each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the same index.

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, 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. A heuristic is defined to create the 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 ComputerSystem Name is generated, using a heuristic. The heuristic is outlined, in detail, in the CIM V2 System Model spec. 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 ComputerSystem Name. Several rules do map to the same Value.

Note that the ComputerSystem Name calculated using the heuristic is the System's key value. Other names can be assigned and used for the ComputerSystem, that better suit a business, using Aliases.

("Other")

("IP")

("Dial")

("HID")

("NWA")

("HWA")

("X25")

("ISDN")

("IPX")

("DCC")

("ICD")

("E.164")

("SNA")

("OID/OSI")

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.

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.

Roles

Data type: string array

Access type: Read-only

An array (bag) of strings that specify the roles this System plays in the IT-environment. Subclasses of System may override this property to define explicit Roles values. Alternately, a Working Group may describe the heuristics, conventions and guidelines for specifying Roles. For example, for an instance of a networking system, the Roles property might contain the string, 'Switch' or 'Bridge'.

This property is inherited from CIM_System.

Status

Data type: string

Access type: Read-only

Qualifiers: MaxLen (10)

A string indicating the current status of the object. Various operational and non-operational statuses are defined. Operational statuses are "OK", "Degraded", "Stressed" and "Pred Fail". "Stressed" indicates that the Element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, etc. The condition "Pred Fail" (failure predicted) indicates that an Element is 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", "NonRecover", "Starting", "Stopping" and "Service". "NonRecover" indicates that a non-recoverable error has occurred. "Service" describes an Element being configured, maintained or cleaned, or otherwise administered. This status could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative task. Not all such work is on-line, yet the 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")

("Stressed")

("NonRecover")

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2008
Namespace
Root\MSCluster
MOF
ClusWMI.mof
DLL
ClusWMI.dll

See also

CIM_System