-
Notifications
You must be signed in to change notification settings - Fork 27
/
pyfos_brocade_chassis.py
421 lines (301 loc) · 18.2 KB
/
pyfos_brocade_chassis.py
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
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
# Copyright 2018 Brocade Communications Systems LLC. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may also 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.
"""
:mod:`pyfos_brocade_chassis` - PyFOS module to provide REST \
support for Chassis objects.
**********************************************************************************************
The :mod:`pyfos_brocade_chassis` provides a REST support for \
Chassis objects.
"""
from pyfos import pyfos_rest_util
from pyfos.pyfos_type import pyfos_type
import pyfos.pyfos_version as version
class chassis(pyfos_rest_util.rest_object):
"""This class provides information of the Chassis
Important class members:
+-----------------------------+-------------------------------+----------------------------------------+
| Attribute name | Description |Frequently used methods |
+=============================+===============================+========================================+
| chassis-user-friendly-name | user friendly name of chassis |:meth:`set_chassis_user_friendly_name` |
| | |:meth:`peek_chassis_user_friendly_name` |
+-----------------------------+-------------------------------+----------------------------------------+
| chassis-wwn | WWN of chassis |:meth:`peek_chassis_wwn` |
+-----------------------------+-------------------------------+----------------------------------------+
| license-id | License ID of chassis |:meth:`peek_license_id` |
+-----------------------------+-------------------------------+----------------------------------------+
| serial-number | Serial number of chassis |:meth:`peek_serial_number` |
+-----------------------------+-------------------------------+----------------------------------------+
| manufacturer | Manufacturer of chassis |:meth:`peek_manufacturer` |
+-----------------------------+-------------------------------+----------------------------------------+
| part-number | Part number of chassis |:meth:`peek_part_number` |
+-----------------------------+-------------------------------+----------------------------------------+
| max-blades-supported | Maximum number of blades |:meth:`peek_max_blades_supported` |
| | supported by chassis | |
+-----------------------------+-------------------------------+----------------------------------------+
| vendor-serial-number | Externally supplied serial |:meth:`peek_vendor_serial_number` |
| | number of chassis | |
+-----------------------------+-------------------------------+----------------------------------------+
| vendor-part-number | Externally supplied part |:meth:`peek_vendor_part_number` |
| | number of chassis | |
+-----------------------------+-------------------------------+----------------------------------------+
| product-name | Name by which chassis is |:meth:`peek_product_name` |
| | generally known | |
+-----------------------------+-------------------------------+----------------------------------------+
| vendor-revision-number | supplier revision number |:meth:`peek_vendor_revision_number` |
+-----------------------------+-------------------------------+----------------------------------------+
| vf-enabled | VF enabled or disabled state |:meth:`set_vf_enabled` |
| | |:meth:`peek_vf_enabled` |
+-----------------------------+-------------------------------+----------------------------------------+
| vf-supported | VF supported or not |:meth:`peek_vf_supported` |
+-----------------------------+-------------------------------+----------------------------------------+
| fcr-enabled | FCR enabled or disabled state |:meth:`set_fcr_enabled` |
| | |:meth:`peek_fcr_enabled` |
+-----------------------------+-------------------------------+----------------------------------------+
| fcr-supported | FCR supported or not |:meth:`peek_fcr_supported` |
+-----------------------------+-------------------------------+----------------------------------------+
*Object methods*
.. classmethod:: get(session)
Returns a :class:`chassis` object filled with values for all
the attributes obtained using the session passed in.
Each object can be printed using :func:`pyfos_util.response_print`
and individual attributes accessed through peek methods.
:param session: session handler returned by
:func:`pyfos_auth.login`
:rtype: dictionary of error or
:class:`chassis` object
.. method:: patch(session)
Replace entry members. Fields involved are set within the object
using attribute's set method. This command is used to
set the chassis name.
Example usage of the method to set the chassis user friendly name:
.. code-block:: python
chassis_obj = pyfos_brocade_chassis.chassis()
chassis_obj.set_chassis_user_friendly_name(name)
chassis_obj.set_vf_enabled(true)
chassis_obj.patch(session)
:param session: session handler returned by
:func:`pyfos_auth.login`
:rtype: dictionary of error or success response
*Attribute methods*
.. method:: set_chassis_user_friendly_name(name)
Sets chassis user friendly name in the object.
:param name: user friendly name of the chassis
:rtype: None or dictionary of error information
.. method:: peek_chassis_user_friendly_name()
Reads user friendly name from the object.
:rtype: None or user friendly name of the chassis
.. method:: peek_chassis_wwn()
Reads chassis WWN from the object.
:rtype: None or chassis WWN
.. method:: peek_license_id()
Reads License ID from the object.
:rtype: None or License ID
.. method:: peek_serial_number()
Reads serial number from the object.
:rtype: None or serial number of the Chassis
.. method:: peek_manufacturer()
Reads manufacturer from the object.
:rtype: None or manufacturer of the Chassis
.. method:: peek_part_number()
Reads part number from the object.
:rtype: None or part number of the Chassis
.. method:: peek_max_blades_supported()
Reads maximum number of blades supported from the object.
:rtype: None or maximum number of blades supported
.. method:: peek_vendor_serial_number()
Reads vendor serial number from the object.
:rtype: None or vendor serial number of the Chassis
.. method:: peek_vendor_part_number()
Reads vendor part number from the object.
:rtype: None or vendor part number of the Chassis
.. method:: peek_vendor_revision_number()
Reads vendor revision number from the object.
:rtype: None or vendor revision number of the Chassis
.. method:: peek_product_name()
Reads product name from the object.
:rtype: None or product name of the Chassis
.. method:: set_vf_enabled(newstate)
Sets VF enabled state of the chassis in the object.
:param newstate: VF enabled state of the chassis
:rtype: None or dictionary of error information
.. method:: peek_vf_enabled()
Reads VF enabled state of the chassis in the object.
:rtype: None or VF enabled state of the chassis
.. method:: peek_vf_supported()
Reads VF supported state of the chassis in the object.
:rtype: None or VF supported state of the chassis
.. method:: set_fcr_enabled(value)
Sets the value of fcr-enabled in the object.
:rtype: A dictionary of error or a success response and
a value with "fcr-enabled" as the key
.. method:: peek_fcr_enabled()
Reads the value assigned to fcr-enabled in the object.
:rtype: None on error and a value on success.
.. method:: peek_fcr_supported()
Reads the value assigned to fcr-supported in the object.
:rtype: None on error and a value on success.
"""
def __init__(self, dictvalues={}):
super().__init__(pyfos_rest_util.rest_obj_type.chassis_show,
"/rest/running/brocade-chassis/chassis",
version.VER_RANGE_821_and_ABOVE)
self.add(pyfos_rest_util.rest_attribute(
"chassis-user-friendly-name", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"chassis-wwn", pyfos_type.type_wwn,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"license-id", pyfos_type.type_wwn,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"serial-number", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"manufacturer", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"part-number", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"max-blades-supported", pyfos_type.type_int,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"vendor-serial-number", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"vendor-part-number", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"vendor-revision-number", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"product-name", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"vf-enabled", pyfos_type.type_bool,
None, pyfos_rest_util.REST_ATTRIBUTE_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"vf-supported", pyfos_type.type_bool,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"fcr-enabled", pyfos_type.type_bool,
None, pyfos_rest_util.REST_ATTRIBUTE_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"fcr-supported", pyfos_type.type_bool,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.load(dictvalues, 1)
class ha_status(pyfos_rest_util.rest_object):
"""Class of Chassis
Important class members:
+------------------+-------------------+------------------------------+
| Attribute name | Description |Frequently used methods |
+==================+===================+==============================+
| active-cp | Active CP id |:meth:`peek_active_cp` |
+------------------+-------------------+------------------------------+
| standby-cp | Standby CP id |:meth:`peek_standby_cp` |
+------------------+-------------------+------------------------------+
| active-slot | Active slot number|:meth:`peek_active_slot` |
+------------------+-------------------+------------------------------+
| standby-slot | Standby slot |:meth:`peek_standby_slot` |
| | number | |
+------------------+-------------------+------------------------------+
| recovery-type | Warm/Cold Recovery|:meth:`peek_recovery_type` |
+------------------+-------------------+------------------------------+
| recovery-complete| Recovery progress |:meth:`peek_recovery_complete`|
| | status | |
+------------------+-------------------+------------------------------+
| standby-health | Health status of |:meth:`peek_standby_health` |
| | standby CP | |
+------------------+-------------------+------------------------------+
| ha-enabled | HA enabled status |:meth:`peek_ha_enabled` |
+------------------+-------------------+------------------------------+
| heartbeat-up | Heartbeat between |:meth:`peek_heartbeat_up` |
| | CP is up or down | |
+------------------+-------------------+------------------------------+
| ha-synchronized | HA synchronization|:meth:`peek_ha_synchronized` |
| | status | |
+------------------+-------------------+------------------------------+
*Object methods*
.. method:: get(session)
Return :class:`ha_status`
object or a list of objects filled with attributes.
Each object can be printed using :func:`pyfos_util.response_print`
and individual attributes accessed through peek methods.
*Attribute functions*
.. function:: peek_active_cp()
Reads details about Active CP from the object.
:rtype: None on error and value on success
.. function:: peek_standby_cp()
Reads details about Standby CP from the object.
:rtype: None on error and value on success
.. function:: peek_active_slot()
Reads details about Active CP from the object.
:rtype: None on error and value on success
.. function:: peek_standby_slot()
Reads details about Active CP slot from the object.
:rtype: None on error and value on success
.. function:: peek_recovery_type()
Reads recovery type cold/warm from the object.
:rtype: None on error and value on success
.. function:: peek_recovery_complete()
Reads recovery completion status from the object.
:rtype: None on error and value on success
.. function:: peek_standby_health()
Reads standby health status from the object.
:rtype: None on error and value on success
.. function:: peek_ha_enabled()
Reads HA enabled status from the object.
:rtype: None on error and value on success
.. function:: peek_heartbeat_up()
Reads heartbeat status from the object.
:rtype: None on error and value on success
.. function:: peek_ha_synchronized()
Reads HA Synchronization status from the object.
:rtype: None on error and value on success
"""
def __init__(self, dictvalues={}):
super().__init__(pyfos_rest_util.rest_obj_type.chassis_ha,
"/rest/running/brocade-chassis/ha-status",
version.VER_RANGE_821_and_ABOVE)
self.add(pyfos_rest_util.rest_attribute("active-cp",
pyfos_type.type_str, None,
pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute("standby-cp",
pyfos_type.type_str, None,
pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute("active-slot",
pyfos_type.type_int, None,
pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute("standby-slot",
pyfos_type.type_int, None,
pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute("recovery-type",
pyfos_type.type_str, None,
pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute("recovery-complete",
pyfos_type.type_bool, None,
pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute("standby-health",
pyfos_type.type_str, None,
pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute("ha-enabled",
pyfos_type.type_bool, None,
pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute("heartbeat-up",
pyfos_type.type_str, None,
pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute("ha-synchronized",
pyfos_type.type_bool, None,
pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.load(dictvalues, 1)