1 karl 1.1.2.2 // Copyright (c) 2009 DMTF. All rights reserved.
2 [Abstract, Version ( "2.22.0" ),
3 UMLPackagePath ( "CIM::Core::CoreElements" ),
4 Description (
5 "This class extends LogicalElement to abstract the concept of "
6 "an element that is enabled and disabled, such as a "
7 "LogicalDevice or a ServiceAccessPoint." )]
8 class CIM_EnabledLogicalElement : CIM_LogicalElement {
9
10 [Description (
11 "EnabledState is an integer enumeration that indicates "
12 "the enabled and disabled states of an element. It can "
13 "also indicate the transitions between these requested "
14 "states. For example, shutting down (value=4) and "
15 "starting (value=10) are transient states between enabled "
16 "and disabled. The following text briefly summarizes the "
17 "various enabled and disabled states: \n"
18 "Enabled (2) indicates that the element is or could be "
19 "executing commands, will process any queued commands, "
20 "and queues new requests. \n"
21 "Disabled (3) indicates that the element will not execute "
22 karl 1.1.2.2 "commands and will drop any new requests. \n"
23 "Shutting Down (4) indicates that the element is in the "
24 "process of going to a Disabled state. \n"
25 "Not Applicable (5) indicates the element does not "
26 "support being enabled or disabled. \n"
27 "Enabled but Offline (6) indicates that the element might "
28 "be completing commands, and will drop any new requests. \n"
29 "Test (7) indicates that the element is in a test state. \n"
30 "Deferred (8) indicates that the element might be "
31 "completing commands, but will queue any new requests. \n"
32 "Quiesce (9) indicates that the element is enabled but in "
33 "a restricted mode.\n"
34 "Starting (10) indicates that the element is in the "
35 "process of going to an Enabled state. New requests are "
36 "queued." ),
37 ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
38 "10", "11..32767", "32768..65535" },
39 Values { "Unknown", "Other", "Enabled", "Disabled",
40 "Shutting Down", "Not Applicable", "Enabled but Offline",
41 "In Test", "Deferred", "Quiesce", "Starting",
42 "DMTF Reserved", "Vendor Reserved" },
43 karl 1.1.2.2 ModelCorrespondence {
44 "CIM_EnabledLogicalElement.OtherEnabledState" }]
45 uint16 EnabledState = 5;
46
47 [Description (
48 "A string that describes the enabled or disabled state of "
49 "the element when the EnabledState property is set to 1 "
50 "(\"Other\"). This property must be set to null when "
51 "EnabledState is any value other than 1." ),
52 ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" }]
53 string OtherEnabledState;
54
55 [Description (
56 "RequestedState is an integer enumeration that indicates "
57 "the last requested or desired state for the element, "
58 "irrespective of the mechanism through which it was "
59 "requested. The actual state of the element is "
60 "represented by EnabledState. This property is provided "
61 "to compare the last requested and current enabled or "
62 "disabled states. Note that when EnabledState is set to 5 "
63 "(\"Not Applicable\"), then this property has no meaning. "
64 karl 1.1.2.2 "Refer to the EnabledState property description for "
65 "explanations of the values in the RequestedState "
66 "enumeration. \n"
67 "\"Unknown\" (0) indicates the last requested state for "
68 "the element is unknown.\n"
69 "Note that the value \"No Change\" (5) has been "
70 "deprecated in lieu of indicating the last requested "
71 "state is \"Unknown\" (0). If the last requested or "
72 "desired state is unknown, RequestedState should have the "
73 "value \"Unknown\" (0), but may have the value \"No "
74 "Change\" (5).Offline (6) indicates that the element has "
75 "been requested to transition to the Enabled but Offline "
76 "EnabledState. \n"
77 "It should be noted that there are two new values in "
78 "RequestedState that build on the statuses of "
79 "EnabledState. These are \"Reboot\" (10) and \"Reset\" "
80 "(11). Reboot refers to doing a \"Shut Down\" and then "
81 "moving to an \"Enabled\" state. Reset indicates that the "
82 "element is first \"Disabled\" and then \"Enabled\". The "
83 "distinction between requesting \"Shut Down\" and "
84 "\"Disabled\" should also be noted. Shut Down requests an "
85 karl 1.1.2.2 "orderly transition to the Disabled state, and might "
86 "involve removing power, to completely erase any existing "
87 "state. The Disabled state requests an immediate "
88 "disabling of the element, such that it will not execute "
89 "or accept any commands or processing requests. \n"
90 "\n"
91 "This property is set as the result of a method "
92 "invocation (such as Start or StopService on "
93 "CIM_Service), or can be overridden and defined as "
94 "WRITEable in a subclass. The method approach is "
95 "considered superior to a WRITEable property, because it "
96 "allows an explicit invocation of the operation and the "
97 "return of a result code. \n"
98 "\n"
99 "If knowledge of the last RequestedState is not supported "
100 "for the EnabledLogicalElement, the property shall be "
101 "NULL or have the value 12 \"Not Applicable\"." ),
102 ValueMap { "0", "2", "3", "4", "5", "6", "7", "8", "9", "10",
103 "11", "12", "..", "32768..65535" },
104 Values { "Unknown", "Enabled", "Disabled", "Shut Down",
105 "No Change", "Offline", "Test", "Deferred", "Quiesce",
106 karl 1.1.2.2 "Reboot", "Reset", "Not Applicable", "DMTF Reserved",
107 "Vendor Reserved" },
108 ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" }]
109 uint16 RequestedState = 12;
110
111 [Write, Description (
112 "An enumerated value indicating an administrator\'s "
113 "default or startup configuration for the Enabled State "
114 "of an element. By default, the element is \"Enabled\" "
115 "(value=2)." ),
116 ValueMap { "2", "3", "5", "6", "7", "9", "..", "32768..65535" },
117 Values { "Enabled", "Disabled", "Not Applicable",
118 "Enabled but Offline", "No Default", "Quiesce",
119 "DMTF Reserved", "Vendor Reserved" }]
120 uint16 EnabledDefault = 2;
121
122 [Description (
123 "The date or time when the EnabledState of the element "
124 "last changed. If the state of the element has not "
125 "changed and this property is populated, then it must be "
126 "set to a 0 interval value. If a state change was "
127 karl 1.1.2.2 "requested, but rejected or not yet processed, the "
128 "property must not be updated." )]
129 datetime TimeOfLastStateChange;
130
131 [Description (
132 "AvailableRequestedStates indicates the possible values "
133 "for the RequestedState parameter of the method "
134 "RequestStateChange, used to initiate a state change. The "
135 "values listed shall be a subset of the values contained "
136 "in the RequestedStatesSupported property of the "
137 "associated instance of "
138 "CIM_EnabledLogicalElementCapabilities where the values "
139 "selected are a function of the current state of the "
140 "CIM_EnabledLogicalElement. This property may be non-null "
141 "if an implementation is able to advertise the set of "
142 "possible values as a function of the current state. This "
143 "property shall be null if an implementation is unable to "
144 "determine the set of possible values as a function of "
145 "the current state." ),
146 ValueMap { "2", "3", "4", "6", "7", "8", "9", "10", "11", ".." },
147 Values { "Enabled", "Disabled", "Shut Down", "Offline",
148 karl 1.1.2.2 "Test", "Defer", "Quiesce", "Reboot", "Reset",
149 "DMTF Reserved" },
150 ModelCorrespondence {
151 "CIM_EnabledLogicalElement.RequestStateChange",
152 "CIM_EnabledLogicalElementCapabilities.RequestedStatesSupported" }]
153 uint16 AvailableRequestedStates[];
154
155 [Description (
156 "TransitioningToState indicates the target state to which "
157 "the instance is transitioning. \n"
158 "A value of 5 \"No Change\" shall indicate that no "
159 "transition is in progress.A value of 12 \"Not "
160 "Applicable\" shall indicate the implementation does not "
161 "support representing ongoing transitions. \n"
162 "A value other than 5 or 12 shall identify the state to "
163 "which the element is in the process of transitioning." ),
164 ValueMap { "0", "2", "3", "4", "5", "6", "7", "8", "9", "10",
165 "11", "12", ".." },
166 Values { "Unknown", "Enabled", "Disabled", "Shut Down",
167 "No Change", "Offline", "Test", "Defer", "Quiesce",
168 "Reboot", "Reset", "Not Applicable", "DMTF Reserved" },
169 karl 1.1.2.2 ModelCorrespondence {
170 "CIM_EnabledLogicalElement.RequestStateChange",
171 "CIM_EnabledLogicalElement.RequestedState",
172 "CIM_EnabledLogicalElement.EnabledState" }]
173 uint16 TransitioningToState = 12;
174
175
176 [Description (
177 "Requests that the state of the element be changed to the "
178 "value specified in the RequestedState parameter. When "
179 "the requested state change takes place, the EnabledState "
180 "and RequestedState of the element will be the same. "
181 "Invoking the RequestStateChange method multiple times "
182 "could result in earlier requests being overwritten or "
183 "lost. \n"
184 "A return code of 0 shall indicate the state change was "
185 "successfully initiated. \n"
186 "A return code of 3 shall indicate that the state "
187 "transition cannot complete within the interval specified "
188 "by the TimeoutPeriod parameter. \n"
189 "A return code of 4096 (0x1000) shall indicate the state "
190 karl 1.1.2.2 "change was successfully initiated, a ConcreteJob has "
191 "been created, and its reference returned in the output "
192 "parameter Job. Any other return code indicates an error "
193 "condition." ),
194 ValueMap { "0", "1", "2", "3", "4", "5", "6", "..", "4096",
195 "4097", "4098", "4099", "4100..32767", "32768..65535" },
196 Values { "Completed with No Error", "Not Supported",
197 "Unknown or Unspecified Error",
198 "Cannot complete within Timeout Period", "Failed",
199 "Invalid Parameter", "In Use", "DMTF Reserved",
200 "Method Parameters Checked - Job Started",
201 "Invalid State Transition",
202 "Use of Timeout Parameter Not Supported", "Busy",
203 "Method Reserved", "Vendor Specific" },
204 ModelCorrespondence {
205 "CIM_EnabledLogicalElement.RequestedState" }]
206 uint32 RequestStateChange(
207 [IN, Description (
208 "The state requested for the element. This "
209 "information will be placed into the RequestedState "
210 "property of the instance if the return code of the "
211 karl 1.1.2.2 "RequestStateChange method is 0 (\'Completed with "
212 "No Error\'), or 4096 (0x1000) (\'Job Started\'). "
213 "Refer to the description of the EnabledState and "
214 "RequestedState properties for the detailed "
215 "explanations of the RequestedState values." ),
216 ValueMap { "2", "3", "4", "6", "7", "8", "9", "10",
217 "11", "..", "32768..65535" },
218 Values { "Enabled", "Disabled", "Shut Down", "Offline",
219 "Test", "Defer", "Quiesce", "Reboot", "Reset",
220 "DMTF Reserved", "Vendor Reserved" },
221 ModelCorrespondence {
222 "CIM_EnabledLogicalElement.RequestedState" }]
223 uint16 RequestedState,
224 [IN ( false ), OUT, Description (
225 "May contain a reference to the ConcreteJob created "
226 "to track the state transition initiated by the "
227 "method invocation." )]
228 CIM_ConcreteJob REF Job,
229 [IN, Description (
230 "A timeout period that specifies the maximum amount "
231 "of time that the client expects the transition to "
232 karl 1.1.2.2 "the new state to take. The interval format must be "
233 "used to specify the TimeoutPeriod. A value of 0 or "
234 "a null parameter indicates that the client has no "
235 "time requirements for the transition. \n"
236 "If this property does not contain 0 or null and "
237 "the implementation does not support this "
238 "parameter, a return code of \'Use Of Timeout "
239 "Parameter Not Supported\' shall be returned." )]
240 datetime TimeoutPeriod);
241
242 };
|
Return to
CIM_EnabledLogicalElement.mof
CVS log
Up to [Pegasus] / pegasus / Schemas / CIM231 / DMTF / Core