# Class CIM_Fan
extends CIM_CoolingDevice

Capabilities and management of a Fan CoolingDevice.

### Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_ManagedSystemElement
|
+--CIM_LogicalElement
|
+--CIM_EnabledLogicalElement
|
+--CIM_AllocatedLogicalElement
|
+--CIM_LogicalDevice
|
+--CIM_CoolingDevice
|
+--CIM_Fan

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | Capabilities and management of a Fan CoolingDevice.
UMLPackagePath | string | CIM::Device::CoolingAndPower
Version | string | 2.10.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
ControlMode | uint16 |
Description | string | ControlMode indicates the mode in which management of the Fan is operating. When in Manual mode, the SetSpeed method can be used to control the fan speed.
Experimental | boolean | true
ModelCorrespondence | string | CIM_Fan.ControlModesSupported, CIM_Fan.DesiredControlMode
ValueMap | string | 0, 2, 3, 4..32767, 32768..65535
Values | string | Unknown, Automatic, Manual, DMTF Reserved, Vendor Reserved
DesiredControlMode | uint16 |
Description | string | DesiredControlMode is an integer enumeration indicating the last requested or desired control mode for the fan. The actual control mode is represented by ControlMode. The property is provided to compare the last requested and the current control mode. Refer to the ControlMode property Description for explanations of the values in the DesiredControlMode enumeration.
Experimental | boolean | true
ModelCorrespondence | string | CIM_Fan.ControlModesSupported
ValueMap | string | 0, 2, 3, 4..32767, 32768..65535
Values | string | Unknown, Automatic, Manual, DMTF Reserved, Vendor Reserved
Write | boolean | true
DesiredSpeed | uint64 |
Description | string | 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 using a sensor (CIM_Tachometer) that is associated with the Fan using the CIM_AssociatedSensor relationship.
PUnit | string | revolution / minute
Units | string | Revolutions per Minute
VariableSpeed | boolean |
Description | string | Indication of whether the fan supports variable speeds.
ControlModesSupported | uint16[] |
ArrayType | string | Indexed
Description | string | ControlModesSupported indicates the supported control modes of the Fan: automatic or manual. In Automatic mode the Fan is controlled automatically in management function below the CIM. In Manual mode, the fan speed may be controlled by the CIM user by the SetSpeed method. Changing from Automatic to Manual, would not generally cause the speed to change. Changing from Manual to Automatic may cause the fan speed to change depending on the Thermal conditions of the system and the thermal management function.
Experimental | boolean | true
ModelCorrespondence | string | CIM_Fan.ControlMode, CIM_Fan.DesiredControlMode
ValueMap | string | 0, 2, 3, 4..32767, 32768..65535
Values | string | Unknown, Automatic, Manual, DMTF Reserved, Vendor Specified

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
ActiveCooling | boolean | CIM_CoolingDevice
AllocationState | string | CIM_LogicalDevice
Availability | uint16 | CIM_LogicalDevice
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_LogicalDevice
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
DeviceID | string | CIM_LogicalDevice
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
ErrorCleared | boolean | CIM_LogicalDevice
ErrorDescription | string | CIM_LogicalDevice
Generation | uint64 | CIM_ManagedElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
LastErrorCode | uint32 | CIM_LogicalDevice
LocationIndicator | uint16 | CIM_LogicalDevice
MaxQuiesceTime | uint64 | CIM_LogicalDevice
Name | string | CIM_ManagedSystemElement
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
PowerManagementSupported | boolean | CIM_LogicalDevice
PowerOnHours | uint64 | CIM_LogicalDevice
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
Status | string | CIM_ManagedSystemElement
StatusInfo | uint16 | CIM_LogicalDevice
SystemCreationClassName | string | CIM_LogicalDevice
SystemName | string | CIM_LogicalDevice
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TotalPowerOnHours | uint64 | CIM_LogicalDevice
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AdditionalAvailability | uint16[] | CIM_LogicalDevice
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
IdentifyingDescriptions | string[] | CIM_LogicalDevice
OperationalStatus | uint16[] | CIM_ManagedSystemElement
OtherIdentifyingInfo | string[] | CIM_LogicalDevice
PowerManagementCapabilities | uint16[] | CIM_LogicalDevice
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Local Class Methods

#### SetSpeed (uint32)

#### Method Qualifiers (SetSpeed)

Name | Data Type | Value
--- | --- | ---
Description | string | Method that requests that the Fan speed be set to the value specified in the input parameter of the method. The return value should be: 0 if the request was successfully executed 1 if the request is not supported 2 if the request is not valid for the current mode 3 if the requested speed is not currently valid 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' can also be specified in the subclass as a Values array qualifier.
ModelCorrespondence | string | CIM_Fan.DesiredSpeed
ValueMap | string | 0, 1, 2, 3, 4..32767, 32768..65535
Values | string | Completed with No Errors, Not Supported, Invalid ControlMode for Setting Speed, Invalid Speed, DMTF Reserved, Vendor Reserved

#### Method Parameters (SetSpeed)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
DesiredSpeed | uint64
Description | string | The desired speed for the fan.
IN | boolean | true

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
EnableDevice | uint32 | CIM_LogicalDevice
OnlineDevice | uint32 | CIM_LogicalDevice
QuiesceDevice | uint32 | CIM_LogicalDevice
RequestStateChange | uint32 | CIM_EnabledLogicalElement
Reset | uint32 | CIM_LogicalDevice
RestoreProperties | uint32 | CIM_LogicalDevice
SaveProperties | uint32 | CIM_LogicalDevice
SetPowerState | uint32 | CIM_LogicalDevice