Document Number: XMP1013

Date: 2011-08-31

Version: 1.0.2m




Example Fan Profile




IMPORTANT: This specification is not a standard. It does not necessarily reflect the views of the DMTF or all of its members. Because this document is a Work in Progress, this specification may still change, perhaps profoundly. This document is available for public review and comment until the stated expiration date.

This document expires on: 2012-02-28.

Target version for DMTF Standard: 1.0.2.

Provide any comments through the DMTF Feedback Portal: http://www.dmtf.org/standards/feedback




Document Type: Specification

Document Status: Work in Progress

Document Language: en-US




Copyright © 2006-2011 Distributed Management Task Force, Inc. (DMTF). All rights reserved.

DMTF is a not-for-profit association of industry members dedicated to promoting enterprise and systems management and interoperability. Members and non-members may reproduce DMTF specifications and documents for uses consistent with this purpose, provided that correct attribution is given. As DMTF specifications may be revised from time to time, the particular version and release date should always be noted.

Implementation of certain elements of this standard or proposed standard may be subject to third party patent rights, including provisional patent rights (herein "patent rights"). DMTF makes no representations to users of the standard as to the existence of such rights, and is not responsible to recognize, disclose, or identify any or all such third party patent right, owners or claimants, nor for any incomplete or inaccurate identification or disclosure of such rights, owners or claimants. DMTF shall have no liability to any party, in any manner or circumstance, under any legal theory whatsoever, for failure to recognize, disclose, or identify any such third party patent rights, or for such party's reliance on the standard or incorporation thereof in its product, protocols or testing procedures. DMTF shall have no liability to any party implementing such standard, whether such implementation is foreseeable or not, nor to any patent owner or claimant, and shall have no liability or responsibility for costs or losses incurred if a standard is withdrawn or modified after publication, and shall be indemnified and held harmless by any party implementing the standard from any and all claims of infringement by a patent owner for such implementations.

For information about patents held by third-parties which have notified the DMTF that, in their opinion, such patent may relate to or impact implementations of DMTF standards, visit http://www.dmtf.org/about/policies/disclosures.php.

CONTENTS

[Insert table of contents here ...]

Figures

[Insert table of figures here ...]

Tables

[Insert table of tables here ...]

Foreword

This document was prepared by the Physical Platform Profiles Working Group and Server Management Working Group.

DMTF is a not-for-profit association of industry members dedicated to promoting enterprise and systems management and interoperability.

Design Note: This document contains design notes (like this one), that provide information about the way the document is written, or to demonstrate certain things. Such design notes would not appear in a released version of this document.

Design Note: This document represents DSP1013 (Fan Profile) version 1.0.1 plus some additions as a machine readable profile. Since machine readable profiles need to be compliant to DSP1001 1.1, this document utilizes the newly introduced concepts, such as adaptations, features and collaboration diagrams. Relative to DSP1013 1.0, this machine readable profile adds the following, in order to demonstrate its use:

  1. The use of standard messages defined in DSP8016 and DSP8007 as error messages, in the RequestStateChange() method of the Fan adaptation.
  2. The use of standard metrics defined in an assumed metric registry DSPsamr, in two variants: (1) The definition of a metric 'Metric1' directly on the Fan adaptation, demonstrating the most simple approach to defining metrics; (2) The definition of a metric 'Metric2' on a metric definition represented by the FanMetricDefinition adaptation, demonstrating the more flexible approach of defining a metric using a metric definition. In both variants, the metrics are represented using the base metric model defined in DSP1053 (Base Metrics Profile).
  3. The use of alert indications, demonstrating the most simple approach to defining alert indications as defined in DSP1001 1.1 and DSP1054 1.2.

Acknowledgements

DMTF acknowledges the following individuals for their contributions to this document:

Document conventions

Any text in this document is in normal text font, with the following exceptions:

Format definitions in this document are specified using ABNF (see RFC5234), with the following deviations:

Scope

The Fan Profile extends the management capabilities of referencing profiles by adding the capability to represent fans for manageability and describe redundant fans. The fan as a logical device is modeled as referencing the fan physical package for physical asset information, a sensor for sensor reading information, and the profile registration for the schema implementation version information.

Normative references

The following referenced documents are indispensable for the application of this document. For dated or versioned references, only the edition cited (including any corrigenda or DMTF update versions) applies. For undated and unversioned references, the latest published edition of the referenced document (including any corrigenda or DMTF update versions) applies.

DMTF DSP0004, CIM Infrastructure Specification 2.5,
http://www.dmtf.org/standards/published_documents/DSP0004_2.5.pdf

DMTF DSP0223, Generic Operations 1.0,
http://www.dmtf.org/standards/published_documents/DSP0223_1.0.pdf

DMTF DSP1001, Management Profile Specification Usage Guide 1.1,
http://www.dmtf.org/standards/published_documents/DSP1001_1.1.pdf

DMTF XMP1009, Example Sensors Profile (sample profile in DSP2023) 1.0,
http://www.dmtf.org/standards/published_documents/DSP2023_1.0.zip

DMTF XMP1011, Example Physical Asset Profile (sample profile in DSP2023) 1.0,
http://www.dmtf.org/standards/published_documents/DSP2023_1.0.zip

DMTF XMP1033, Example Profile Registration Profile (sample profile in DSP2023) 1.0,
http://www.dmtf.org/standards/published_documents/DSP2023_1.0.zip

DMTF DSP1053, Base Metric Profile 1.1,
http://www.dmtf.org/standards/published_documents/DSP1053_1.1.pdf

DMTF DSP1054, Indications Profile 1.2,
http://www.dmtf.org/standards/published_documents/DSP1054_1.2.pdf

DMTF DSP8016, WBEM Operations Message Registry 1.0,
http://schemas.dmtf.org/wbem/messageregistry/1/dsp8016_1.0.xml

DMTF DSP8007, Platform Message Registry 1.0,
http://schemas.dmtf.org/wbem/messageregistry/1/dsp8007_1.0.xml

DMTF DSPsamr, Sample Metric Registry 1.0,
dspsamr_1.0.xml

IETF RFC5234, Augmented BNF for Syntax Specifications: ABNF, 2008-01,
http://tools.ietf.org/html/rfc5234

ISO/IEC Directives, Part 2, Rules for the structure and drafting of International Standards,
http://isotc.iso.org/livelink/livelink?func=ll&objId=4230456&objAction=browse&sort=subtype

Terms and definitions

In this document, some terms have a specific meaning beyond the normal English meaning. Those terms are defined in this clause.

General

The terms "shall" ("required"), "shall not", "should" ("recommended"), "should not" ("not recommended"), "may", "need not" ("not required"), "can" and "cannot" in this document are to be interpreted as described in ISO/IEC Directives, Part2, Annex H. The terms in parenthesis are alternatives for the preceding term, for use in exceptional cases when the preceding term cannot be used for linguistic reasons. Note that ISO/IEC Directives, Part2, Annex H specifies additional alternatives. Occurrences of such additional alternatives shall be interpreted in their normal English meaning in this document.

The terms "clause", "subclause", "paragraph", "annex" in this document are to be interpreted as described in ISO/IEC Directives, Part2, Clause 5.

