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 may 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_AllocatedLogicalElement
   |
   +--CIM_LogicalDevice
   |
   +--CIM_IndicatorLED

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringCIM_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 may 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.
UMLPackagePathstringCIM::Device::Sensors
Versionstring2.39.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
ActivationStateuint16
DescriptionstringActivationState 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.
ModelCorrespondencestringCIM_IndicatorLED.ControlPattern, CIM_IndicatorLEDCapabilities.SupportedActivationStates
ValueMapstring0, 2, 3, 4, 5, .., 32768..65535
ValuesstringUnknown, Lit, Blinking, Off, Control Pattern, DMTF Reserved, Vendor Reserved
Writebooleantrue
Coloruint16
DescriptionstringThis 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".
ModelCorrespondencestringCIM_IndicatorLED.OtherColorDescription, CIM_IndicatorLEDCapabilities.SupportedColors
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, .., 32768..65535
ValuesstringUnknown, Other, Not Applicable, White, Red, Green, Blue, Orange, Yellow, Black, DMTF Reserved, Vendor Reserved
Writebooleantrue
ControlModeuint16
DescriptionstringControlMode 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.
ModelCorrespondencestringCIM_IndicatorLEDCapabilities.SupportedControlModes
ValueMapstring2, 3, 4, .., 32768..65535
ValuesstringAutomatic, Manual, Test, DMTF Reserved, Vendor Reserved
Writebooleantrue
ControlPatternstring
DescriptionstringAn 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.
ModelCorrespondencestringCIM_IndicatorLED.ActivationState, CIM_IndicatorLEDCapabilities.SupportedControlPatterns
Writebooleantrue
DefaultActivationStateuint16
DescriptionstringDefaultActivationState indicates the default state of an LED. See ActivationState for a description of the values.
ValueMapstring0, 2, 3, 4, 5, .., 32768..65535
ValuesstringUnknown, Lit, Blinking, Off, Control Pattern, DMTF Reserved, Vendor Reserved
OtherColorDescriptionstring
DescriptionstringThis property shall have a value if Color contains the value 1 "Other".
ModelCorrespondencestringCIM_IndicatorLED.Color, CIM_IndicatorLEDCapabilities.OtherSupportedColorDescriptions
Writebooleantrue
OtherIndicatedConditionDescriptionstring
DescriptionstringThis property shall have a value if IndicatedConditions contains the value 1 "Other".
ModelCorrespondencestringCIM_IndicatorLED.IndicatedConditions
IndicatedConditionsuint16[]
DescriptionstringThe condition indicated by the LED. 2 "Not Applicable" shall indicate the LED is currently not assigned an interpretation. 3 "Location" shall indicate the location of associated managed elements. 4 "Attention" shall indicate that the associated managed elements requires the attention of service personnel. 5 "Activity" shall indicate that 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 that the associated managed elements are receiving power. 7 "Fault" shall indicate that the associated managed elements are in a fault, error, or otherwise degraded state.
ModelCorrespondencestringCIM_IndicatorLED.OtherIndicatedConditionDescription
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, .., 32768..65535
ValuesstringUnknown, Other, Not Applicable, Location, Attention, Activity, Powered On, Fault, DMTF Reserved, Vendor Reserved

Inherited Properties

NameData TypeClass Origin
AllocationStatestringCIM_LogicalDevice
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

Inherited Class Methods

NameReturn TypeClass Origin
EnableDeviceuint32CIM_LogicalDevice
OnlineDeviceuint32CIM_LogicalDevice
QuiesceDeviceuint32CIM_LogicalDevice
RequestStateChangeuint32CIM_EnabledLogicalElement
Resetuint32CIM_LogicalDevice
RestorePropertiesuint32CIM_LogicalDevice
SavePropertiesuint32CIM_LogicalDevice
SetPowerStateuint32CIM_LogicalDevice