# Class CIM_IndicatorLED
extends CIM_LogicalDevice

CIM_IndicatorLED represents an LED of a managed element used to indicate one or more conditions for the managed element. A single discrete package may be represented by one or more instances of CIM_IndicatorLED. There shall be an instance of CIM_IndicatorLED for each IndicatedCondition that may be indicated simultaneously by the discrete package. For example, if a single LED is capable of flashing yellow for one condition and blue for a different one, but the conditions are not indicated simultaneously, it is modeled using a single instance of CIM_IndicatorLED that supports both colors. If the LED indicated both conditions simultaneously, i.e. the package was lit yellow and blue simultaneously, there would be two instances of CIM_IndicatorLED.

### 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_IndicatorLED

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | CIM_IndicatorLED represents an LED of a managed element used to indicate one or more conditions for the managed element. A single discrete package may be represented by one or more instances of CIM_IndicatorLED. There shall be an instance of CIM_IndicatorLED for each IndicatedCondition that may be indicated simultaneously by the discrete package. For example, if a single LED is capable of flashing yellow for one condition and blue for a different one, but the conditions are not indicated simultaneously, it is modeled using a single instance of CIM_IndicatorLED that supports both colors. If the LED indicated both conditions simultaneously, i.e. the package was lit yellow and blue simultaneously, there would be two instances of CIM_IndicatorLED.
UMLPackagePath | string | CIM::Device::Sensors
Version | string | 2.31.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
ActivationState | uint16 |
Description | string | ActivationState indicates the current activity of an LED. An LED may exhibit behaviors that vary greatly in complexity. If the behavior of the LED is simple or a detailed depiction of the behavior is unnecessary to convey to client applications, values of than 5 "ControlPattern" may be used to indicate the behavior. If the behavior is complex and detailed information about the behavior is meaningful to a client, the value 5 "ControlPattern" shall be used to indicate the ControlPattern property describes the behavior. 2 "Lit" shall indicate the LED is continuously illuminated without variation in color or intensity. 3 "Blinking" shall indicate the LED is alternating between illuminated and not illuminated in a regular pattern without variation in color or intensity. The pattern is not indicated. 4 "Off" shall indicate the LED is not illuminated. 5 "ControlPattern" shall indicate the LED is exhibiting behavior that is described using the ControlPattern property.
ModelCorrespondence | string | CIM_IndicatorLED.ControlPattern, CIM_IndicatorLEDCapabilities.SupportedActivationStates
ValueMap | string | 0, 2, 3, 4, 5, .., 32768..65535
Values | string | Unknown, Lit, Blinking, Off, Control Pattern, DMTF Reserved, Vendor Reserved
Write | boolean | true
Color | uint16 |
Description | string | This property shall indicate the current color of the LED. If the value of the ActivationState property is 4 "Off" this property shall indicate the color of the LED the last time it was lit, or shall have the value 2 "Not Applicable".
ModelCorrespondence | string | CIM_IndicatorLED.OtherColorDescription, CIM_IndicatorLEDCapabilities.SupportedColors
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, .., 32768..65535
Values | string | Unknown, Other, Not Applicable, White, Red, Green, Blue, Orange, Yellow, Black, DMTF Reserved, Vendor Reserved
Write | boolean | true
ControlMode | uint16 |
Description | string | ControlMode indicates the current control mode for the LED.2 "Automatic" shall indicate the state of the LED is being controlled by the management infrastructure. 3 "Manual" shall indicate the state of the LED is being controlled by a management client. 4 "Test" shall indicate the LED is in a test mode.
ModelCorrespondence | string | CIM_IndicatorLEDCapabilities.SupportedControlModes
ValueMap | string | 2, 3, 4, .., 32768..65535
Values | string | Automatic, Manual, Test, DMTF Reserved, Vendor Reserved
Write | boolean | true
ControlPattern | string |
Description | string | An LED may exhibit a range of behavior from very simple (ex. solid on) to very complicated (ex. a series of blinks of alternating color and duration). ControlPattern specifies the vendor or standard behavior exhibited by the LED if it cannot be described using one of the standard behaviors listed for the ActivationState property. If ActivationState has the value 5 "ControlPattern", the ControlPattern property shall not be NULL. The value of ControlPattern shall be constructed using the following "preferred" algorithm: <OrgID>::<Pattern> Where <OrgID> and < Pattern> are separated by two colons (::), and where <OrgID> shall include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the ControlPattern or that is a registered ID assigned to the business entity by a recognized global authority. If the definition of the value is specified by the DMTF, the value of <OrgID> shall be "DMTF". <Pattern> is chosen by the business entity and shall not be reused to identify different underlying (real-world) behaviors. If the behavior specified for the LED adheres to a standard or proprietary specification, <Pattern> shall be a uniquely assigned value identifying the behavior. If the behavior for the LED is described using a standard or proprietary grammar, <Pattern> shall be prefixed with a uniquely assigned identifier for the grammar.
ModelCorrespondence | string | CIM_IndicatorLED.ActivationState, CIM_IndicatorLEDCapabilities.SupportedControlPatterns
Write | boolean | true
DefaultActivationState | uint16 |
Description | string | DefaultActivationState indicates the default state of an LED. See ActivationState for a description of the values.
ValueMap | string | 0, 2, 3, 4, 5, .., 32768..65535
Values | string | Unknown, Lit, Blinking, Off, Control Pattern, DMTF Reserved, Vendor Reserved
ElementName | string |
Description | string | ElementName specifies an identifier for the LED. The value of ElementName shall be constructed using the following "preferred" algorithm: <OrgID>::<LocalID> Where <OrgID> and <LocalID> are separated by two colons (::), and where <OrgID> shall include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the ControlPattern or that is a registered ID assigned to the business entity by a recognized global authority. <LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements.
Override | string | ElementName
OtherColorDescription | string |
Description | string | This property shall have a value if Color contains the value 1 "Other".
ModelCorrespondence | string | CIM_IndicatorLED.Color, CIM_IndicatorLEDCapabilities.OtherSupportedColorDescriptions
Write | boolean | true
OtherIndicatedConditionDescription | string |
Description | string | This property shall have a value if IndicatedCondition contains the value 1 "Other".
ModelCorrespondence | string | CIM_IndicatorLED.IndicatedConditions
IndicatedConditions | uint16[] |
Description | string | The condition indicated by the LED. 2 "Not Applicable" shall indicate the LED is currently not assigned an interpretation. 3 "Location" shall indicate the LED is used to indicate the location of associated managed elements. 4 "Attention" shall indicate the LED is used to indicate the associated managed elements requires the attention of service personnel. 5 "Activity" shall indicate the LED is used to indicate activity is occurring for the associated managed elements. The type of activity indicated is specific to the associated managed elements. 6 "Powered On" shall indicate the LED is used to indicate if the associated managed elements are receiving power. 7 "Fault" shall indicate the LED is used to indicate if the associated managed elements are in a fault, error, or otherwise degraded state.
ModelCorrespondence | string | CIM_IndicatorLED.OtherIndicatedConditionDescription
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, .., 32768..65535
Values | string | Unknown, Other, Not Applicable, Location, Attention, Activity, Powered On, Fault, DMTF Reserved, Vendor Reserved

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
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
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

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