The terms "normative" and "informative" in this document are to be interpreted as described in ISO/IEC Directives, Part2, Clause 3. In this document, clauses, subclauses or annexes indicated with "(informative)" as well as notes and examples do not contain normative content.

The terms defined in DSP0004, DSP0223, and DSP1001 apply to this document.

The following additional terms are defined in this document.

fan

A device that provides thermal cooling by air flow to system elements.

redundant fan

A fan that is participating in a redundant set of fans.

spare fan

A fan that is not currently used, but is available for use in situations where currently used fans are no longer used for some reason.

Symbols and abbreviated terms

This clause defines the symbols and abbreviations used in this document.

The abbreviations defined in DSP0004, DSP0223, and DSP1001 apply to this document.

This document does not define any additional abbreviations.

Synopsis

Profile name:  Example Fan

Version:  1.0.2

Organization:  DMTF

Abstract indicator:  False

Profile type:  Component

Schema:  DMTF CIM 2.19

Central class adaptation:   Fan

Scoping class adaptation:   ComputerSystem

Scoping path:   SystemDevice

The Example Fan profile extends the management capabilities of referencing profiles by adding the capability to represent fans as logical devices, to monitor and control the state and speed of fans, to represent the relationship to elements cooled by fans, and to represent redundant fans as a redundancy group. Optionally, the Sensors profile can be implemented for fan speed sensors (SpeedSensors profile reference). Optionally, the Physical Asset profile can be implemented for fans (PhysicalAsset profile reference).

The following table identifies the profile references defined in this profile.

Profile references
Profile reference nameProfile nameOrgani​zationVersionRelation​shipDescription
PhysicalAsset Example Physical AssetDMTF1.0Optional
Used to represent the physical packaging of fans.
SpeedSensors Example SensorsDMTF1.0Conditional
Used to represent fan speed sensors.

Condition:

The FanSpeedSensor feature is implemented.
PRP Profile RegistrationDMTF1.0Mandatory
Used to represent the implementation of this profile.
Indications IndicationsDMTF1.2Mandatory
Used for the indications defined by this profile.
BaseMetric Base MetricDMTF1.1Mandatory
Used for the metrics defined by this profile.

The following table identifies the message registry references defined in this profile.

Message registry references
Registry reference nameRegistry IDOrganizationVersionDescription
WBEMOperations DSP8016DMTF1.0
Platform DSP8007DMTF1.0

The following table identifies the metric registry references defined in this profile.

Metric registry references
Registry reference nameRegistry IDOrganizationVersionDescription
Sample DSPsamrDMTF1.0

The following table identifies the features defined in this profile.

Features
FeatureRequire​mentDescription
FanRedundancyByBalancingOptionalSee subclause "Feature: FanRedundancyByBalancing".
FanRedundancyBySparingOptionalSee subclause "Feature: FanRedundancyBySparing".
FanSpeedSensorConditionalSee subclause "Feature: FanSpeedSensor".
PhysicalAssetDescriptionOptionalSee subclause "Feature: PhysicalAssetDescription".
PartialCoolingConditionalSee subclause "Feature: PartialCooling".
FanCapabilitiesOptionalSee subclause "Feature: FanCapabilities".
FanElementNameModificationOptionalSee subclause "Feature: FanElementNameModification".
FanStateManagementOptionalSee subclause "Feature: FanStateManagement".
SettingFanSpeedOptionalSee subclause "Feature: SettingFanSpeed".
FanIndicationsOptionalSee subclause "Feature: FanIndications".

The following table identifies the class adaptations defined in this profile.

Adaptations
AdaptationElementsRequire​mentDescription
Instantiated, embedded and abstract adaptations
ComputerSystemCIM_ComputerSystemMandatorySee subclause "Adaptation: ComputerSystem".
SystemDeviceCIM_SystemDeviceMandatorySee subclause "Adaptation: SystemDevice".
FanMetricDefinitionCIM_BaseMetricDefinitionOptionalSee subclause "Adaptation: FanMetricDefinition".
FanCIM_FanMandatorySee subclause "Adaptation: Fan".
FanCapabilitiesCIM_EnabledLogicalElementCapabilitiesConditionalSee subclause "Adaptation: FanCapabilities".
ElementCapabilitiesCIM_ElementCapabilitiesConditionalSee subclause "Adaptation: ElementCapabilities".
CooledElementCIM_ManagedSystemElementConditionalSee subclause "Adaptation: CooledElement".
AssociatedCoolingCIM_AssociatedCoolingConditionalSee subclause "Adaptation: AssociatedCooling".
FanRedundancySetCIM_RedundancySetConditionalSee subclause "Adaptation: FanRedundancySet".
OwningCollectionElementCIM_OwningCollectionElementConditionalSee subclause "Adaptation: OwningCollectionElement".
HostedRedundancySetCIM_HostedCollectionConditionalSee subclause "Adaptation: HostedRedundancySet".
MemberOfRedundancySetCIM_MemberOfCollectionConditionalSee subclause "Adaptation: MemberOfRedundancySet".
IsSpareCIM_IsSpareConditionalSee subclause "Adaptation: IsSpare".
NumericFanSpeedSensorCIM_NumericSensorConditionalSee subclause "Adaptation: NumericFanSpeedSensor".
DiscreteFanSpeedSensorCIM_SensorConditionalSee subclause "Adaptation: DiscreteFanSpeedSensor".
FanSpeedAlertIndicationFilterCIM_IndicationFilterConditionalSee subclause "Adaptation: FanSpeedAlertIndicationFilter".
FanAddedLifecycleIndicationFilterCIM_IndicationFilterConditionalSee subclause "Adaptation: FanAddedLifecycleIndicationFilter".
Indications and exceptions
FanAddedIndicationCIM_InstCreationConditionalSee subclause "Adaptation: FanAddedIndication".
FanRemovedIndicationCIM_InstDeletionConditionalSee subclause "Adaptation: FanRemovedIndication".
FanHealthIndicationCIM_AlertIndicationConditionalSee subclause "Adaptation: FanHealthIndication".
FanRedundancyIndicationCIM_AlertIndicationConditionalSee subclause "Adaptation: FanRedundancyIndication".

The following table identifies the use cases and state descriptions defined in this profile.

Use cases and state descriptions
NameDescription
State description ObjectDiagramSee subclause "State description: ObjectDiagram".
Use case SetFanSpeedSee subclause "Use case: SetFanSpeed".
Use case ResetFanSee subclause "Use case: ResetFan".
Use case GetFanRedundancyStatusSee subclause "Use case: GetFanRedundancyStatus".
Use case FindSpareFanSee subclause "Use case: FindSpareFan".
Use case ShowFanSensorInfoSee subclause "Use case: ShowFanSensorInfo".
Use case FindCooledElementsSee subclause "Use case: FindCooledElements".
Use case DetermineElementNameModifiabilitySee subclause "Use case: DetermineElementNameModifiability".

Description

DMTF collaboration structure diagram

The logical aspect of fans in the managed environment is represented by instances of the Fan adaptation. The system hosting the fans is represented by an associated ComputerSystem instance.

The capability to support the representation of fan redundancy can be added by implementing the FanRedundancyBySparing or FanRedundancyByBalancing features, which are mutually exclusive for a given fan. If one of these features is implemented for a fan, each redundancy group this fan is a member of is represented by an associated FanRedundancySet instance.

