1 karl 1.1.2.2 // Copyright (c) 2009 DMTF. All rights reserved.
2 [Version ( "2.22.0" ),
3 UMLPackagePath ( "CIM::Device::Sensors" ),
4 Description (
5 "CIM_IndicatorLED represents an LED of a managed element used "
6 "to indicate one or more conditions for the managed element. A "
7 "single discrete package may be represented by one or more "
8 "instances of CIM_IndicatorLED. There shall be an instance of "
9 "CIM_IndicatorLED for each IndicatedCondition that may be "
10 "indicated simultaneously by the discrete package. For example, "
11 "if a single LED is capable of flashing yellow for one "
12 "condition and blue for a different one, but the conditions are "
13 "not indicated simultaneously, it is modeled using a single "
14 "instance of CIM_IndicatorLED that supports both colors. If the "
15 "LED indicated both conditions simultaneously, i.e. the package "
16 "was lit yellow and blue simultaneously, there would be two "
17 "instances of CIM_IndicatorLED." )]
18 class CIM_IndicatorLED : CIM_LogicalDevice {
19
20 [Override ( "ElementName" ),
21 Description (
22 karl 1.1.2.2 "ElementName specifies an identifier for the LED. The "
23 "value of ElementName shall be constructed using the "
24 "following \"preferred\" algorithm: <OrgID>::<LocalID> \n"
25 "Where <OrgID> and <LocalID> are separated by two colons "
26 "(::), and where <OrgID> shall include a copyrighted, "
27 "trademarked, or otherwise unique name that is owned by "
28 "the business entity that is creating or defining the "
29 "ControlPattern or that is a registered ID assigned to "
30 "the business entity by a recognized global authority. "
31 "<LocalID> is chosen by the business entity and should "
32 "not be reused to identify different underlying "
33 "(real-world) elements." )]
34 string ElementName;
35
36 [Description (
37 "The condition indicated by the LED. 2 \"Not Applicable\" "
38 "shall indicate the LED is currently not assigned an "
39 "interpretation. \n"
40 "3 \"Location\" shall indicate the LED is used to "
41 "indicate the location of associated managed elements.\n"
42 "4 \"Attention\" shall indicate the LED is used to "
43 karl 1.1.2.2 "indicate the associated managed elements requires the "
44 "attention of service personnel.\n"
45 "5 \"Activity\" shall indicate the LED is used to "
46 "indicate activity is occurring for the associated "
47 "managed elements. The type of activity indicated is "
48 "specific to the associated managed elements.\n"
49 "6 \"Powered On\" shall indicate the LED is used to "
50 "indicate if the associated managed elements are "
51 "receiving power. \n"
52 "7 \"Fault\" shall indicate the LED is used to indicate "
53 "if the associated managed elements are in a fault, "
54 "error, or otherwise degraded state." ),
55 ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "..",
56 "32768..65535" },
57 Values { "Unknown", "Other", "Not Applicable", "Location",
58 "Attention", "Activity", "Powered On", "Fault",
59 "DMTF Reserved", "Vendor Reserved" },
60 ModelCorrespondence {
61 "CIM_IndicatorLED.OtherIndicatedConditionDescription" }]
62 uint16 IndicatedConditions[];
63
64 karl 1.1.2.2 [Description (
65 "This property shall have a value if IndicatedCondition "
66 "contains the value 1 \"Other\"." ),
67 ModelCorrespondence { "CIM_IndicatorLED.IndicatedCondition" }]
68 string OtherIndicatedConditionDescription;
69
70 [Write, Description (
71 "This property shall indicate the current color of the "
72 "LED. If the value of the ActivationState property is 4 "
73 "\"Off\" this property shall indicate the color of the "
74 "LED the last time it was lit, or shall have the value 2 "
75 "\"Not Applicable\"." ),
76 ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
77 "..", "32768..65535" },
78 Values { "Unknown", "Other", "Not Applicable", "White",
79 "Red", "Green", "Blue", "Orange", "Yellow", "Black",
80 "DMTF Reserved", "Vendor Reserved" },
81 ModelCorrespondence {
82 "CIM_IndicatorLED.OtherColorDescription",
83 "CIM_IndicatorLEDCapabilities.SupportedColors" }]
84 uint16 Color;
85 karl 1.1.2.2
86 [Write, Description (
87 "This property shall have a value if Color contains the "
88 "value 1 \"Other\"." ),
89 ModelCorrespondence { "CIM_IndicatorLED.Color",
90 "CIM_IndicatorLEDCapabilities.OtherSupportedColorDescriptions" }]
91 string OtherColorDescription;
92
93 [Write, Description (
94 "ControlMode indicates the current control mode for the "
95 "LED.2 \"Automatic\" shall indicate the state of the LED "
96 "is being controlled by the management infrastructure. 3 "
97 "\"Manual\" shall indicate the state of the LED is being "
98 "controlled by a management client. 4 \"Test\" shall "
99 "indicate the LED is in a test mode." ),
100 ValueMap { "2", "3", "4", "..", "32768..65535" },
101 Values { "Automatic", "Manual", "Test", "DMTF Reserved",
102 "Vendor Reserved" },
103 ModelCorrespondence {
104 "CIM_IndicatorLEDCapabilities.SupportedControlModes" }]
105 uint16 ControlMode;
106 karl 1.1.2.2
107 [Description (
108 "DefaultActivationState indicates the default state of an "
109 "LED. See ActivationState for a description of the "
110 "values." ),
111 ValueMap { "2", "3", "4", "5", "..", "32768..65535" },
112 Values { "Lit", "Blinking", "Off", "Control Pattern",
113 "DMTF Reserved", "Vendor Reserved" }]
114 uint16 DefaultActivationState;
115
116 [Write, Description (
117 "ActivationState indicates the current activity of an "
118 "LED. An LED may exhibit behaviors that vary greatly in "
119 "complexity. If the behavior of the LED is simple or a "
120 "detailed depiction of the behavior is unnecessary to "
121 "convey to client applications, values of than 5 "
122 "\"ControlPattern\" may be used to indicate the behavior. "
123 "If the behavior is complex and detailed information "
124 "about the behavior is meaningful to a client, the value "
125 "5 \"ControlPattern\" shall be used to indicate the "
126 "ControlPattern property describes the behavior. \n"
127 karl 1.1.2.2 "2 \"Lit\" shall indicate the LED is continuously "
128 "illuminated without variation in color or intensity. 3 "
129 "\"Blinking\" shall indicate the LED is alternating "
130 "between illuminated and not illuminated in a regular "
131 "pattern without variation in color or intensity. The "
132 "pattern is not indicated. \n"
133 "4 \"Off\" shall indicate the LED is not illuminated. 5 "
134 "\"ControlPattern\" shall indicate the LED is exhibiting "
135 "behavior that is described using the ControlPattern "
136 "property." ),
137 ValueMap { "2", "3", "4", "5", "..", "32768..65535" },
138 Values { "Lit", "Blinking", "Off", "Control Pattern",
139 "DMTF Reserved", "Vendor Reserved" },
140 ModelCorrespondence { "CIM_IndicatorLED.ControlPattern",
141 "CIM_IndicatorLEDCapabilities.SupportedActivationStates" }]
142 uint16 ActivationState;
143
144 [Write, Description (
145 "An LED may exhibit a range of behavior from very simple "
146 "(ex. solid on) to very complicated (ex. a series of "
147 "blinks of alternating color and duration). "
148 karl 1.1.2.2 "ControlPattern specifies the vendor or standard behavior "
149 "exhibited by the LED if it cannot be described using one "
150 "of the standard behaviors listed for the ActivationState "
151 "property. \n"
152 "If ActivationState has the value 5 \"ControlPattern\", "
153 "the ControlPattern property shall not be NULL. \n"
154 "The value of ControlPattern shall be constructed using "
155 "the following \"preferred\" algorithm: "
156 "<OrgID>::<Pattern> \n"
157 "Where <OrgID> and < Pattern> are separated by two colons "
158 "(::), and where <OrgID> shall include a copyrighted, "
159 "trademarked, or otherwise unique name that is owned by "
160 "the business entity that is creating or defining the "
161 "ControlPattern or that is a registered ID assigned to "
162 "the business entity by a recognized global authority. If "
163 "the definition of the value is specified by the DMTF, "
164 "the value of <OrgID> shall be \"DMTF\". <Pattern> is "
165 "chosen by the business entity and shall not be reused to "
166 "identify different underlying (real-world) behaviors. If "
167 "the behavior specified for the LED adheres to a standard "
168 "or proprietary specification, <Pattern> shall be a "
169 karl 1.1.2.2 "uniquely assigned value identifying the behavior. If the "
170 "behavior for the LED is described using a standard or "
171 "proprietary grammar, <Pattern> shall be prefixed with a "
172 "uniquely assigned identifier for the grammar." ),
173 ModelCorrespondence { "CIM_IndicatorLED.ActivationState",
174 "CIM_IndicatorLEDCapabilities.SupportedControlPatterns" }]
175 string ControlPattern;
176
177
178 };
|