Class ME_System

Used in features: Intel(R) ME defined Classes
CIM_ManagedElement
   extended by CIM_ManagedSystemElement
      extended by CIM_LogicalElement
         extended by CIM_EnabledLogicalElement
            extended by CIM_System
               extended by CIM_ComputerSystem
                  extended by ME_System


class ME_System
extends CIM_ComputerSystem

General Information:
A class Representing Intel(R) Manageability Engine (Intel(R) ME) information

Qualifiers:
-------------
Version=0.0.4
dynamic
provider=IntelMEProv


Supported Fields Summary
 string[] OtherDedicatedDescriptions
A string describing how or why the system is dedicated when the Dedicated array includes the value 2, "Other".
 uint16[] Dedicated
Enumeration indicating the purpose(s) to which the ComputerSystem is dedicated, if any, and what functionality is provided . . .
 string NameFormat
The ComputerSystem object and its derivatives are Top Level Objects of CIM . . .
 uint16 EnabledDefault
An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element . . .
 uint16 RequestedState
RequestedState is an integer enumeration that indicates the last requested or desired state for the element, irrespective of the mechanism through which it was requested . . .
 uint16 EnabledState
EnabledState is an integer enumeration that indicates the enabled and disabled states of an element . . .
 uint16 HealthState
Indicates the current health of the element . . .
 string ElementName
A user-friendly name for the object . . .
 string CreationClassName Key
CreationClassName indicates the name of the class or the subclass used in the creation of an instance . . .
 string Name Key
The inherited Name serves as the key of a System instance in an enterprise environment.
 string FWVersion
Intel(R) ME firmware version in format: Major.Minor.Revision.build
 uint32 Capabilities
Capabilities represents the supported features on this system
 uint32 EnabledCapabilities
EnabledCapabilities represents the enabled features on this system
 uint32 PlatformType
PlatformType represents the category the system belongs to
 uint32 UserSegmentType
UserSegmentType represents the market segment the system belongs to
 uint32 ManageabilityMode
ManageabilityMode represents the manageability mode . . .
 boolean CryptoFuseEnabled
Represents the status of the chipset CryptoFuse, when disabled, Intel(R) ME will not perform any encryption operations

Methods Summary
 uint32 getFwUpdateOverrideParams(Counter, OverrideQualifier)
Receives local FW Update counters . . .
 uint32 getLastMEResetReason(ReasonCode)
Returns the cause for the last Intel(R) ME Reset operation
 uint32 getCurrentPowerPolicy(PowerPolicy)
Specifies the list of ACPI states Intel(R) ME is operational in
 uint32 IsFirmwareUpdateEnabled(enabled)
Indicates whether the Firmware Update capability is currently enabled
 uint32 getCapabilities(Capabilities, EnabledCapabilities)
Specifies the list of supported features on this system
  Get(Instance)
Gets the representation of the instance
  Enumerate()
Enumerates the instances of this class

Field Detail

OtherDedicatedDescriptions

public string[] OtherDedicatedDescriptions
General Information:
A string describing how or why the system is dedicated when the Dedicated array includes the value 2, "Other".

Qualifiers:
-------------
ArrayType=Indexed
ModelCorrespondence={CIM_ComputerSystem.Dedicated}
MaxLen=256


Dedicated

public uint16[] 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}


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=256


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}


RequestedState

public uint16 RequestedState
General Information:
RequestedState is an integer enumeration that indicates the last requested or desired state for the element, irrespective of the mechanism through which it was requested. 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. Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration.
"Unknown" (0) indicates the last requested state for the element is unknown.
Note that the value "No Change" (5) has been deprecated in lieu of indicating the last requested state is "Unknown" (0). If the last requested or desired state is unknown, RequestedState should have the value "Unknown" (0), but may have the value "No Change" (5).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.

If knowledge of the last RequestedState is not supported for the EnabledLogicalElement, the property shall be NULL or have the value 12 "Not Applicable".

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


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.

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}


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.

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}


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=256


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=256


Name Key

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

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


FWVersion

public string FWVersion
General Information:
Intel(R) ME firmware version in format: Major.Minor.Revision.build

Qualifiers:
-------------
MaxLen=256


Capabilities

public uint32 Capabilities
General Information:
Capabilities represents the supported features on this system

Qualifiers:
-------------
bitValues={Intel(R) Active Management Technology, NA, NA, Intel(R) Anti-Theft Technology, Intel(R) Upgrade Service, Intel(R) Virtualization Engine, NA, Please Contact Intel For More Details, NA, Intel(R) Integrated Clock Controler, Intel(R) Protected Audio Video Path, NA, NA, NA, IPv6, Keyboard Video Mouse, Please Contact Intel For More Details, NA, Transport Layer Security, Please Contact Intel For More Details, Intel(R) Standard Manageability, Level 3 Manageability Upgrade, Intel(R) Dynamic Application Loader, Intel(R) Small Business Technology}