The capability to support the sensoring of the fan speed can be added by implementing the FanSpeedSensor feature for a fan, using the SpeedSensors profile.

The capability to expose physical asset information for a fan can be added by implementing the PhysicalAssetDescription feature for the fan, using the PhysicalAsset profile.

The capability to provide cooling only to specific elements of the system instead of the whole system can be added by implementing the PartialCooling feature. If it is implemented for a fan, the system element to which the fan provides cooling is represented by an associated CooledElement instance. If it is not implemented for a fan, the fan provides cooling to the entire system that hosts the fan.

The capability to expose the capabilities of a fan can be added by implementing the FanCapabilities feature. If it is implemented for a fan, its capabilities are represented by an associated FanCapabilities instance. Note that FanCapabilities instances can be shared between multiple Fan instances.

Conformance of an implementation to this profile is represented through the PRP profile.

Implementation

Features

Feature: FanRedundancyByBalancing

The implementation of this feature for a fan provides the ability to represent that a fan is redundant within a redundancy group of fans, such that all fans in the group run at the same time, balancing the cooling load between them. If one of these fan fails, the others remain running to provide cooling.

The requirement level for this feature is optional.

This feature can be made available to clients at the granularity of Fan instances.

It can be concluded that the feature is available for a Fan instance if:

Otherwise, it can be concluded that the feature is not available.

The following profile elements are conditional or conditional exclusive on the implementation of this feature:

Feature: FanRedundancyBySparing

The implementation of this feature for a fan provides the ability to represent that a fan is redundant within a redundancy group of fans, such that some fans in the group run at the same time, balancing the cooling load between them, and some others do not normally run and act as spare fans. If one of the normally running fans fails, the other normally running fans remain running to provide cooling; and additional spare fans may be started to accomodate for the cooling capacity of the failed fan(s).

The requirement level for this feature is optional.

This feature can be made available to clients at the granularity of Fan instances.

It can be concluded that the feature is available for a Fan instance if:

Otherwise, it can be concluded that the feature is not available.

The following profile elements are conditional or conditional exclusive on the implementation of this feature:

Feature: FanSpeedSensor

This feature provides the ability to expose the speed of fans that have a speed sensor.

The requirement level for this feature is conditional, with the following condition:

The feature should be implemented for fans that have a speed sensor.

This feature can be made available to clients at the granularity of Fan instances.

It can be concluded that the feature is available for a Fan instance if:

Otherwise, it can be concluded that the feature is not available.

The following profile elements are conditional or conditional exclusive on the implementation of this feature:

Feature: PhysicalAssetDescription

This feature provides support for describing physical asset information of a fan.

The requirement level for this feature is optional.

This feature can be made available to clients at the granularity of an implementation of this profile.

It can be concluded that the feature is available if:

Otherwise, it can be concluded that the feature is not available.

Feature: PartialCooling

The implementation of this feature for a fan allows representing that the fan provides cooling to a subset of the elements in a system, instead of to the entire system.

The requirement level for this feature is conditional, with the following condition:

The feature shall be implemented for a fan if the fan provides cooling to a subset of the elements in the system. The feature shall not be implemented for a fan if the fan provides cooling to the entire system.

This feature can be made available to clients at the granularity of Fan instances.

It can be concluded that the feature is available for a Fan instance if:

Otherwise, it can be concluded that the feature is not available.

The following profile elements are conditional or conditional exclusive on the implementation of this feature:

Feature: FanCapabilities

This feature allows a fan to expose its capabilities through an FanCapabilities instance.

The requirement level for this feature is optional.

This feature can be made available to clients at the granularity of Fan instances.

It can be concluded that the feature is available for a Fan instance if:

Otherwise, it can be concluded that the feature is not available.

The following profile elements are conditional or conditional exclusive on the implementation of this feature:

Feature: FanElementNameModification

This feature provides support for client modification of the CIM_Fan.ElementName property of a fan.

The requirement level for this feature is optional.

This feature can be made available to clients at the granularity of Fan instances.

It can be concluded that the feature is available for a Fan instance if:

Otherwise, it can be concluded that the feature is not available.

The following profile elements are conditional or conditional exclusive on the implementation of this feature:

Feature: FanStateManagement

This feature provides support for client management of the state of a fan.

The requirement level for this feature is optional.

This feature can be made available to clients at the granularity of Fan instances.

It can be concluded that the feature is available for a Fan instance if:

Otherwise, it can be concluded that the feature is not available.

The following profile elements are conditional or conditional exclusive on the implementation of this feature:

Feature: SettingFanSpeed

This feature provides support for setting the speed of a fan, via the CIM_Fan.SetSpeed() method.

The requirement level for this feature is optional.

This feature can be made available to clients at the granularity of Fan instances.

Availability of this feature cannot be discovered by clients (other than trying the functionality provided by the feature).

The following profile elements are conditional or conditional exclusive on the implementation of this feature:

Feature: FanIndications

Design Note: This feature has been defined to demonstrate the grouping of indication implementation decisions under one point of decision; this features is not part of DSP1013 1.0. Note, a profile is free to define more granular features for indications, or to define indications without usage of any feature for grouping purposes.

This feature provides support for indications related to a fan.

The requirement level for this feature is optional.

This feature can be made available to clients at the granularity of an implementation of this profile.

Availability of this feature cannot be discovered by clients (other than trying the functionality provided by the feature).

The following profile elements are conditional or conditional exclusive on the implementation of this feature:

Adaptations

Conventions

This profile defines operation requirements based on DSP0223.

For adaptations of ordinary classes and of associations the requirements for operations are defined in adaptation-specific subclauses of the "Adaptations" clause.

For association traversal operation requirements that are specified only in the elements table of an adaptation (i.e. without operation-specific subclauses), the names of the association adaptations to be traversed are listed in the elements table.

The default initialization requirement level for property requirements is optional.

The default modification requirement level for property requirements is optional.

This profile repeats the effective values of certain Boolean qualifiers as part of property, method parameter, or method return value requirements. The following convention is established: If the name of a qualifier is listed, its effective value is True; if the qualifier name is not listed, its effective value is False. The convention is applied in the following cases:

Adaptation: ComputerSystem: CIM_ComputerSystem

This adaptation does not define a model description.

The implementation type of this adaptation is instantiated ordinary adaptation.

The requirement level for this adaptation is mandatory.

The following table identifies the element requirements for this adaptation.

ComputerSystem: Element requirements
ElementRequire​mentDescription
Operations
GetAssociatedInstancesWithPath( ) for HostedRedundancySet and othersMandatorySee subclause "Operation: GetAssociatedInstancesWithPath( ) for HostedRedundancySet".
GetAssociatedInstancePaths( ) for HostedRedundancySet and othersMandatorySee subclause "Operation: GetAssociatedInstancePaths( ) for HostedRedundancySet".
GetReferencingInstancesWithPath( ) for HostedRedundancySet and othersMandatorySee subclause "Operation: GetReferencingInstancesWithPath( ) for HostedRedundancySet".
GetReferencingInstancePaths( ) for HostedRedundancySet and othersMandatorySee subclause "Operation: GetReferencingInstancePaths( ) for HostedRedundancySet".

