-
Notifications
You must be signed in to change notification settings - Fork 27
/
pyfos_brocade_logging.py
1418 lines (994 loc) · 58.7 KB
/
pyfos_brocade_logging.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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# 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_logging` - PyFOS module to provide REST \
support for configuring the logging facilities in the FC switch.
******************************************************************\
****************************************************************
The :mod:`pyfos_brocade_logging` module provides REST support for \
the FC switch logging facilities.
"""
from pyfos import pyfos_rest_util
from pyfos.pyfos_type import pyfos_type
import pyfos.pyfos_version as version
class raslog(pyfos_rest_util.rest_object):
"""Class of RASLog configurable parameters
Important Class Members:
+------------------+--------------------+-----------------------------+
| Attribute Name | Description |Frequently Used Methods |
+==================+====================+=============================+
| message-id | The message ID |:meth:`peek_message_id` |
| | of the RASLog. | |
+------------------+--------------------+-----------------------------+
| message-text | The message text |:meth:`peek_message_text` |
| | of the RASLog. | |
+------------------+--------------------+-----------------------------+
| message-enabled | The message status |:meth:`set_message_enabled` |
| | of the RASLog. |:meth:`peek_message_enabled` |
+------------------+--------------------+-----------------------------+
| message-flooded | The message flooded|:meth:`peek_message_flooded` |
| | status of the | |
| | RASLog. | |
+------------------+--------------------+-----------------------------+
| syslog-enabled | The syslog status |:meth:`set_syslog_enabled` |
| | of the RASLog. |:meth:`peek_syslog_enabled` |
+------------------+--------------------+-----------------------------+
| current-severity | The severity level |:meth:`set_current_severity` |
| | of the RASLog. |:meth:`peek_current_severity`|
+------------------+--------------------+-----------------------------+
| default-severity | The default |:meth:`peek_default_severity`|
| | severity of the | |
| | RASLog. | |
+------------------+--------------------+-----------------------------+
*Object Methods*
.. method:: get(session)
Returns a :class:`raslog` object with attributes from the RASLog.
Each object can be printed using :func:`pyfos_util.response_print`,
and individual attributes can be accessed through peek methods.
:param session: The session handler returned by
:func:`pyfos_auth.login`.
:rtype: A dictionary of errors or a
:class:`raslog` object.
.. method:: patch(session)
Applies the configurable attribute(s) within the object to the \
RASLog.
*Below Is an Example Using Individual Sets:*
.. code-block:: python
# initialize the raslog object
raslog_obj = pyfos_brocade_logging.raslog()
# set the message-id attribute to enable the
# wwn based pid on the raslog
raslog_obj.set_message_enabled(true)
# execute HTTP patch command to apply the object to the
# raslog connected through session
raslog_obj.patch(session)
*Below Is an Example of Combining Object \
Initialization and Attribute Sets:*
.. code-block:: python
# initialize the raslog object and
# set the enable-state attribute
raslog_obj = pyfos_brocade_logging.raslog(
{"message-enabled" : true})
# execute HTTP patch command to apply the object to the
# raslog connected through session
raslog_obj.patch(session)
:param session: The session handler returned by
:func:`pyfos_auth.login`.
:rtype: A dictionary of errors or success information.
*Attribute Methods*
.. method:: peek_message_id()
Reads the message ID of the RASLog in the object.
:rtype: The message ID.
.. method:: peek_message_text()
Reads the message description in the RASLog object.
:rtype: A text description of the RASLog.
.. method:: set_message_enabled(flag)
Sets the RASLog message object.
:param flag: The message status flag within the object.
:rtype: None or a dictionary of error information.
.. method:: peek_message_enabled()
Reads the message status in the object.
:rtype: None or the status of the RASLog.
.. method:: peek_message_flooded()
Reads the message flooded status in the object.
:rtype: None or the status of the RASLog.
.. method:: set_syslog_enabled(flag)
Sets the RASLog message object for syslog.
:param flag: The syslog status flag within the object.
:rtype: None or a dictionary of error information.
.. method:: peek_syslog_enabled()
Reads the message syslog status in the object.
:rtype: None or the syslog status of the RASLog.
.. method:: set_current_severity(value)
Sets the severity of the RASLog message object.
:param value: The severity value within the object.
:rtype: None or a dictionary of error information.
.. method:: peek_current_severity()
Reads the severity in the object.
:rtype: None or the severity of the RASLog.
.. method:: peek_default_severity()
Reads the default severity in the object.
:rtype: None or the default severity of the RASLog.
"""
def __init__(self, dictvalues={}):
super().__init__(pyfos_rest_util.rest_obj_type.raslog,
"/rest/running/brocade-logging/raslog",
version.VER_RANGE_821_and_ABOVE)
self.add(pyfos_rest_util.rest_attribute(
"message-id", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_KEY))
self.add(pyfos_rest_util.rest_attribute(
"message-text", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"message-enabled", pyfos_type.type_bool,
None, pyfos_rest_util.REST_ATTRIBUTE_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"syslog-enabled", pyfos_type.type_bool,
None, pyfos_rest_util.REST_ATTRIBUTE_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"message-flooded", pyfos_type.type_bool,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"current-severity", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"default-severity", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.load(dictvalues, 1)
class raslog_module(pyfos_rest_util.rest_object):
"""Class of configurable parameters of all RASLogs of a FOS module.
Important Class Members:
+----------------+----------------------+------------------------+
| Attribute Name | Description |Frequently Used Methods |
+================+======================+========================+
| module-id | The module ID |:meth:`peek_module_id` |
| | of the RASLog. | |
+----------------+----------------------+------------------------+
| log-enabled | The status of all |:meth:`set_log_enabled` |
| | RASLogs in the FOS | |
| | module. | |
+----------------+----------------------+------------------------+
*Object Methods*
.. method:: get(session)
Returns a :class:`raslog_module` object with attributes from
the RASLog module.
Each object can be printed using :func:`pyfos_util.response_print`,
and individual attributes can be accessed through peek methods.
:param session: The session handler returned by
:func:`pyfos_auth.login`.
:rtype: A dictionary of errors or a
:class:`raslog_module` object.
.. method:: patch(session)
Applies configurable attribute(s) within the object to the \
RASLog module.
*Below Is an Example Using Individual Sets:*
.. code-block:: python
# initialize the raslog_module object
raslog_module_obj = pyfos_brocade_logging.raslog_module()
# set the module-id attribute to enable the
# wwn based pid on the raslog_module
raslog_module_obj.set_log_enabled(true)
# execute HTTP patch command to apply the object to the
# raslog_module connected through session
raslog_module_obj.patch(session)
*Below Is an Example of Combining Object \
Initialization and Attribute Sets:*
.. code-block:: python
# initialize the raslog_module object and
# set the enable-state attribute
raslog_module_obj = pyfos_brocade_logging.raslog_module(
{"log-enabled" : true})
# execute HTTP patch command to apply the object to the
# raslog_module connected through session
raslog_module_obj.patch(session)
:param session: The session handler returned by
:func:`pyfos_auth.login`.
:rtype: A dictionary of errors or success information.
*Attribute Methods*
.. method:: peek_module_id()
Reads the module ID of the RASLog module in the object.
:rtype: The module ID.
.. method:: set_log_enabled(flag)
Sets the RASLog module in the object.
:param flag: The message status flag for all messages in the module
within the object.
:rtype: None or a dictionary of error information.
"""
def __init__(self, dictvalues={}):
super().__init__(pyfos_rest_util.rest_obj_type.raslog_module,
"/rest/running/brocade-logging/raslog-module",
version.VER_RANGE_821_and_ABOVE)
self.add(pyfos_rest_util.rest_attribute(
"module-id", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_KEY))
self.add(pyfos_rest_util.rest_attribute(
"log-enabled", pyfos_type.type_bool,
None, pyfos_rest_util.REST_ATTRIBUTE_CONFIG))
self.load(dictvalues, 1)
class log_quiet_control(pyfos_rest_util.rest_object):
"""
Class of configurable parameters of the log quiet control.
Important Class Members:
+----------------+-------------------+----------------------------+
| Attribute Name | Description |Frequently Used Methods |
+================+===================+============================+
| log-type | The identifier for|:meth:`peek_log_type` |
| | the log type. | |
+----------------+-------------------+----------------------------+
| quiet-enabled | The quiet status |:meth:`set_quiet_enabled` |
| | of the log type. |:meth:`peek_quiet_enabled` |
+----------------+-------------------+----------------------------+
| start-time | The quiet start |:meth:`set_start_time` |
| | time of the log |:meth:`peek_start_time` |
| | type. | |
+----------------+-------------------+----------------------------+
| end-time | The quiet end |:meth:`set_end_time` |
| | time of the log |:meth:`peek_end_time` |
| | type. | |
+----------------+-------------------+----------------------------+
| days-of-week | The quiet days of |:meth:`set_days_of_week_day`|
| | the log type. |:meth:`peek_days_of_week` |
+----------------+-------------------+----------------------------+
*Object Methods*
.. method:: get(session)
Returns a :class:`log_quiet_control` object with attributes
from log quiet control.
Each object can be printed using :func:`pyfos_util.response_print`,
and individual attributes can be accessed through peek methods.
:param session: The session handler returned by
:func:`pyfos_auth.login`.
:rtype: A dictionary of errors or a
:class:`log_quiet_control` object.
.. method:: patch(session)
Applies configurable attribute(s) within the object to
log quiet control.
*Below Is an Example Using Individual Sets:*
.. code-block:: python
# initialize the log_quiet_control object
obj = pyfos_brocade_logging.log_quiet_control()
# set the log-type attribute to enable the
# wwn based pid on the log_quiet_control
obj.set_keep_alive_period(true)
# execute HTTP patch command to apply the object to the
# log_quiet_control connected through session
obj.patch(session)
*Below Is an Example of Combining Object \
Initialization and Attribute Sets:*
.. code-block:: python
# initialize the log_quiet_control object and
# set the enable attribute
obj = pyfos_brocade_logging.log_quiet_control(
{"quiet-enabled" : true})
# execute HTTP patch command to apply the object to the
# log_quiet_control connected through session
obj.patch(session)
:param session: The session handler returned by
:func:`pyfos_auth.login`.
:rtype: A dictionary of errors or success information.
*Attribute Methods*
.. method:: peek_log_type()
Reads the message ID of the log quiet control in the object.
:rtype: The message ID.
.. method:: set_quiet_enabled(flag)
Sets the log quiet control object.
:param flag: The quiet flag of the log within the switch.
:rtype: None or a dictionary of error information.
.. method:: peek_quiet_enabled()
Reads the quiet status in the object.
:rtype: None or the status of the log quiet control.
.. method:: set_start_time(value)
Sets the start time of the log quiet control object.
:param value: The start time period in hh:mm to quiet the logs \
within the switch.
:rtype: None or a dictionary of error information.
.. method:: peek_start_time()
Reads the start time in the object.
:rtype: None or the start time of the log quiet control.
.. method:: set_end_time(value)
Sets the end time of the log quiet control object.
:param value: The end time period in hh:mm to quiet the logs within
the switch.
:rtype: None or a dictionary of error information.
.. method:: peek_end_time()
Reads the end time in the object.
:rtype: None or the end time of the log quiet control.
.. method:: set_days_of_week_day(value)
Sets the quiet days of the log quiet control object.
:param value: The day to quiet the logs within the switch.
:rtype: None or a dictionary of error information.
.. method:: peek_days_of_week()
Reads the quiet days in the object.
:rtype: None or the quiet days set for the log quiet control.
"""
def __init__(self, dictvalues={}):
super().__init__(pyfos_rest_util.rest_obj_type.log_quiet_control,
"/rest/running/brocade-logging/log-quiet-control",
version.VER_RANGE_821_and_ABOVE)
self.add(pyfos_rest_util.rest_attribute(
"log-type", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_KEY))
self.add(pyfos_rest_util.rest_attribute(
"quiet-enabled", pyfos_type.type_bool,
None, pyfos_rest_util.REST_ATTRIBUTE_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"start-time", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"end-time", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"days-of-week", pyfos_type.type_na,
dict(), pyfos_rest_util.REST_ATTRIBUTE_CONTAINER))
self.add(pyfos_rest_util.rest_attribute(
"day", pyfos_type.type_str,
dict(), pyfos_rest_util.REST_ATTRIBUTE_LEAF_LIST),
["days-of-week"])
self.load(dictvalues, 1)
class log_setting(pyfos_rest_util.rest_object):
"""
Class of configurable parameters of the log control.
Important Class Members:
+-----------------------+-----------------------+------------------------------------+
| Attribute Name | Description | Frequently Used Methods |
+=======================+=======================+====================================+
| keep-alive-period | The log keepalive | :meth:`set_keep_alive_period` |
| | period. | :meth:`peek_keep_alive_period` |
+-----------------------+-----------------------+------------------------------------+
| syslog-facility-level | The syslog facility | :meth:`peek_syslog_facility_level` |
| | level. | :meth:`set_syslog_facility_level` |
+-----------------------+-----------------------+------------------------------------+
| clear-log | Clears errdump when | :meth:`set_clear_log` |
| | value is `error-log`, | |
| | clears auditdump when | |
| | value is `audit-log`, | |
| | clears both when | |
| | value is `all` | |
+-----------------------+-----------------------+------------------------------------+
*Object Methods*
.. method:: get(session)
Returns a :class:`log_setting` object with attributes from
the log setting.
Each object can be printed using :func:`pyfos_util.response_print`,
and individual attributes can be accessed through peek methods.
:param session: The session handler returned by
:func:`pyfos_auth.login`.
:rtype: A dictionary of errors or a
:class:`log_setting` object.
.. method:: patch(session)
Applies configurable attribute(s) within the object to the \
log setting.
*Below Is an Example Using Individual Sets:*
.. code-block:: python
# initialize the log_setting object
log_setting_obj = pyfos_brocade_logging.log_setting()
# set the log-type attribute to enable the
# wwn based pid on the log_setting
log_setting_obj.set_keep_alive_period(value)
# execute HTTP patch command to apply the object to the
# log_setting connected through session
log_setting_obj.patch(session)
*Below Is an Example of Combining Object \
Initialization and Attribute Sets:*
.. code-block:: python
# initialize the log_setting object and
# set the enable attribute
log_setting_obj = pyfos_brocade_logging.log_setting(
{"keep-alive-period" : 24})
# execute HTTP patch command to apply the object to the
# log_setting connected through session
log_setting_obj.patch(session)
:param session: The session handler returned by
:func:`pyfos_auth.login`.
:rtype: A dictionary of errors or success information.
*Attribute Methods*
.. method:: peek_keep_alive_period()
Reads the message ID of the log setting in the object.
:rtype: The message ID.
.. method:: set_keep_alive_period(value)
Sets the log setting object.
:param value: The keepalive period.
:rtype: None or a dictionary of error information.
.. method:: peek_syslog_facility_level()
Reads the syslog facility level in the object.
:rtype: None or the syslog facility level.
.. method:: set_syslog_facility_level(level)
Sets the syslog facility level.
:param: The facility level.
:rtype: A dictionary of errors or a success response.
.. method:: set_clear_log(value)
Clears errdump or auditdump or both the logs.
:param value: error-log OR audit-log OR all.
:rtype: None or a dictionary of error information.
"""
def __init__(self, dictvalues={}):
super().__init__(pyfos_rest_util.rest_obj_type.log_setting,
"/rest/running/brocade-logging/log-setting",
version.VER_RANGE_821_and_ABOVE)
self.add(pyfos_rest_util.rest_attribute(
"keep-alive-period", pyfos_type.type_int,
None, pyfos_rest_util.REST_ATTRIBUTE_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"syslog-facility-level", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"clear-log", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_CONFIG,
version.VER_RANGE_900_and_ABOVE))
self.load(dictvalues, 1)
class audit(pyfos_rest_util.rest_object):
""" This class provides methods or options to retrieve and configure
audit logging.
Important Class Members:
+-----------------+--------+-------------------------------------------+
| Attribute Name | Desc. |Frequently Used Methods |
+=================+========+===========================================+
| audit-enabled | Audit |:meth:`peek_audit_enabled` |
| | flag. |:meth:`set_audit_enabled` |
+-----------------+--------+-------------------------------------------+
| severity-level |Severity|:meth:`peek_severity_level` |
| | level. |:meth:`set_severity_level` |
+-----------------+--------+-------------------------------------------+
|filter-class-list| Class |:meth:`peek_filter_class_list_filter_class`|
|/filter-class | list. |:meth:`set_filter_class_list_filter_class` |
+-----------------+--------+-------------------------------------------+
*Object Methods*
.. method:: get(session)
Returns a :class:`audit` object or a list of objects \
with attributes gathered from auditcfg.
Each object can be printed using :func:`pyfos_util.response_print`,
and individual attributes can be accessed through peek methods.
.. method:: patch(session)
Apply configurable attribute(s) within the object to audit.
*Below Is an Example Using Individual Sets:*
.. code-block:: python
# initialize the audit object
audit_obj = pyfos_brocade_logging.audit()
# set audit enabled to true
audit_obj.set_audit_enabled(true)
# set the severity level to info
audit_obj.set_severity_level(info)
audit_obj.patch(session)
:param session: The session handler returned by the audit
:rtype: A dictionary of errors or success information.
*Attribute Methods*
.. method:: set_audit_enabled(enable/disable)
Sets the audit log enabled flag to true or false (disabled)
in the object.
:param enable/disable: True to enable and false to disable \
audit logs.
:rtype: A dictionary of errors or success response.
.. method:: peek_audit_enabled()
Reads the audit log enabled state in the object.
:rtype: True or false.
.. method:: set_severity_level(level)
Sets the severity level in the object.
:param level: The valid severity level (info, warning, \
critical, error).
:rtype: A dictionary of errors or a success response.
.. method:: peek_severity_level()
Reads the severity level in the object.
:rtype: The severity level of the audit log.
.. method:: set_filter_class_list_filter_class(filter_class_list)
Sets the filter class list in the object.
:param level: The valid filter class list (security, \
configuration, zone, firmware, fabric, ls, cli, maps).
:rtype: A dictionary of errors or a success response.
.. method:: peek_filter_class_list_filter_class()
Reads the filter class list in the object.
:rtype: The filter class list of audit logs.
"""
def __init__(self, dictvalues={}):
super().__init__(pyfos_rest_util.rest_obj_type.audit,
"/rest/running/brocade-logging/audit",
version.VER_RANGE_821_and_ABOVE)
self.add(pyfos_rest_util.rest_attribute(
"audit-enabled", pyfos_type.type_bool,
None, pyfos_rest_util.REST_ATTRIBUTE_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"severity-level", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"filter-class-list", pyfos_type.type_na,
dict(), pyfos_rest_util.REST_ATTRIBUTE_CONTAINER))
self.add(pyfos_rest_util.rest_attribute(
"filter-class", pyfos_type.type_na,
None, pyfos_rest_util.REST_ATTRIBUTE_LEAF_LIST),
["filter-class-list"])
self.load(dictvalues, 1)
class syslog_server(pyfos_rest_util.rest_object):
""" This class provides methods and options to retrieve, configure, modify,
and delete the syslog.
Important Class Members:
+----------------+--------------------+------------------------+
| Attribute Name | Description |Frequently Used Methods |
+================+====================+========================+
| server | The syslog server |:meth:`peek_server` |
| | name. |:meth:`set_server` |
+----------------+--------------------+------------------------+
| port | The port syslog |:meth:`peek_port` |
| | server. |:meth:`set_port` |
+----------------+--------------------+------------------------+
| secure-mode | The secure mode |:meth:`peek_secure_mode`|
| | using the TLS |:meth:`set_secure_mode` |
| | protocol. | |
+----------------+--------------------+------------------------+
*Object Methods*
.. method:: get(session)
Returns a :class:`syslog_server` object or list of objects with \
syslog server attributes.
Each object can be printed using :func:`pyfos_util.response_print`.\
and individual attributes can be accessed through peek methods.
.. method:: post(session)
Adds members to a list attribute of the object. This method is \
used to add syslog servers.
Example Usage of the Method to Configure a New Syslog Server:
# initialize the syslog server object
syslog_server_obj = pyfos_brocade_logging.syslog_server()
# set the IP address of server
syslog_server_obj.set_server("10.10.10.10")
:param session: The session handler returned by
:func:`pyfos_auth.login`.
:rtype: A dictionary of errors or a success response.
.. method:: patch(session)
Applies configurable attribute(s) within the object to the \
syslog server.
*Below Is an Example Using Individual Sets:*
.. code-block:: python
# initialize the syslog server object
syslog_server_obj = pyfos_brocade_logging.syslog_server()
# set the IP address of server
syslog_server_obj.set_server("10.10.10.10")
# set the port number
syslog_server_obj.set_port("1234")
# set secure mode to true
syslog_server_obj.set_secure_mode(true)
syslog_server_obj.patch(session)
:param session: The session handler returned by
:func:`pyfos_auth.login`.
:rtype: A dictionary of errors or a success response.
.. method:: delete(session)
Deletes members from a list attribute of the object. This method \
deletes the configured syslog server.
Example Usage of the Method to Create New Mappings:
.. code-block:: python
# initialize the syslog server object
syslog_server_obj = pyfos_brocade_logging.syslog_server()
# set the IP address of server
syslog_server_obj.set_server("10.10.10.10")
# delete the syslog server
syslog_server_obj.delete(session)
*Attribute Methods*
.. method:: set_server(server)
Sets the server in the object.
:param server: The IPv4 or IPv6 address or the DNS name of the \
syslog server.
:rtype: A dictionary of errors or a success response.
.. method:: peek_server()
Reads the syslog server in the object.
:rtype: The IP address or DNS name of the server.
.. method:: set_port(port)
Sets the port number in the object.
:param port: The port number of the syslog server.
:rtype: A dictionary of errors or a success response.
.. method:: peek_port()
Reads the port number in the object.
:rtype: The port number in the object.
.. method:: set_secure_mode(true\\/false)
Sets the secure mode in the object.
:param true\\/false: True enables secure mode, false disables it.
:rtype: A dictionary of errors or a success response.
.. method:: peek_secure_mode()
Reads the secure mode in the object.
:rtype: The secure mode (true or false).
"""
def __init__(self, dictvalues={}):
super().__init__(pyfos_rest_util.rest_obj_type.syslog,
"/rest/running/brocade-logging/syslog-server",
version.VER_RANGE_821_and_ABOVE)
self.add(pyfos_rest_util.rest_attribute(
"server", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_KEY))
self.add(pyfos_rest_util.rest_attribute(
"port", pyfos_type.type_int,
None, pyfos_rest_util.REST_ATTRIBUTE_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"secure-mode", pyfos_type.type_bool,
None, pyfos_rest_util.REST_ATTRIBUTE_CONFIG))
self.load(dictvalues, 1)
class error_log(pyfos_rest_util.rest_object):
"""Class of methods to get the attributes of raslog Event
Important Class Members:
+---------------------------+---------------------------+---------------------------------------+
| Attribute name | Description |Frequently used methods |
+===========================+===========================+=======================================+
| sequence-number | Sequence number in raslog |:meth:`peek_sequence_number` |
+---------------------------+---------------------------+---------------------------------------+
| time-stamp | Timestamp of raslog |:meth:`peek_time_stamp` |
+---------------------------+---------------------------+---------------------------------------+
| message-id | Message ID of raslog |:meth:`peek_message_id` |
+---------------------------+---------------------------+---------------------------------------+
| fabric-id | Fabric ID in switch |:meth:`peek_fabric_id` |
| | and 0 in chassis context | |
+---------------------------+---------------------------+---------------------------------------+
| slot-id | Slot ID of CP in chassis |:meth:`peek_slot_id` |
| | or 0 in pizzabox | |
+---------------------------+---------------------------+---------------------------------------+
| severity-level | Severity level of raslog |:meth:`peek_severity_level` |
+---------------------------+---------------------------+---------------------------------------+
| ffdc-event | FFDC status of raslog |:meth:`peek_ffdc_event` |
+---------------------------+---------------------------+---------------------------------------+
| switch-user-friendly-name | Switch or chassis name |:meth:`peek_switch_user_friendly_name` |
| | based on raslog context | |
+---------------------------+---------------------------+---------------------------------------+
| message-text | Message text in raslog |:meth:`peek_message_text` |
+---------------------------+---------------------------+---------------------------------------+
*Object Methods*
.. method:: get(session)
Returns a :class:`error_log` object with attributes from error_log.
Each object can be printed using :func:`pyfos_util.response_print`
and individual attributes can be accessed through peek methods.
:param session: The session handler returned by
:func:`pyfos_auth.login`.
:rtype: A dictionary of errors or a
:class:`error_log` object.
*Attribute Methods*
.. method:: peek_sequence_number()
Reads the sequence number in error_log object.
:rtype: Sequence number
.. method:: peek_time_stamp()
Reads the time-stamp in error_log object.
:rtype: Timestamp
.. method:: peek_message_id()
Reads the message ID in error_log object.
:rtype: Message ID
.. method:: peek_fabric_id()
Reads the fabric ID in error_log object.
:rtype: Fabric ID
.. method:: peek_slot_id()
Reads the slot id in error_log object.
:rtype: Slot ID
.. method:: peek_severity_level()
Reads the severity level in error_log object.
:rtype: Severity level
.. method:: peek_ffdc_event()
Reads the FFDC event status in error_log object.
:rtype: FFDC event status
.. method:: peek_switch_user_friendly_name()
Reads the switch user friendly name in error_log object.
:rtype: Switch user friendly name
.. method:: peek_message_text()
Reads the message text in error_log object.
:rtype: Message text
"""
def __init__(self, dictvalues={}):
super().__init__(pyfos_rest_util.rest_obj_type.error_log,
"/rest/running/brocade-logging/error-log",
version.VER_RANGE_900_and_ABOVE)
self.add(pyfos_rest_util.rest_attribute(
"sequence-number", pyfos_type.type_int,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"time-stamp", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"message-id", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"fabric-id", pyfos_type.type_int,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"slot-id", pyfos_type.type_int,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"severity-level", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"ffdc-event", pyfos_type.type_bool,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))
self.add(pyfos_rest_util.rest_attribute(
"switch-user-friendly-name", pyfos_type.type_str,
None, pyfos_rest_util.REST_ATTRIBUTE_NOT_CONFIG))