Class CIM_ComputerSystem

Used in features: Hardware Asset

CIM_ManagedElement
   extended by CIM_ManagedSystemElement
      extended by CIM_LogicalElement
         extended by CIM_EnabledLogicalElement
            extended by CIM_System
               extended by CIM_ComputerSystem

Known Subclasses:
Also see:
CIM_AdminDomain


class CIM_ComputerSystem
extends CIM_System

General Information:
A class derived from System that is a special collection of ManagedSystemElements. This collection is related to the providing of compute capabilities and MAY serve as an aggregation point to associate one or more of the following elements: FileSystem, OperatingSystem, Processor and Memory (Volatile and/or NonVolatile Storage).

Product Specific Usage:
Used to model a system which aggregates services and properties.

AMT has two ComputerSystems:
- ManagedSystem, representing the host computer system
- AMT, representing the AMT system itself.

Qualifiers:
-------------
Version=2.16.0
UMLPackagePath=CIM::System::SystemElements


Supported Fields Summary
 string Name Key
The inherited Name serves as key of a System instance in an enterprise environment.
 string CreationClassName Key
CreationClassName indicates the name of the class or the subclass used in the creation of an instance . . .
 string ElementName
A user-friendly name for the object . . .
 uint16[2] OperationalStatus
Indicates the current statuses of the element . . .
 uint16 HealthState
Indicates the current health of the element . . .
 uint16 EnabledState
EnabledState is an integer enumeration that indicates the enabled and disabled states of an element . . .
 uint16 RequestedState
RequestedState is an integer enumeration that indicates the last requested or desired state for the element . . .
 uint16 EnabledDefault
An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element . . .
 string NameFormat
The ComputerSystem object and its derivatives are Top Level Objects of CIM . . .
 uint16[2] Dedicated
Enumeration indicating the purpose(s) to which the ComputerSystem is dedicated, if any, and what functionality is provided . . .

Methods Summary
  Get(Instance)
Gets the representation of the instance
  Pull(EnumerationContext, MaxElements)
Pulls instances of this class, following an Enumerate operation
  Enumerate()
Enumerates the instances of this class
  Release(EnumerationContext)
Releases an enumeration context

Field Detail

Name Key

public string Name
General Information:
The inherited Name serves as key of a System instance in an enterprise environment.

Qualifiers:
-------------
Key
Override=Name
MaxLen=64


CreationClassName Key

public string CreationClassName
General Information:
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.

Qualifiers:
-------------
Key
MaxLen=64


ElementName

public string ElementName
General Information:
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 the Name property of ManagedSystemElement 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 can be present in both the Name and ElementName properties.

Qualifiers:
-------------
MaxLen=64


OperationalStatus

public uint16[2] OperationalStatus
General Information:
Indicates the current statuses 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 here in more detail.
"Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, and so on.
"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 state and configuration of the element might need to be updated.
"Dormant" indicates that the element is inactive or quiesced.
"Supporting Entity in Error" indicates that this element might 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 that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error).
"Power Mode" indicates that 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 because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or 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 (because it is single-valued) should also provide the primary status of the element.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, .., 0x8000..}
Values={Unknown, Other, OK, Degraded, Stressed, Predictive Failure, Error, Non-Recoverable Error, Starting, Stopping, Stopped, In Service, No Contact, Lost Communication, Aborted, Dormant, Supporting Entity in Error, Completed, Power Mode, DMTF Reserved, Vendor Reserved}
ArrayType=Indexed
ModelCorrespondence={CIM_ManagedSystemElement.StatusDescriptions}


HealthState

public uint16 HealthState
General Information:
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 completely 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 might not be possible.
"Major Failure" (20) - The element is failing. It is possible that some or all of the functionality of this component is degraded or not working.
"Minor Failure" (15) - All functionality is available but some might 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 might not be operating at optimal performance or it might 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 cannot report on HealthState at this time.
DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.

Product Specific Usage:
HealthState
i. HealthState = 5 ("OK") when system is in H0 health state
ii. HealthState = 20 ("Major failure") when system is in H1 health state
iii. HealthState = 25 ("Critical failure") when system is in H2 health state
iv. HealthState = 30 ("Non-recoverable error") when system is in H3 health state


Qualifiers:
-------------
ValueMap={0, 5, 10, 15, 20, 25, 30, ..}
Values={Unknown, OK, Degraded/Warning, Minor failure, Major failure, Critical failure, Non-recoverable error, DMTF Reserved}


EnabledState

public uint16 EnabledState
General Information:
EnabledState is an integer enumeration that 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. The following text briefly summarizes the various enabled and disabled states:
Enabled (2) indicates that the element is or could be executing commands, will process any queued commands, and queues new requests.
Disabled (3) indicates that the element will not execute commands and will drop any new requests.
Shutting Down (4) indicates that the element is in the process of going to a Disabled state.
Not Applicable (5) indicates the element does not support being enabled or disabled.
Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests.
Test (7) indicates that the element is in a test state.
Deferred (8) indicates that the element might be completing commands, but will queue any new requests.
Quiesce (9) indicates that the element is enabled but in a restricted mode.
Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.

Product Specific Usage:
synchronized with CIM_AssociatedPowerManagementService.PowerState
i. 2 (Enabled) in S0
ii. 3 (Disabled) in S5
iii. Current value of 5 (Not Applicable) is used for all other S states


Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11..32767, 32768..65535}
Values={Unknown, Other, Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.OtherEnabledState}