Adaptation: SystemDevice: CIM_SystemDevice

General

This adaptation does not define a model description.

The implementation type of this adaptation is instantiated association adaptation.

The requirement level for this adaptation is mandatory.

The following table identifies the element requirements for this adaptation.

SystemDevice: Element requirements
ElementRequire​mentDescription
Properties
GroupComponentMandatoryKey, see subclause "Property: GroupComponent".
PartComponentMandatoryKey, see subclause "Property: PartComponent".
Operations
GetInstance( )MandatorySee DSP0223.

Property: GroupComponent

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraints for this reference property:

Property: PartComponent

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraints for this reference property:

Adaptation: FanMetricDefinition: CIM_BaseMetricDefinition

Design Note: This adaptation has been defined to demonstrate the definition of metrics through a metric definition; it is not part of DSP1013 1.0.

This adaptation models metric definitions for fans.

The implementation type of this adaptation is instantiated ordinary adaptation.

The requirement level for this adaptation is optional.

The following table identifies the element requirements for this adaptation.

FanMetricDefinition: Element requirements
ElementRequire​mentDescription
Base adaptations
BaseMetric::BaseMetricDefinitionOptionalSee BaseMetric::BaseMetricDefinition.
Metrics
Sample::Metric1OptionalSample metric #1

Adaptation: Fan: CIM_Fan

General

This adaptation models fans in the managed environment.

Design Note: This adaptation defines an additional base adaptation 'MonitoredElement' and a metric 'Metric2' to demonstrate the definition of metrics; this is not part of DSP1013 1.0.

Each fan in the managed environment should be represented by a Fan instance.

The implementation type of this adaptation is instantiated ordinary adaptation.

The requirement level for this adaptation is mandatory.

The implementation shall satisfy the following constraints for this adaptation:

The following table identifies the element requirements for this adaptation.

Fan: Element requirements
ElementRequire​mentDescription
Base adaptations
SpeedSensors::SensoredElementOptionalSee SpeedSensors::SensoredElement.
PhysicalAsset::PackagedElementOptionalSee PhysicalAsset::PackagedElement.
BaseMetric::MonitoredElementOptionalSee BaseMetric::MonitoredElement.
Metrics
Sample::Metric2OptionalSample metric #2
Properties
SystemCreationClassNameMandatoryKey, see schema definition.
SystemNameMandatoryKey, see schema definition.
CreationClassNameMandatoryKey, see schema definition.
DeviceIDMandatoryKey, see schema definition.
OperationalStatusMandatorySee schema definition.
HealthStateMandatorySee schema definition.
VariableSpeedMandatorySee schema definition.
DesiredSpeedMandatorySee subclause "Property: DesiredSpeed".
ActiveCoolingMandatorySee subclause "Property: ActiveCooling".
EnabledStateMandatorySee subclause "Property: EnabledState".
RequestedStateMandatorySee subclause "Property: RequestedState".
ElementNameMandatorySee subclause "Property: ElementName".
Methods
RequestStateChange( )ConditionalSee subclause "Method: RequestStateChange( )".
SetSpeed( )ConditionalSee subclause "Method: SetSpeed( )".
Operations
GetInstance( )MandatorySee subclause "Operation: GetInstance( )".
GetClassInstancesWithPath( )MandatorySee DSP0223.
GetClassInstancePaths( )MandatorySee DSP0223.
ModifyInstance( )ConditionalSee subclause "Operation: ModifyInstance( )".
GetAssociatedInstancesWithPath( ) for AssociatedCooling and othersMandatorySee subclause "Operation: GetAssociatedInstancesWithPath( ) for AssociatedCooling".
GetAssociatedInstancePaths( ) for AssociatedCooling and othersMandatorySee subclause "Operation: GetAssociatedInstancePaths( ) for AssociatedCooling".
GetReferencingInstancesWithPath( ) for AssociatedCooling and othersMandatorySee subclause "Operation: GetReferencingInstancesWithPath( ) for AssociatedCooling".
GetReferencingInstancePaths( ) for AssociatedCooling and othersMandatorySee subclause "Operation: GetReferencingInstancePaths( ) for AssociatedCooling".

Property: DesiredSpeed

The presentation requirement level for this property is mandatory.

If setting the fan speed is supported, the meaning of the value 0 is that no change in fan speed has been requested.

If setting the fan speed is not supported, the value of this property is meaningless.

The implementation shall satisfy the following constraints for this property:

Property: ActiveCooling

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraint for this property:

OCL constraint with context of a Fan instance:

inv:
self.ActiveCooling = True

Explanation:

ActiveCooling shall match True.

Property: EnabledState

The presentation requirement level for this property is mandatory.

The following table describes the mapping between the EnabledState property values and the corresponding description of the state of the fan.

EnabledState Value Description
Value Description Extended Description
2 Enabled The fan shall be turned on.
3 Disabled The fan shall be turned off.
5 Not Applicable The fan state is indeterminate, or fan state management is not supported.

The value of the EnabledState property may change as the result of a change to the fan's enabled state by a non-CIM implementation.

Property: RequestedState

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraints for this property:

Property: ElementName

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraint for this property:

OCL constraint with context of a Fan instance:

inv:
self.ElementCapabilities.Capabilities.
    ElementNameEditSupported = True
implies
    self.ElementName.isModifiable()

Explanation:

The ElementName property shall be modifiable when the ElementNameEditSupported property of the CIM_EnabledLogicalElementCapabilities instance that is associated with the CIM_Fan instance has a value of True.

Method: RequestStateChange( )

The requirement level for this method is conditional, with the following condition:

The FanStateManagement feature is implemented.

Design Note: This method defines error reporting requirements based on standard messages. It represents the error situations 'method not supported' and 'timeout' as errors, instead of as return values as defined in DSP1013 1.0.

If feature 'fan state management' is supported, the method shall be implemented.

When the RequestStateChange() method does not complete successfully and the fan is in an indeterminate state, the EnabledState property shall have a value of 5 (Not Applicable).

Invocation of the RequestStateChange() method changes the fan's state to the value specified in the RequestedState parameter.

Invoking this method multiple times may result in earlier requests being overwritten or lost.

The implementation shall satisfy the following constraints for this method:

The following table identifies the parameter and return value requirements of the method.

RequestStateChange( ): Parameter requirements
ParameterDescription
RequestedStateIn, see subclause "Parameter: RequestedState".
JobOut, see subclause "Parameter: Job".
TimeoutPeriodIn, see subclause "Parameter: TimeoutPeriod".
ReturnValueSee subclause "Return value".

The following table specifies the error reporting requirements of the RequestStateChange( ) method. These requirements apply in addition to those defined in DSP0223 for the operation that invokes this method.

RequestStateChange( ): Error reporting requirements
Reporting mechanismRequirement levelDescription
WBEMOperations::WIPG0208,
Platform::PLAT9001
Mandatory

The requested state is not supported for the fan.

Design Note: The messages are:

  • WIPG0208: Invalid input parameter value
  • PLAT9001(example): Requested state not supported for the element
WBEMOperations::WIPG0208,
Platform::PLAT9002
Mandatory

A non-Null value for the Timeout parameter is not supported.

Design Note: The messages are:

  • WIPG0208: Invalid input parameter value
  • PLAT9002(example): Timeout not supported for the method
