SUMMARY: NESTED | FIELD | | METHOD
DETAIL: FIELD | METHOD

Class CIM_Fan

Used in features: Hardware Asset
Compatible with the following Intel AMT Releases: 3.0, 3.2, 4.0, 5.0, 5.1, 6.0, 6.1, 6.2, 7.0, 8.0, 8.1, 9.0, 9.5, 10.0, 11.0 
CIM_ManagedElement
   extended by CIM_ManagedSystemElement
      extended by CIM_LogicalElement
         extended by CIM_EnabledLogicalElement
            extended by CIM_LogicalDevice
               extended by CIM_CoolingDevice
                  extended by CIM_Fan


class CIM_Fan
 extends CIM_CoolingDevice


General Information:
Capabilities and management of a Fan 
CoolingDevice.

Product Specific Usage:
In order to distinguish 
between critical and non-critical error the translation of the operationalStatus 
for CIM_Fan will be as follows: 
Value 100b (Non Critical) for the Status 
field in Smbios table 27 is translated to OperationalStatus 6 (Non Critical) 

Value 101b (Critical) for the Status field in Smbios table 27 is translated 
to OperationalStatus 7 (Non recoverable 
error)

Qualifiers:
-------------
Version=2.6.0
UMLPackagePath=CIM::Device::CoolingAndPower









  
  

    Supported Fields 
      Summary

  

     boolean 
      
    ActiveCooling 
      
ActiveCooling is a Boolean that indicates that the Cooling 
      Device provides active (as opposed to passive) cooling.

  

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

  

     uint16[] 
      
    OperationalStatus 
      
Indicates the current statuses of the element . . .

  

     string 
      
    ElementName 
A 
      user-friendly name for the object . . .

  

     string 
      
    SystemCreationClassName Key  
The scoping System's 
      CreationClassName.

  

     string 
      
    SystemName Key  
The scoping System's Name.

  

     string 
      
    CreationClassName Key  
CreationClassName indicates the name 
      of the class or the subclass used in the creation of an instance . . 
    .

  

     string 
      
    DeviceID Key  
An address or other identifying information to 
      uniquely name the LogicalDevice.

  

     boolean 
      
    VariableSpeed 
      
Indication of whether the fan supports variable speeds.

  

     uint64 
      
    DesiredSpeed 
      
DesiredSpeed is the currently requested fan speed, defined in 
      Revolutions per Minute, when a variable speed fan is supported 
      (VariableSpeed boolean = TRUE) . . .




  
  

    Methods Summary

  

     uint32
    SetSpeed(DesiredSpeed) 
      
Requests that the Fan speed be set to the value specified in the 
      method's input parameter . . .

  

     
    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


ActiveCooling 
public boolean ActiveCooling



  
General Information:
ActiveCooling is a Boolean that indicates 
  that the Cooling Device provides active (as opposed to passive) cooling.

  

  





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.

Product Specific Usage:
value of bits 7:5 of 
  "Device Type and Status" field of SMBIOS type 27 structure (Cooling Device), 
  mapped to corresponding HealthState enumeration value 
i. "Device Type and 
  Status"[7:5] = 001b (Other) - HealthState = 0 (Unknown) 
ii. "Device Type 
  and Status"[7:5] = 010b (Unknown) - HealthState = 0 (Unknown) 
iii. "Device 
  Type and Status"[7:5] = 011b (OK) - HealthState = 5 (OK) 
iv. "Device Type 
  and Status"[7:5] = 100b (Non-critical) - HealthState = 15 (Minor failure) 
  
v. "Device Type and Status"[7:5] = 101b (Critical) - HealthState = 25 
  (Critical failure) 
vi. "Device Type and Status"[7:5] = 110b 
  (Non-recoverable) - HealthState = 30 (Non-recoverable error) 
  


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


  

  





OperationalStatus 
public uint16[] 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. 
  
"Relocating" indicates the element is being 
  relocated.
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.

Product Specific Usage:
value corresponding to 
  "Health State" value: 
i. "Device Type and Status"[7:5] = 001b (Other) - 
  OperationalStatus[0] = 0 (Unknown) 
ii. "Device Type and Status"[7:5] = 
  010b (Unknown) - OperationalStatus[0] = 0 (Unknown) 
iii. "Device Type and 
  Status"[7:5] = 011b (OK) - OperationalStatus[0] = 2 (OK) 
iv. "Device Type 
  and Status"[7:5] = 100b (Non-critical) - OperationalStatus[0] = 6 (Error) 
  
v. "Device Type and Status"[7:5] = 101b (Critical) - OperationalStatus[0] 
  = 6 (Error) 
vi. "Device Type and Status"[7:5] = 110b (Non-recoverable) - 
  OperationalStatus[0] = 7 (Non-recoverable 
  error)

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, 
  5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, .., 
  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, Relocating, DMTF Reserved, Vendor 
  Reserved}
ArrayType=Indexed
ModelCorrespondence={CIM_ManagedSystemElement.StatusDescriptions}


  

  





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. Note that if there is an associated instance of 
  CIM_EnabledLogicalElementCapabilities, restrictions on this properties may 
  exist as defined in ElementNameMask and MaxElementNameLen properties defined 
  in that class.

Qualifiers:
-------------
MaxLen=8


  

  





SystemCreationClassName Key 
public string SystemCreationClassName



  
General Information:
The scoping System's 
  CreationClassName.

Qualifiers:
-------------
Key
MaxLen=20
Propagated=CIM_System.CreationClassName


  

  





SystemName Key 
public string SystemName



  
General Information:
The scoping System's 
  Name.

Qualifiers:
-------------
Key
MaxLen=256
Propagated=CIM_System.Name


  

  





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


  

  





DeviceID Key 
public string DeviceID



  
General Information:
An address or other identifying information 
  to uniquely name the LogicalDevice.

Product Specific 
  Usage:
Fan N", where N is the zero-based sequence number of the fan 
  among all fans in the 
  system

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


  

  





VariableSpeed 
public boolean VariableSpeed



  
General Information:
Indication of whether the fan supports 
  variable speeds.

  

  





DesiredSpeed 
public uint64 DesiredSpeed



  
General Information:
DesiredSpeed is the currently requested fan 
  speed, defined in Revolutions per Minute, when a variable speed fan is 
  supported (VariableSpeed boolean = TRUE). The current speed is determined via 
  a sensor (CIM_Tachometer) that is associated with the Fan using the 
  CIM_AssociatedSensor 
  relationship.

Qualifiers:
-------------
Units=Revolutions 
  per Minute


  

  






  
  

    Method 
Detail


SetSpeed
public uint32 SetSpeed([IN]uint64 DesiredSpeed)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM

General 
  Information:
Requests that the Fan speed be set to the value specified 
  in the method's input parameter. The return value should be 0 if the request 
  was successfully executed, 1 if the request is not supported and some other 
  value if an error occurred. In a subclass, the set of possible return codes 
  could be specified, using a ValueMap qualifier on the method. The strings to 
  which the ValueMap contents are 'translated' may also be specified in the 
  subclass as a Values array qualifier.

Product Specific 
  Usage:
Additional Notes: 
1) 'SetSpeed' is enabled in Intel AMT 
  Release 5.1 and later releases. it always return 1 - 'not 
  supported'.

Parameters:
--------------

  

    
DesiredSpeed 
    
General Information:
The desired speed for the 
    fan.

Qualifiers:
-------------
IN







Get
public  Get([OUT]CIM_Fan Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_HARDWARE_ASSET_REALM, 
  ADMIN_SECURITY_GENERAL_INFO_REALM

General Information:
Gets 
  the representation of the instance





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






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

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