EnabledCapabilities

public uint32 EnabledCapabilities
General Information:
EnabledCapabilities represents the enabled features on this system

Qualifiers:
-------------
bitValues={Intel(R) Active Management Technology, NA, NA, Intel(R) Anti-Theft Technology, Intel(R) Upgrade Service, Intel(R) Virtualization Engine, NA, Please Contact Intel For More Details, NA, Intel(R) Integrated Clock Controler, Intel(R) Protected Audio Video Path, NA, NA, NA, IPv6, Keyboard Video Mouse, Please Contact Intel For More Details, NA, Transport Layer Security, Please Contact Intel For More Details, Intel(R) Standard Manageability, Level 3 Manageability Upgrade, Intel(R) Dynamic Application Loader, Intel(R) Small Business Technology}


PlatformType

public uint32 PlatformType
General Information:
PlatformType represents the category the system belongs to

Qualifiers:
-------------
ValueMap={0, 1, 2, 3}
Values={Mobile, Desktop, Server, Workstation}


UserSegmentType

public uint32 UserSegmentType
General Information:
UserSegmentType represents the market segment the system belongs to

Qualifiers:
-------------
ValueMap={0, 1}
Values={Corporate, Consumer}


ManageabilityMode

public uint32 ManageabilityMode
General Information:
ManageabilityMode represents the manageability mode. Every mode supports a different set of capabilities

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, 5}
Values={None, Unknown, Intel(R) vPro (TM), Intel(R) Standard Manageability, Level 3 Manageability Upgrade, Intel(R) Small Business Technology}


CryptoFuseEnabled

public boolean CryptoFuseEnabled
General Information:
Represents the status of the chipset CryptoFuse, when disabled, Intel(R) ME will not perform any encryption operations


Method Detail

getFwUpdateOverrideParams

public uint32 getFwUpdateOverrideParams([OUT]uint32 Counter, [OUT]uint32 OverrideQualifier)
Permission Information:
No permissions defined

General Information:
Receives local FW Update counters (In Intel(R) AMT version 7.0 and later this function is not supported and always returns NOT SUPPORTED error)

Qualifiers:
-------------
static
implemented


Parameters:
--------------
Counter
General Information:
FW Update override counter. When 255 refer to always

Qualifiers:
-------------
OUT
ValueMap={0, 1...254, 255}

OverrideQualifier
General Information:
FW Update override qualifier

Qualifiers:
-------------
OUT
ValueMap={0, 1, 2}
Values={ALWAYS, NEVER, RESTRICTED}



getLastMEResetReason

public uint32 getLastMEResetReason([OUT]uint32 ReasonCode)
Permission Information:
No permissions defined

General Information:
Returns the cause for the last Intel(R) ME Reset operation

Qualifiers:
-------------
static
implemented


Parameters:
--------------
ReasonCode
General Information:
A description of the last Intel(R) ME reset reason

Qualifiers:
-------------
OUT
ValueMap={0, 1, 2, 3}
Values={Power-Up, FW-Reset, System-Reset, Unknown}



getCurrentPowerPolicy

public uint32 getCurrentPowerPolicy([OUT]string PowerPolicy)
Permission Information:
No permissions defined

General Information:
Specifies the list of ACPI states Intel(R) ME is operational in

Qualifiers:
-------------
static
implemented


Parameters:
--------------
PowerPolicy
General Information:
A description of the power policy

Qualifiers:
-------------
OUT



IsFirmwareUpdateEnabled

public uint32 IsFirmwareUpdateEnabled([OUT]boolean enabled)
Permission Information:
No permissions defined

General Information:
Indicates whether the Firmware Update capability is currently enabled

Qualifiers:
-------------
static
implemented


Parameters:
--------------
enabled
General Information:


Qualifiers:
-------------
OUT



getCapabilities

public uint32 getCapabilities([OUT]string Capabilities[], [OUT]string EnabledCapabilities[])
Permission Information:
No permissions defined

General Information:
Specifies the list of supported features on this system

Qualifiers:
-------------
static
implemented


Parameters:
--------------
Capabilities
General Information:
An array of strings defining system capabilities. Should match the bitvalues of the system Capabilities

Qualifiers:
-------------
OUT

EnabledCapabilities
General Information:
An array of strings defining system capabilities. Should match the bitvalues of the system Enabled Capabilities

Qualifiers:
-------------
OUT



Get

public  Get([OUT]ME_System Instance)
Permission Information:
No permissions defined

General Information:
Gets the representation of the instance

Enumerate

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

General Information:
Enumerates the instances of this class

Copyright © 2006-2013, Intel Corporation. All rights reserved.