WBEMOperations::WIPG0219Mandatory

Method is not implemented.

Note: This error situation and its reporting through this message is defined already in DSP0223. This error situation is listed in this table only because it was reported through a return value in earlier versions of this profile.

Design Note: The messages are:

  • WIPG0219: Method not supported by class implementation
WBEMOperations::WIPG0227,
Platform::PLAT9003
Mandatory

Fan cannot be disabled due to excessive temperature. The detail text of WIPG0227 should be omitted or should indicate that the next message details the error.

Design Note: The messages are:

  • WIPG0227: Other failure
  • PLAT9003(example): Fan cannot be disabled due to excessive temperature
WBEMOperations::WIPG0227Mandatory

Any other failure. As defined in WIPG0227, the failure shall be described in its detail text.

Note: This error situation and its reporting through this message is defined already in DSP0223. This error situation is listed in this table only because it was reported through a return value in earlier versions of this profile.

Design Note: The messages are:

  • WIPG0227: Other failure
CIM_ERR_SERVER_LIMITS_EXCEEDEDMandatory

More element changes are under way than the configured limit of concurrent changes, or there is a resource shortage in the WBEM server.

Design Note: This error situation demonstrates the possibility of mixing the usage of CIM status codes and messages. It is not recommended to define such a mixed usage in a single profile, but it may happen in merged profiles.

Parameter: RequestedState
For valid values, see method constraints.
Parameter: Job
A non-Null instance path is returned if a job was started. If no job was started, Null is returned.

The implementation shall satisfy the following constraint for this reference parameter:

Referenced instances shall be of class adaptation ConcreteJobProfile Error: A class adaptation "ConcreteJob" is referenced in a class adaptation link but is not defined or is defined more than once in this profile..

Parameter: TimeoutPeriod

Client-specified maximum amount of time the transition to a new state is supposed to take:

Return value

This method shall return one of the following return values:

RequestStateChange: Return values
Value Description
0 The state change was successfully performed.
1 The method is not implemented.
2 An error has occurred.
4096 The request to change the state is being executed asynchronously, and the Job parameter references a ConcreteJobProfile Error: A class adaptation "ConcreteJob" is referenced in a class adaptation link but is not defined or is defined more than once in this profile. instance representing the request.

Method: SetSpeed( )

The requirement level for this method is conditional, with the following condition:

The SettingFanSpeed feature is implemented.
If the feature is not supported, the method shall not be implemented or shall return a value of 1 (Not Supported).

The SetSpeed() method requests that the speed of the fan represented by CIM_Fan be set to the value specified in the method's DesiredSpeed input parameter.

The implementation shall satisfy the following constraints for this method:

The following table identifies the parameter and return value requirements of the method.

SetSpeed( ): Parameter requirements
ParameterDescription
DesiredSpeedIn, see subclause "Parameter: DesiredSpeed".
ReturnValueSee subclause "Return value".
Parameter: DesiredSpeed

The parameter shall be specified in a unit of RPMs (revolutions per minute)

Return value

This method shall return one of the following return values:

SetSpeed: Return values
Value Description
0 The speed change was successfully performed.
1 The method is not implemented.
2 An error has occurred. Note, the meaning of this value differs from the definition in the CIM schema.
 

Operation: GetInstance( )

For general requirements on the implementation of this operation, see DSP0223.

The requirement level for this operation is mandatory.

The following table specifies the error reporting requirements of the GetInstance( ) operation. These requirements apply in addition to those defined in DSP0223 for this operation.

GetInstance( ): Error reporting requirements
Reporting mechanismRequirement levelDescription
WBEMOperations::WIPG0209,
Platform::PLAT1234
Mandatory
 

Operation: ModifyInstance( )

For general requirements on the implementation of this operation, see DSP0223.

The requirement level for this operation is conditional, with the following condition:

The FanElementNameModification feature is implemented.

The implementation shall satisfy the following constraints for this operation:

 
 
 
 
 

Operation: GetAssociatedInstancesWithPath( ) for AssociatedCooling and others

For general requirements on the implementation of this operation, see DSP0223.

The requirement level for this operation is mandatory.

This operation requirement applies when traversing the following association adaptations:

 
 
 
 
 

Operation: GetAssociatedInstancePaths( ) for AssociatedCooling and others

For general requirements on the implementation of this operation, see DSP0223.

The requirement level for this operation is mandatory.

This operation requirement applies when traversing the following association adaptations:

 
 
 
 
 

Operation: GetReferencingInstancesWithPath( ) for AssociatedCooling and others

For general requirements on the implementation of this operation, see DSP0223.

The requirement level for this operation is mandatory.

This operation requirement applies when traversing the following association adaptations:

 
 
 
 
 

Operation: GetReferencingInstancePaths( ) for AssociatedCooling and others

For general requirements on the implementation of this operation, see DSP0223.

The requirement level for this operation is mandatory.

This operation requirement applies when traversing the following association adaptations:

Adaptation: FanCapabilities: CIM_EnabledLogicalElementCapabilities

General

This adaptation models the capabilities of fans modeled with Fan.

The implementation type of this adaptation is instantiated ordinary adaptation.

The requirement level for this adaptation is conditional, with the following condition:

The FanCapabilities feature is implemented.

The following table identifies the element requirements for this adaptation.

FanCapabilities: Element requirements
ElementRequire​mentDescription
Properties
InstanceIDMandatoryKey, see schema definition.
RequestedStatesSupportedMandatorySee subclause "Property: RequestedStatesSupported".
ElementNameEditSupportedMandatorySee subclause "Property: ElementNameEditSupported".
MaxElementNameLenConditionalSee subclause "Property: MaxElementNameLen".
Operations
GetInstance( )MandatorySee DSP0223.
GetClassInstancesWithPath( )MandatorySee DSP0223.
GetClassInstancePaths( )MandatorySee DSP0223.
GetAssociatedInstancesWithPath( ) for ElementCapabilitiesMandatorySee DSP0223.
GetAssociatedInstancePaths( ) for ElementCapabilitiesMandatorySee DSP0223.
GetReferencingInstancesWithPath( ) for ElementCapabilitiesMandatorySee DSP0223.
GetReferencingInstancePaths( ) for ElementCapabilitiesMandatorySee DSP0223.

Property: RequestedStatesSupported

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraint for this property:

OCL constraint with context of a FanCapabilities instance:

inv:
if mrpIsFeatureSupported('fan ElementName modification',
    self.cIM_ElementCapabilities.Element)
then self.RequestedStatesSupported =
    Set { 2 /* Enabled */, 3 /* Disabled */, 11 /* Reset */ } )
else self.RequestedStatesSupported->isEmpty() )

Explanation:

If feature 'fan ElementName modification' is supported, the RequestedStatesSupported array property shall contain any combination of the values: 2 (Enabled), 3 (Disabled), 11 (Reset). If feature 'fan ElementName modification' is not supported, the RequestedStatesSupported property shall be an empty array.

Property: ElementNameEditSupported

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraint for this property:

OCL constraint with context of a FanCapabilities instance:

inv:
mrpIsFeatureSupported('fan ElementName modification',
    self.cIM_ElementCapabilities.Element)
implies
        self.ElementNameEditSupported = True

Explanation:

