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_LogicalDevice
   |
   +--CIM_CoolingDevice
   |
   +--CIM_Fan

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringCapabilities and management of a Fan CoolingDevice.
UMLPackagePathstringCIM::Device::CoolingAndPower
Versionstring2.10.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
ControlModeuint16
DescriptionstringControlMode 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.
Experimentalbooleantrue
ModelCorrespondencestringCIM_Fan.ControlModesSupported, CIM_Fan.DesiredControlMode
ValueMapstring0, 2, 3, 4..32767, 32768..65535
ValuesstringUnknown, Automatic, Manual, DMTF Reserved, Vendor Reserved
DesiredControlModeuint16
DescriptionstringDesiredControlMode 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.
Experimentalbooleantrue
ModelCorrespondencestringCIM_Fan.ControlModesSupported
ValueMapstring0, 2, 3, 4..32767, 32768..65535
ValuesstringUnknown, Automatic, Manual, DMTF Reserved, Vendor Reserved
Writebooleantrue
DesiredSpeeduint64
DescriptionstringDesiredSpeed 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.
PUnitstringrevolution / minute
UnitsstringRevolutions per Minute
VariableSpeedboolean
DescriptionstringIndication of whether the fan supports variable speeds.
ControlModesSupporteduint16[]
ArrayTypestringIndexed
DescriptionstringControlModesSupported 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.
Experimentalbooleantrue
ModelCorrespondencestringCIM_Fan.ControlMode, CIM_Fan.DesiredControlMode
ValueMapstring0, 2, 3, 4..32767, 32768..65535
ValuesstringUnknown, Automatic, Manual, DMTF Reserved, Vendor Specified

Inherited Properties

NameData TypeClass Origin
ActiveCoolingbooleanCIM_CoolingDevice
Availabilityuint16CIM_LogicalDevice
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_LogicalDevice
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
DeviceIDstringCIM_LogicalDevice
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
ErrorClearedbooleanCIM_LogicalDevice
ErrorDescriptionstringCIM_LogicalDevice
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LastErrorCodeuint32CIM_LogicalDevice
LocationIndicatoruint16CIM_LogicalDevice
MaxQuiesceTimeuint64CIM_LogicalDevice
NamestringCIM_ManagedSystemElement
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PowerManagementSupportedbooleanCIM_LogicalDevice
PowerOnHoursuint64CIM_LogicalDevice
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StatusstringCIM_ManagedSystemElement
StatusInfouint16CIM_LogicalDevice
SystemCreationClassNamestringCIM_LogicalDevice
SystemNamestringCIM_LogicalDevice
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TotalPowerOnHoursuint64CIM_LogicalDevice
TransitioningToStateuint16CIM_EnabledLogicalElement
AdditionalAvailabilityuint16[]CIM_LogicalDevice
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
IdentifyingDescriptionsstring[]CIM_LogicalDevice
OperationalStatusuint16[]CIM_ManagedSystemElement
OtherIdentifyingInfostring[]CIM_LogicalDevice
PowerManagementCapabilitiesuint16[]CIM_LogicalDevice
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

SetSpeed (uint32)

Method Qualifiers (SetSpeed)

NameData TypeValue
DescriptionstringMethod 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.
ModelCorrespondencestringCIM_Fan.DesiredSpeed
ValueMapstring0, 1, 2, 3, 4..32767, 32768..65535
ValuesstringCompleted with No Errors, Not Supported, Invalid ControlMode for Setting Speed, Invalid Speed, DMTF Reserved, Vendor Reserved

Method Parameters (SetSpeed)

NameTypeQualifiers
NameData TypeValue
DesiredSpeeduint64
DescriptionstringThe desired speed for the fan.
INbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
EnableDeviceuint32CIM_LogicalDevice
OnlineDeviceuint32CIM_LogicalDevice
QuiesceDeviceuint32CIM_LogicalDevice
RequestStateChangeuint32CIM_EnabledLogicalElement
Resetuint32CIM_LogicalDevice
RestorePropertiesuint32CIM_LogicalDevice
SavePropertiesuint32CIM_LogicalDevice
SetPowerStateuint32CIM_LogicalDevice