1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
|
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from dracclient.resources import uris
from dracclient import utils
class iDRACCardAttribute(object):
"""Generic iDRACCard attribute class"""
def __init__(self, name, instance_id, current_value, pending_value,
read_only, fqdd, group_id):
"""Creates iDRACCardAttribute object
:param name: name of the iDRACCard attribute
:param instance_id: InstanceID of the iDRACCard attribute
:param current_value: current value of the iDRACCard attribute
:param pending_value: pending value of the iDRACCard attribute,
reflecting an unprocessed change (eg. config job not completed)
:param read_only: indicates whether this iDRACCard attribute can be
changed
:param fqdd: Fully Qualified Device Description of the iDRACCard
Attribute
:param group_id: GroupID of the iDRACCard Attribute
"""
self.name = name
self.instance_id = instance_id
self.current_value = current_value
self.pending_value = pending_value
self.read_only = read_only
self.fqdd = fqdd
self.group_id = group_id
def __eq__(self, other):
return self.__dict__ == other.__dict__
@classmethod
def parse(cls, namespace, idrac_attr_xml):
"""Parses XML and creates iDRACCardAttribute object"""
name = utils.get_wsman_resource_attr(
idrac_attr_xml, namespace, 'AttributeName')
instance_id = utils.get_wsman_resource_attr(
idrac_attr_xml, namespace, 'InstanceID')
current_value = utils.get_wsman_resource_attr(
idrac_attr_xml, namespace, 'CurrentValue', nullable=True)
pending_value = utils.get_wsman_resource_attr(
idrac_attr_xml, namespace, 'PendingValue', nullable=True)
read_only = utils.get_wsman_resource_attr(
idrac_attr_xml, namespace, 'IsReadOnly').lower()
fqdd = utils.get_wsman_resource_attr(
idrac_attr_xml, namespace, 'FQDD')
group_id = utils.get_wsman_resource_attr(
idrac_attr_xml, namespace, 'GroupID')
return cls(name, instance_id, current_value, pending_value,
(read_only == 'true'), fqdd, group_id)
class iDRACCardEnumerableAttribute(iDRACCardAttribute):
"""Enumerable iDRACCard attribute class"""
namespace = uris.DCIM_iDRACCardEnumeration
def __init__(self, name, instance_id, current_value, pending_value,
read_only, fqdd, group_id, possible_values):
"""Creates iDRACCardEnumerableAttribute object
:param name: name of the iDRACCard attribute
:param instance_id: InstanceID of the iDRACCard attribute
:param current_value: current value of the iDRACCard attribute
:param pending_value: pending value of the iDRACCard attribute,
reflecting an unprocessed change (eg. config job not completed)
:param read_only: indicates whether this iDRACCard attribute can be
changed
:param fqdd: Fully Qualified Device Description of the iDRACCard
Attribute
:param group_id: GroupID of the iDRACCard Attribute
:param possible_values: list containing the allowed values for the
iDRACCard attribute
"""
super(iDRACCardEnumerableAttribute, self).__init__(name, instance_id,
current_value,
pending_value,
read_only, fqdd,
group_id)
self.possible_values = possible_values
@classmethod
def parse(cls, idrac_attr_xml):
"""Parses XML and creates iDRACCardEnumerableAttribute object"""
idrac_attr = iDRACCardAttribute.parse(cls.namespace, idrac_attr_xml)
possible_values = [attr.text for attr
in utils.find_xml(idrac_attr_xml, 'PossibleValues',
cls.namespace, find_all=True)]
return cls(idrac_attr.name, idrac_attr.instance_id,
idrac_attr.current_value, idrac_attr.pending_value,
idrac_attr.read_only, idrac_attr.fqdd, idrac_attr.group_id,
possible_values)
def validate(self, new_value):
"""Validates new value"""
if str(new_value) not in self.possible_values:
msg = ("Attribute '%(attr)s' cannot be set to value '%(val)s'."
" It must be in %(possible_values)r.") % {
'attr': self.name,
'val': new_value,
'possible_values': self.possible_values}
return msg
class iDRACCardStringAttribute(iDRACCardAttribute):
"""String iDRACCard attribute class"""
namespace = uris.DCIM_iDRACCardString
def __init__(self, name, instance_id, current_value, pending_value,
read_only, fqdd, group_id, min_length, max_length):
"""Creates iDRACCardStringAttribute object
:param name: name of the iDRACCard attribute
:param instance_id: InstanceID of the iDRACCard attribute
:param current_value: current value of the iDRACCard attribute
:param pending_value: pending value of the iDRACCard attribute,
reflecting an unprocessed change (eg. config job not completed)
:param read_only: indicates whether this iDRACCard attribute can be
changed
:param fqdd: Fully Qualified Device Description of the iDRACCard
Attribute
:param group_id: GroupID of the iDRACCard Attribute
:param min_length: minimum length of the string
:param max_length: maximum length of the string
"""
super(iDRACCardStringAttribute, self).__init__(name, instance_id,
current_value,
pending_value,
read_only, fqdd,
group_id)
self.min_length = min_length
self.max_length = max_length
@classmethod
def parse(cls, idrac_attr_xml):
"""Parses XML and creates iDRACCardStringAttribute object"""
idrac_attr = iDRACCardAttribute.parse(cls.namespace, idrac_attr_xml)
min_length = int(utils.get_wsman_resource_attr(
idrac_attr_xml, cls.namespace, 'MinLength'))
max_length = int(utils.get_wsman_resource_attr(
idrac_attr_xml, cls.namespace, 'MaxLength'))
return cls(idrac_attr.name, idrac_attr.instance_id,
idrac_attr.current_value, idrac_attr.pending_value,
idrac_attr.read_only, idrac_attr.fqdd, idrac_attr.group_id,
min_length, max_length)
def validate(self, new_value):
"""Validates new value"""
val_len = len(new_value)
if val_len < self.min_length or val_len > self.max_length:
msg = ("Attribute '%(attr)s' cannot be set to value '%(val)s'."
" It must be between %(lower)d and %(upper)d characters in "
"length.") % {
'attr': self.name,
'val': new_value,
'lower': self.min_length,
'upper': self.max_length}
return msg
class iDRACCardIntegerAttribute(iDRACCardAttribute):
"""Integer iDRACCard attribute class"""
namespace = uris.DCIM_iDRACCardInteger
def __init__(self, name, instance_id, current_value, pending_value,
read_only, fqdd, group_id, lower_bound, upper_bound):
"""Creates iDRACCardIntegerAttribute object
:param name: name of the iDRACCard attribute
:param instance_id: InstanceID of the iDRACCard attribute
:param current_value: current value of the iDRACCard attribute
:param pending_value: pending value of the iDRACCard attribute,
reflecting an unprocessed change (eg. config job not completed)
:param read_only: indicates whether this iDRACCard attribute can be
changed
:param fqdd: Fully Qualified Device Description of the iDRACCard
Attribute
:param group_id: GroupID of the iDRACCard Attribute
:param lower_bound: minimum value for the iDRACCard attribute
:param upper_bound: maximum value for the iDRACCard attribute
"""
super(iDRACCardIntegerAttribute, self).__init__(name, instance_id,
current_value,
pending_value,
read_only, fqdd,
group_id)
self.lower_bound = lower_bound
self.upper_bound = upper_bound
@classmethod
def parse(cls, idrac_attr_xml):
"""Parses XML and creates iDRACCardIntegerAttribute object"""
idrac_attr = iDRACCardAttribute.parse(cls.namespace, idrac_attr_xml)
lower_bound = utils.get_wsman_resource_attr(
idrac_attr_xml, cls.namespace, 'LowerBound')
upper_bound = utils.get_wsman_resource_attr(
idrac_attr_xml, cls.namespace, 'UpperBound')
if idrac_attr.current_value:
idrac_attr.current_value = int(idrac_attr.current_value)
if idrac_attr.pending_value:
idrac_attr.pending_value = int(idrac_attr.pending_value)
return cls(idrac_attr.name, idrac_attr.instance_id,
idrac_attr.current_value, idrac_attr.pending_value,
idrac_attr.read_only, idrac_attr.fqdd, idrac_attr.group_id,
int(lower_bound), int(upper_bound))
def validate(self, new_value):
"""Validates new value"""
val = int(new_value)
if val < self.lower_bound or val > self.upper_bound:
msg = ('Attribute %(attr)s cannot be set to value %(val)d.'
' It must be between %(lower)d and %(upper)d.') % {
'attr': self.name,
'val': new_value,
'lower': self.lower_bound,
'upper': self.upper_bound}
return msg
class iDRACCardConfiguration(object):
NAMESPACES = [(uris.DCIM_iDRACCardEnumeration,
iDRACCardEnumerableAttribute),
(uris.DCIM_iDRACCardString, iDRACCardStringAttribute),
(uris.DCIM_iDRACCardInteger, iDRACCardIntegerAttribute)]
def __init__(self, client):
"""Creates an iDRACCardConfiguration object
:param client: an instance of WSManClient
"""
self.client = client
def list_idrac_settings(self, by_name=False, fqdd_filter=None):
"""List the iDRACCard configuration settings
:param by_name: Controls whether returned dictionary uses iDRAC card
attribute name as key. If set to False, instance_id
will be used. If set to True the keys will be of the
form "group_id#name".
:param fqdd_filter: An FQDD used to filter the instances. Note that
this is only used when by_name is True.
:returns: a dictionary with the iDRAC settings using instance_id as the
key except when by_name is True. The attributes are either
iDRACCArdEnumerableAttribute, iDRACCardStringAttribute or
iDRACCardIntegerAttribute objects.
:raises: WSManRequestFailure on request failures
:raises: WSManInvalidResponse when receiving invalid response
:raises: DRACOperationFailed on error reported back by the DRAC
interface
"""
return utils.list_settings(self.client,
self.NAMESPACES,
by_name=by_name,
fqdd_filter=fqdd_filter,
name_formatter=_name_formatter)
def set_idrac_settings(self, new_settings, idrac_fqdd):
"""Set the iDRACCard configuration settings
To be more precise, it sets the pending_value parameter for each of the
attributes passed in. For the values to be applied, a config job may
need to be created and the node may need to be rebooted.
:param new_settings: a dictionary containing the proposed values, with
each key being the name of attribute qualified
with the group ID in the form "group_id#name" and
the value being the proposed value.
:param idrac_fqdd: the FQDD of the iDRAC.
:returns: a dictionary containing:
- The is_commit_required key with a boolean value indicating
whether a config job must be created for the values to be
applied.
- The is_reboot_required key with a RebootRequired enumerated
value indicating whether the server must be rebooted for the
values to be applied. Possible values are true and false.
:raises: WSManRequestFailure on request failures
:raises: WSManInvalidResponse when receiving invalid response
:raises: DRACOperationFailed on error reported back by the DRAC
interface
:raises: DRACUnexpectedReturnValue on return value mismatch
:raises: InvalidParameterValue on invalid attribute
"""
return utils.set_settings('iDRAC Card',
self.client,
self.NAMESPACES,
new_settings,
uris.DCIM_iDRACCardService,
"DCIM_iDRACCardService",
"DCIM:iDRACCardService",
idrac_fqdd,
name_formatter=_name_formatter)
def reset_idrac(self, force=False):
"""Resets the iDRAC
:param force: does a force reset when True and a graceful reset when
False.
:returns: True on success and False on failure.
:raises: WSManRequestFailure on request failures
:raises: WSManInvalidResponse when receiving invalid response
"""
selectors = {'CreationClassName': "DCIM_iDRACCardService",
'Name': "DCIM:iDRACCardService",
'SystemCreationClassName': 'DCIM_ComputerSystem',
'SystemName': 'DCIM:ComputerSystem'}
properties = {'Force': "1" if force else "0"}
doc = self.client.invoke(uris.DCIM_iDRACCardService,
'iDRACReset',
selectors,
properties,
check_return_value=False)
message_id = utils.find_xml(doc,
'MessageID',
uris.DCIM_iDRACCardService).text
return "RAC064" == message_id
def _name_formatter(attribute):
return "{}#{}".format(attribute.group_id, attribute.name)
|