If client modification of the CIM_Fan.ElementName property is supported, the ElementNameEditSupported property shall have a value of True.

Property: MaxElementNameLen

The presentation requirement level for this property is conditional, with the following condition:

The FanElementNameModification feature is implemented.

Adaptation: ElementCapabilities: CIM_ElementCapabilities

General

This adaptation does not define a model description.

The implementation type of this adaptation is instantiated association adaptation.

The requirement level for this adaptation is conditional, with the following condition:

The FanCapabilities feature is implemented.

The following table identifies the element requirements for this adaptation.

ElementCapabilities: Element requirements
ElementRequire​mentDescription
Properties
ManagedElementMandatoryKey, see subclause "Property: ManagedElement".
CapabilitiesMandatoryKey, see subclause "Property: Capabilities".
Operations
GetInstance( )MandatorySee DSP0223.

Property: ManagedElement

The presentation requirement level for this property is mandatory.

Shall reference an instance of CIM_Fan representing the fan.

The implementation shall satisfy the following constraints for this reference property:

Property: Capabilities

The presentation requirement level for this property is mandatory.

Shall reference an instance of CIM_EnabledLogicalElementCapabilities that describes the capabilities of CIM_Fan.

The implementation shall satisfy the following constraints for this reference property:

Adaptation: CooledElement: CIM_ManagedSystemElement

This adaptation does not define a model description.

The implementation type of this adaptation is instantiated ordinary adaptation.

A concrete subclass of the abstract schema class CIM_ManagedSystemElement needs to be implemented.

The requirement level for this adaptation is conditional, with the following condition:

The PartialCooling feature is implemented.

The following table identifies the element requirements for this adaptation.

CooledElement: Element requirements
ElementRequire​mentDescription
Operations
GetAssociatedInstancesWithPath( ) for AssociatedCoolingMandatorySee DSP0223.
GetAssociatedInstancePaths( ) for AssociatedCoolingMandatorySee DSP0223.
GetReferencingInstancesWithPath( ) for AssociatedCoolingMandatorySee DSP0223.
GetReferencingInstancePaths( ) for AssociatedCoolingMandatorySee DSP0223.

Adaptation: AssociatedCooling: CIM_AssociatedCooling

General

This adaptation does not define a model description.

The managed system element for which the fan provides cooling is represented by the CIM_Fan instance that is associated with a CIM_ManagedSystemElement subclass instance through the CIM_AssociatedCooling association. When no instance of CIM_AssociatedCooling references the instance of CIM_Fan, the fan represented by CIM_Fan cools the whole managed system represented by the CIM_System instance associated with the CIM_Fan instance via CIM_SystemDevice. When at least one instance of CIM_AssociatedCooling references the instance of CIM_Fan, the elements cooled by the fan shall be only those referenced by the CIM_AssociatedCooling association and not the whole managed system.

The implementation type of this adaptation is instantiated association adaptation.

The requirement level for this adaptation is conditional, with the following condition:

The PartialCooling feature is implemented.

The following table identifies the element requirements for this adaptation.

AssociatedCooling: Element requirements
ElementRequire​mentDescription
Properties
AntecedentMandatoryKey, see subclause "Property: Antecedent".
DependentMandatoryKey, see subclause "Property: Dependent".
Operations
GetInstance( )MandatorySee DSP0223.

Property: Antecedent

The presentation requirement level for this property is mandatory.

Shall reference an instance of CIM_Fan representing the fan.

The implementation shall satisfy the following constraints for this reference property:

Property: Dependent

The presentation requirement level for this property is mandatory.

Shall reference an instance of a subclass of CIM_ManagedSystemElement for which the fan is providing cooling.

The implementation shall satisfy the following constraints for this reference property:

Adaptation: FanRedundancySet: CIM_RedundancySet

General

This adaptation models fan redundancy groups for which the feature 'fan redundancy' is implemented.

The implementation type of this adaptation is instantiated ordinary adaptation.

The requirement level for this adaptation is conditional, with the following condition:

At least one of the following is true:

The following table identifies the element requirements for this adaptation.

FanRedundancySet: Element requirements
ElementRequire​mentDescription
Properties
InstanceIDMandatoryKey, see schema definition.
RedundancyStatusMandatorySee schema definition.
TypeOfSetMandatorySee subclause "Property: TypeOfSet".
MinNumberNeededMandatorySee subclause "Property: MinNumberNeeded".
ElementNameMandatorySee subclause "Property: ElementName".
Methods
Failover( )OptionalSee subclause "Method: Failover( )".
Operations
GetInstance( )MandatorySee DSP0223.
GetClassInstancesWithPath( )MandatorySee DSP0223.
GetClassInstancePaths( )MandatorySee DSP0223.
GetAssociatedInstancesWithPath( ) for HostedRedundancySet and othersMandatorySee subclause "Operation: GetAssociatedInstancesWithPath( ) for HostedRedundancySet".
GetAssociatedInstancePaths( ) for HostedRedundancySet and othersMandatorySee subclause "Operation: GetAssociatedInstancePaths( ) for HostedRedundancySet".
GetReferencingInstancesWithPath( ) for HostedRedundancySet and othersMandatorySee subclause "Operation: GetReferencingInstancesWithPath( ) for HostedRedundancySet".
GetReferencingInstancePaths( ) for HostedRedundancySet and othersMandatorySee subclause "Operation: GetReferencingInstancePaths( ) for HostedRedundancySet".

Property: TypeOfSet

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraints for this property:

Property: MinNumberNeeded

The presentation requirement level for this property is mandatory.

Shall match 0 when the minimum number of fans needed for the redundancy is unknown.

Property: ElementName

The presentation requirement level for this property is mandatory.

Shall be formatted as a free-form string of variable length, using the pattern ".*".

Method: Failover( )

The requirement level for this method is optional.

The Failover() method forces a failover from one member of a CIM_RedundancySet collection to another. After the successful execution of the method, the fan that is represented by the CIM_Fan instance referenced by the FailoverFrom parameter becomes inactive. The fan that is represented by the CIM_Fan instance referenced by the FailoverTo parameter takes over as the active fan.

The Failover() method may be supported if the FailoverSupported property of at least one instance of CIM_IsSpare that references the CIM_RedundancySet instance has a value of 3 (Manual) or 4 (Both Manual and Automatic). The Failover() method shall not be supported if the FailoverSupported property of every instance of CIM_IsSpare that references the CIM_RedundancySet has a value of 2 (Automatic).

The execution of the Failover() method shall return a value of 2 (Error Occurred) under the following conditions:

After the successful execution of the Failover() method, the following actions occur:

The following table identifies the parameter and return value requirements of the method.

Failover( ): Parameter requirements
ParameterDescription
FailoverFromIn, see subclause "Parameter: FailoverFrom".
FailoverToIn, see subclause "Parameter: FailoverTo".
ReturnValueSee subclause "Return value".
Parameter: FailoverFrom

The redundant fan that will become inactive.

The implementation shall satisfy the following constraint for this reference parameter:

Referenced instances shall be of class adaptation Fan.

Parameter: FailoverTo

The redundant fan that will become active and take over for the inactivated fan.

The implementation shall satisfy the following constraint for this reference parameter:

Referenced instances shall be of class adaptation Fan.