RequestedState

public uint16 RequestedState
General Information:
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.
Offline (6) indicates that the element has been requested to transition to the Enabled but Offline EnabledState.
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 Start 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 EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ("Not Applicable") is used.

Qualifiers:
-------------
ValueMap={2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, .., 32768..65535}
Values={Enabled, Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot, Reset, Not Applicable, DMTF Reserved, Vendor Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.EnabledState}


EnabledDefault

public uint16 EnabledDefault
General Information:
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).

Qualifiers:
-------------
Write
ValueMap={2, 3, 5, 6, 7, 9, .., 32768..65535}
Values={Enabled, Disabled, Not Applicable, Enabled but Offline, No Default, Quiesce, DMTF Reserved, Vendor Reserved}


NameFormat

public string NameFormat
General Information:
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.

Qualifiers:
-------------
Override=NameFormat
ValueMap={Other, IP, Dial, HID, NWA, HWA, X25, ISDN, IPX, DCC, ICD, E.164, SNA, OID/OSI, WWN, NAA}
MaxLen=64


Dedicated

public uint16[2] Dedicated
General Information:
Enumeration indicating the purpose(s) to which the ComputerSystem is dedicated, if any, and what functionality is provided. For example, one could specify that the System is dedicated to "Print" (value=11) or acts as a "Hub" (value=8).
Also, one could indicate that this is a general purpose system by indicating 'Not Dedicated' (value=0) but that it also hosts 'Print' (value=11) or mobile phone 'Mobile User Device' (value=17) services.
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.
A value of "Management" indicates this instance is dedicated to hosting system management software.
A value of "Management Controller" indicates this instance represents specialized hardware dedicated to systems management (i.e., a Baseboard Management Controller (BMC) or service processor).
The management scope of a "Management Controller" is typically a single managed system in which it is contained.
A value of "Chassis Manager" indicates this instance represents a system dedicated to management of a blade chassis and its contained devices. This value would be used to represent a Shelf Controller. A "Chassis Manager" is an aggregation point for management and may rely on subordinate management controllers for the management of constituent parts. A value of "Host-based RAID Controller" indicates this instance represents a RAID storage controller contained within a host computer. A value of "Storage Device Enclosure" indicates this instance represents an enclosure that contains storage devices. A "Virtual Tape Library" is the emulation of a tape library by a Virtual Library System. A "Virtual Library System" uses disk storage to emulate tape libraries.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36..32567, 32568..65535}
Values={Not Dedicated, Unknown, Other, Storage, Router, Switch, Layer 3 Switch, Central Office Switch, Hub, Access Server, Firewall, Print, I/O, Web Caching, Management, Block Server, File Server, Mobile User Device, Repeater, Bridge/Extender, Gateway, Storage Virtualizer, Media Library, ExtenderNode, NAS Head, Self-contained NAS, UPS, IP Phone, Management Controller, Chassis Manager, Host-based RAID controller, Storage Device Enclosure, Desktop, Laptop, Virtual Tape Library, Virtual Library System, DMTF Reserved, Vendor Reserved}
ArrayType=Indexed
MappingStrings={MIB.IETF|MIB-II.sysServices, FC-GS.INCITS-T11 | Platform | PlatformType}
ModelCorrespondence={CIM_ComputerSystem.OtherDedicatedDescriptions}


Method Detail

Get

public  Get([OUT]CIM_ComputerSystem Instance)
Permission Information:
This method is accessible from any realm

General Information:
Gets the representation of the instance

Product Specific Usage:
Additional Notes:
1) 'Get' method in 'ME 3.0' is permitted only to the following realms:
- 'ADMIN_SECURITY_SOLIDER_REALM'
- 'ADMIN_SECURITY_REMOTE_CONTROL_REALM'
- 'ADMIN_SECURITY_STORAGE_ADMIN_REALM'
- 'ADMIN_SECURITY_CIRCUIT_BREAKER_REALM'
- 'ADMIN_SECURITY_FW_UPDATE_REALM'
- 'ADMIN_SECURITY_EAC_REALM'
- 'ADMIN_SECURITY_EAC_ADMIN_REALM'
- 'ADMIN_SECURITY_EIT_REALM'
- 'ADMIN_SECURITY_NETWORK_TIME_REALM'
- 'ADMIN_SECURITY_AGENT_PRESENCE_LOCAL_REALM'
- 'ADMIN_SECURITY_STORAGE_REALM'
- 'ADMIN_SECURITY_ADMINISTRATION_REALM'
- 'ADMIN_SECURITY_HARDWARE_ASSET_REALM'
- 'ADMIN_SECURITY_EVENT_MANAGER_REALM'
- 'ADMIN_SECURITY_AGENT_PRESENCE_REMOTE_REALM'
- 'ADMIN_SECURITY_GENERAL_INFO_REALM'
- 'ADMIN_SECURITY_LOCAL_APPS_REALM'

Pull

public  Pull([IN]String EnumerationContext, [IN]String MaxElements)
Permission Information:
All users permitted to use method, only instances to whom the user has permissions will be returned

General Information:
Pulls instances of this class, following an Enumerate operation

Enumerate

public  Enumerate()
Permission Information:
All users permitted to use method

General Information:
Enumerates the instances of this class

Release

public  Release([IN]String EnumerationContext)
Permission Information:
All users permitted to use method

General Information:
Releases an enumeration context