Return value

This method shall return one of the following return values:

Failover: Return values
Value Description
0 The failover was successfully performed.
1 The method is not implemented.
2 An error has occurred.
 
 
 
 

Operation: GetAssociatedInstancesWithPath( ) for HostedRedundancySet and others

For general requirements on the implementation of this operation, see DSP0223.

The requirement level for this operation is mandatory.

This operation requirement applies when traversing the following association adaptations:

 
 
 
 

Operation: GetAssociatedInstancePaths( ) for HostedRedundancySet and others

For general requirements on the implementation of this operation, see DSP0223.

The requirement level for this operation is mandatory.

This operation requirement applies when traversing the following association adaptations:

 
 
 
 

Operation: GetReferencingInstancesWithPath( ) for HostedRedundancySet and others

For general requirements on the implementation of this operation, see DSP0223.

The requirement level for this operation is mandatory.

This operation requirement applies when traversing the following association adaptations:

 
 
 
 

Operation: GetReferencingInstancePaths( ) for HostedRedundancySet and others

For general requirements on the implementation of this operation, see DSP0223.

The requirement level for this operation is mandatory.

This operation requirement applies when traversing the following association adaptations:

Adaptation: OwningCollectionElement: CIM_OwningCollectionElement

General

This adaptation does not define a model description.

The implementation type of this adaptation is instantiated association adaptation.

The requirement level for this adaptation is conditional, with the following condition:

At least one of the following is true:

The following table identifies the element requirements for this adaptation.

OwningCollectionElement: Element requirements
ElementRequire​mentDescription
Properties
OwningElementMandatoryKey, see subclause "Property: OwningElement".
OwnedElementMandatoryKey, see subclause "Property: OwnedElement".
Operations
GetInstance( )MandatorySee DSP0223.

Property: OwningElement

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraints for this reference property:

Property: OwnedElement

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraints for this reference property:

Adaptation: HostedRedundancySet: CIM_HostedCollection

General

This adaptation does not define a model description.

The implementation type of this adaptation is instantiated association adaptation.

The requirement level for this adaptation is conditional, with the following condition:

At least one of the following is true:

The following table identifies the element requirements for this adaptation.

HostedRedundancySet: Element requirements
ElementRequire​mentDescription
Properties
AntecedentMandatoryKey, see subclause "Property: Antecedent".
DependentMandatoryKey, see subclause "Property: Dependent".
Operations
GetInstance( )MandatorySee DSP0223.

Property: Antecedent

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraints for this reference property:

Property: Dependent

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraints for this reference property:

Adaptation: MemberOfRedundancySet: CIM_MemberOfCollection

General

This adaptation does not define a model description.

The implementation type of this adaptation is instantiated association adaptation.

The requirement level for this adaptation is conditional, with the following condition:

At least one of the following is true:

The following table identifies the element requirements for this adaptation.

MemberOfRedundancySet: Element requirements
ElementRequire​mentDescription
Properties
CollectionMandatoryKey, see subclause "Property: Collection".
MemberMandatoryKey, see subclause "Property: Member".
Operations
GetInstance( )MandatorySee DSP0223.

Property: Collection

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraints for this reference property:

Property: Member

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraints for this reference property:

Adaptation: IsSpare: CIM_IsSpare

General

This adaptation models the relationship between spare fans and their redundancy group.

The implementation type of this adaptation is instantiated association adaptation.

The requirement level for this adaptation is conditional, with the following condition:

The FanRedundancyBySparing feature is implemented.

The implementation shall satisfy the following constraints for this adaptation:

The following table identifies the element requirements for this adaptation.

IsSpare: Element requirements
ElementRequire​mentDescription
Properties
AntecedentMandatoryKey, see subclause "Property: Antecedent".
DependentMandatoryKey, see subclause "Property: Dependent".
Operations
GetInstance( )MandatorySee DSP0223.

Property: Antecedent

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraints for this reference property:

Property: Dependent

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraints for this reference property:

Adaptation: NumericFanSpeedSensor: CIM_NumericSensor

General

This adaptation models analog speed sensors.

The implementation type of this adaptation is instantiated ordinary adaptation.

The requirement level for this adaptation is conditional, with the following condition:

The FanSpeedSensor feature is implemented.

Design Note: DSP1013 1.0 defines the requirement level as optional. However, clause 7.10 of DSP1013 1.0 states the condition, so this machine readable profile has consistently defined the requirement level to be conditional.

The following table identifies the element requirements for this adaptation.

NumericFanSpeedSensor: Element requirements
ElementRequire​mentDescription
Base adaptations
SpeedSensors::NumericSensorOptionalSee SpeedSensors::NumericSensor.
Properties
SensorTypeMandatorySee subclause "Property: SensorType".
BaseUnitsMandatorySee subclause "Property: BaseUnits".
RateUnitsMandatorySee subclause "Property: RateUnits".
CurrentReadingMandatorySee schema definition.

Property: SensorType

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraint for this property:

OCL constraint with context of a NumericFanSpeedSensor instance:

inv:
self.SensorType = 5 /* Tachometer */

Explanation:

The value of the SensorType property shall be 5 (Tachometer).

Property: BaseUnits

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraint for this property:

OCL constraint with context of a NumericFanSpeedSensor instance:

inv:
self.BaseUnits = 19 /* RPM */

Explanation:

The value of the BaseUnits property shall be 19 (RPM).

Property: RateUnits

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraint for this property:

OCL constraint with context of a NumericFanSpeedSensor instance:

inv:
self.RateUnits = 0 /* None */

Explanation:

The value of the RateUnits property shall be 0 (None).

Adaptation: DiscreteFanSpeedSensor: CIM_Sensor

General

This adaptation models discrete fan speed sensors.

The implementation type of this adaptation is instantiated ordinary adaptation.

The requirement level for this adaptation is conditional, with the following condition:

The FanSpeedSensor feature is implemented.

Design Note: DSP1013 1.0 defines the requirement level as optional. However, clause 7.10 of DSP1013 1.0 states the condition, so this machine readable profile has consistently defined the requirement level to be conditional.

The following table identifies the element requirements for this adaptation.

DiscreteFanSpeedSensor: Element requirements
ElementRequire​mentDescription
Base adaptations
SpeedSensors::DiscreteSensorOptionalSee SpeedSensors::DiscreteSensor.
Properties
SensorTypeMandatorySee subclause "Property: SensorType".

Property: SensorType

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraint for this property:

OCL constraint with context of a DiscreteFanSpeedSensor instance:

inv:
self.SensorType = 5 /* Tachometer */

Explanation:

The value of the SensorType property shall be 5 (Tachometer).

Adaptation: FanAddedIndication: CIM_InstCreation

This adaptation does not define a model description.

Design Note: This adaptation has been defined to demonstrate the definition of lifecycle indications; it is not part of DSP1013 1.0.

The implementation type of this adaptation is indication.

The requirement level for this adaptation is conditional, with the following condition:

The FanIndications feature is implemented.

The following table identifies the element requirements for this adaptation.

FanAddedIndication: Element requirements
ElementRequire​mentDescription
Base adaptations
Indications::LifecycleIndicationMandatorySee Indications::LifecycleIndication.

Adaptation: FanRemovedIndication: CIM_InstDeletion

This adaptation does not define a model description.

Design Note: This adaptation has been defined to demonstrate the definition of lifecycle indications; it is not part of DSP1013 1.0.

The implementation type of this adaptation is indication.

The requirement level for this adaptation is conditional, with the following condition:

The FanIndications feature is implemented.

The following table identifies the element requirements for this adaptation.

FanRemovedIndication: Element requirements
ElementRequire​mentDescription
Base adaptations
Indications::LifecycleIndicationMandatorySee Indications::LifecycleIndication.

Adaptation: FanHealthIndication: CIM_AlertIndication

This adaptation models alert indications for reporting the health state of fans.

Design Note: This adaptation has been defined to demonstrate the definition of alert indications; it is not part of DSP1013 1.0.

Indications related to the redundancy of fans are defined in the FanRedundancyIndication adaptation.

The implementation type of this adaptation is indication.

The requirement level for this adaptation is conditional, with the following condition:

The FanIndications feature is implemented.

The following table identifies the element requirements for this adaptation.

FanHealthIndication: Element requirements
ElementRequire​mentDescription
Base adaptations
Indications::AlertIndicationMandatorySee Indications::AlertIndication.
Alert messages
Platform::PLAT0458MandatoryFan failed
Platform::PLAT0459MandatoryFan return to OK
Platform::PLAT0460MandatoryFan degraded
Platform::PLAT0462MandatoryFan speed high
Platform::PLAT0463MandatoryFan speed normal

Adaptation: FanRedundancyIndication: CIM_AlertIndication

This adaptation models alert indications related to the redundancy of fans.

Design Note: This adaptation has been defined to demonstrate the definition of alert indications; it is not part of DSP1013 1.0.

The implementation type of this adaptation is indication.

The requirement level for this adaptation is conditional, with the following condition:

All of the following is true:

The following table identifies the element requirements for this adaptation.

FanRedundancyIndication: Element requirements
ElementRequire​mentDescription
Base adaptations
Indications::AlertIndicationMandatorySee Indications::AlertIndication.
Alert messages
Platform::PLAT0452MandatoryFan Redundacy Lost (sufficient)
Platform::PLAT0454MandatoryFan Redundancy Lost (insufficient)
Platform::PLAT0455MandatoryFan Redundancy Restored

Adaptation: FanSpeedAlertIndicationFilter: CIM_IndicationFilter

General

This adaptation does not define a model description.

A static filter for the fan speed related alert indications.

Design Note: This adaptation has been defined to demonstrate the definition of an indication specific (i.e. static) indication filter for certain alert indications; it is not part of DSP1013 1.0.

The implementation type of this adaptation is instantiated ordinary adaptation.

The requirement level for this adaptation is conditional, with the following condition:

The FanIndications feature is implemented.

The following table identifies the element requirements for this adaptation.

FanSpeedAlertIndicationFilter: Element requirements
ElementRequire​mentDescription
Base adaptations
Indications::IndicationSpecificIndicationFilterMandatorySee Indications::IndicationSpecificIndicationFilter.
Properties
NameMandatoryKey, see subclause "Property: Name".
QueryMandatoryRequired, see subclause "Property: Query".
QueryLanguageMandatoryRequired, see subclause "Property: QueryLanguage".

Property: Name

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraint for this property:

OCL constraint with context of a FanSpeedAlertIndicationFilter instance:

inv: self.Name = 'DMTF:Fan:SpeedAlertIndicationFilter'

Property: Query

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraint for this property:

OCL constraint with context of a FanSpeedAlertIndicationFilter instance:

inv: self.Query = 'SELECT * FROM CIM_AlertIndication WHERE MessageID IN ( "PLAT0462", "PLAT0463")'

Property: QueryLanguage

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraint for this property:

OCL constraint with context of a FanSpeedAlertIndicationFilter instance:

inv: self.QueryLanguage = 'DMTF:CQL'

Adaptation: FanAddedLifecycleIndicationFilter: CIM_IndicationFilter

General

This adaptation does not define a model description.

A static filter for the fan added lifecycle indication.

Design Note: This adaptation has been defined to demonstrate the definition of an indication specific (i.e. static) indication filter for a single lifecycle indication; it is not part of DSP1013 1.0.

The implementation type of this adaptation is instantiated ordinary adaptation.

The requirement level for this adaptation is conditional, with the following condition:

The FanIndications feature is implemented.

The following table identifies the element requirements for this adaptation.

FanAddedLifecycleIndicationFilter: Element requirements
ElementRequire​mentDescription
Base adaptations
Indications::IndicationSpecificIndicationFilterMandatorySee Indications::IndicationSpecificIndicationFilter.
Properties
NameMandatoryKey, see subclause "Property: Name".
QueryMandatoryRequired, see subclause "Property: Query".
QueryLanguageMandatoryRequired, see subclause "Property: QueryLanguage".

Property: Name

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraint for this property:

OCL constraint with context of a FanAddedLifecycleIndicationFilter instance:

inv: self.Name = 'DMTF:Fan:AddedLifecycleIndicationFilter'

Property: Query

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraint for this property:

OCL constraint with context of a FanAddedLifecycleIndicationFilter instance:

inv: self.Query = 'SELECT * FROM CIM_InstCreation WHERE SourceInstance ISA CIM_Fan'

Property: QueryLanguage

The presentation requirement level for this property is mandatory.

The implementation shall satisfy the following constraint for this property:

OCL constraint with context of a FanAddedLifecycleIndicationFilter instance:

inv: self.QueryLanguage = 'DMTF:CQL'

Use cases and state descriptions

State description: ObjectDiagram

Section 9.1 of Fan Profile (DSP1013) would be inserted here.

Use case: SetFanSpeed

Section 9.2 of Fan Profile (DSP1013) would be inserted here.

The main flow for this use case consists of the following single step:

Use case: ResetFan

Section 9.3 of Fan Profile (DSP1013) would be inserted here.

The main flow for this use case consists of the following single step:

Use case: GetFanRedundancyStatus

Section 9.4 of Fan Profile (DSP1013) would be inserted here.

The main flow for this use case consists of the following single step:

Use case: FindSpareFan

Section 9.5 of Fan Profile (DSP1013) would be inserted here.

The main flow for this use case consists of the following single step:

Use case: ShowFanSensorInfo

Section 9.6 of Fan Profile (DSP1013) would be inserted here.

The main flow for this use case consists of the following single step:

Use case: FindCooledElements

Section 9.7 of Fan Profile (DSP1013) would be inserted here.

The main flow for this use case consists of the following single step:

Use case: DetermineElementNameModifiability

Section 9.8 of Fan Profile (DSP1013) would be inserted here.

The main flow for this use case consists of the following single step:


(informative)

Change log

Change log
VersionDateDescription
1.0.0a2006-06-13DSP1013: Released as a Preliminary Standard
1.0.02007-10-12DSP1013: Released as a Final Standard
1.0.12008-09-23DSP1013: Released as a Final Standard
1.0.2m2011-08-31XMP1013: Included as a sample profile into DSP2023

Bibliography

This clause lists references that are helpful for the application of this document.

DMTF DSP1000, Management Profile Specification Template 1.1,
http://www.dmtf.org/standards/published_documents/DSP1000_1.1.pdf