-
Notifications
You must be signed in to change notification settings - Fork 15
/
clone_template.py
1299 lines (1138 loc) · 44.9 KB
/
clone_template.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
"""
-------------------------------------------------------------------------------
Written by Thomas Munzer ([email protected])
Github repository: https://github.com/tmunzer/Mist_library/
This script is licensed under the MIT License.
-------------------------------------------------------------------------------
Python script to clone a specific template from an organization to another (or
the same) organization.
The script is tacking care of also cloning the other configuration used by the
template:
- WLAN Template: wlans, wxtags, wxrules
- SWITCH Templates: N/A
- WAN Templates: networks, services, service policies
- HUB Profiles: networks, services, service policies
This script will not change/create/delete any existing objects in the source
organization. It will just retrieve every single object from it. However, it
will deploy all the configuration objects (except the devices) to the
destination organization.
-------
Requirements:
mistapi: https://pypi.org/project/mistapi/
-------
Usage:
This script can be run as is (without parameters), or with the options below.
If no options are defined, or if options are missing, the missing options will
be asked by the script or the default values will be used.
It is recommended to use an environment file to store the required information
to request the Mist Cloud (see https://pypi.org/project/mistapi/ for more
information about the available parameters).
-------
Script Parameters:
-h, --help display this help
--src_oid= Optional, org_id of the org to clone
--dst_oid= Optional, org_id of the org where to clone the src_org,
if the org already exists
--dst_org_name= Optional, name of the org where to clone the src_org.
If dst_org_id is defined (org already exists), will be
used for validation, if dst_org_id is not defined, a
new org will be created
--template_type= Type of template to clone. Options are:
- wlan
- lan
- wan
- hub
--template_id= ID of the template to clone
--dst_template_name= Name of the cloned template. Required if the template
is clone into the same org
--src_env= Optional, env file to use to access the src org (see
mistapi env file documentation here:
https://pypi.org/project/mistapi/)
default is "~/.mist_env"
--dst_env= Optional, env file to use to access the dst org (see
mistapi env file documentation here:
https://pypi.org/project/mistapi/)
default is "~/.mist_env"
-l, --log_file= define the filepath/filename where to write the logs
default is "./script.log"
-------
Examples:
python3 ./clone_template.py
python3 ./clone_template.py --src_env=~/.mist_env \
--src_oid=203d3d02-xxxx-xxxx-xxxx-76896a3330f4 \
--dst_oid=b9953384-xxxx-xxxx-xxxx-ed26c44f44e9 \
--dst_org_name="TM LAB API" \
--template_type=lan \
--template_id=1d9293b5-xxxx-xxxx-xxxx-ad62feba6f93
"""
import sys
import json
import logging
import getopt
MISTAPI_MIN_VERSION = "0.44.1"
try:
import mistapi
from mistapi.__logger import console
except:
print(
"""
Critical:
\"mistapi\" package is missing. Please use the pip command to install it.
# Linux/macOS
python3 -m pip install mistapi
# Windows
py -m pip install mistapi
"""
)
sys.exit(2)
#####################################################################
#### PARAMETERS #####
LOG_FILE = "./script.log"
#####################################################################
#### LOGS ####
LOGGER = logging.getLogger(__name__)
TEMPLATE_TYPES = ["WLAN Template", "SWITCH Template", "WAN Template", "HUB Profile"]
TEMPLATE_VALUES = ["wlan", "lan", "wan", "hub"]
#####################################################################
# PROGRESS BAR AND DISPLAY
class ProgressBar:
"""
PROGRESS BAR AND DISPLAY
"""
def __init__(self):
self.steps_total = 0
self.steps_count = 0
def _pb_update(self, size: int = 80):
if self.steps_count > self.steps_total:
self.steps_count = self.steps_total
percent = self.steps_count / self.steps_total
delta = 17
x = int((size - delta) * percent)
print(f"Progress: ", end="")
print(f"[{'█'*x}{'.'*(size-delta-x)}]", end="")
print(f"{int(percent*100)}%".rjust(5), end="")
def _pb_new_step(
self,
message: str,
result: str,
inc: bool = False,
size: int = 80,
display_pbar: bool = True,
):
if inc:
self.steps_count += 1
text = f"\033[A\033[F{message}"
print(f"{text} ".ljust(size + 4, "."), result)
print("".ljust(80))
if display_pbar:
self._pb_update(size)
def _pb_title(
self, text: str, size: int = 80, end: bool = False, display_pbar: bool = True
):
print("\033[A")
print(f" {text} ".center(size, "-"), "\n")
if not end and display_pbar:
print("".ljust(80))
self._pb_update(size)
def set_steps_total(self, steps_total: int):
self.steps_total = steps_total
def log_message(self, message, display_pbar: bool = True):
self._pb_new_step(message, " ", display_pbar=display_pbar)
def log_debug(self, message):
LOGGER.debug(f"{message}")
def log_success(self, message, inc: bool = False, display_pbar: bool = True):
LOGGER.info(f"{message}: Success")
self._pb_new_step(
message, "\033[92m\u2714\033[0m\n", inc=inc, display_pbar=display_pbar
)
def log_warning(self, message, inc: bool = False, display_pbar: bool = True):
LOGGER.warning(f"{message}")
self._pb_new_step(
message, "\033[93m\u2B58\033[0m\n", inc=inc, display_pbar=display_pbar
)
def log_failure(self, message, inc: bool = False, display_pbar: bool = True):
LOGGER.error(f"{message}: Failure")
self._pb_new_step(
message, "\033[31m\u2716\033[0m\n", inc=inc, display_pbar=display_pbar
)
def log_title(self, message, end: bool = False, display_pbar: bool = True):
LOGGER.info(message)
self._pb_title(message, end=end, display_pbar=display_pbar)
PB = ProgressBar()
#####################################################################
#### WLAN TEMPLATE ####
def _get_wlan_template(
src_session: mistapi.APISession, src_oid: str, src_template_id: str
):
try:
message = f"WLAN Template: retrieving {src_template_id}"
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.templates.getOrgTemplate(
src_session, src_oid, src_template_id
)
if resp.status_code == 200:
PB.log_success(message, display_pbar=False)
return resp.data
else:
PB.log_failure(message, display_pbar=False)
return None
except:
PB.log_failure(message, display_pbar=False)
return None
def _deploy_wlan_template(
dst_session: mistapi.APISession, dst_oid: str, template: dict
):
try:
message = f"WLAN Template: deploying {template.get('name')}"
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.templates.createOrgTemplate(
dst_session, dst_oid, template
)
if resp.status_code == 200:
PB.log_success(message, display_pbar=False)
return resp.data.get("id")
else:
PB.log_failure(message, display_pbar=False)
LOGGER.debug(
f"_deploy_wlan_template:unable to create {template.get('name')} in dst org"
)
return None
except:
PB.log_failure(message, display_pbar=False)
LOGGER.debug(
f"_deploy_wlan_template:unable to create {template.get('name')} in dst org"
)
LOGGER.error("Exception occurred", exc_info=True)
return None
########################
def _get_wlans(src_session: mistapi.APISession, src_oid: str, src_template_id: str):
wlans = []
try:
message = f"WLANS: retrieving for template {src_template_id}"
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.wlans.listOrgWlans(src_session, src_oid)
if resp.status_code == 200:
data = mistapi.get_all(src_session, resp)
for wlan in data:
if wlan.get("template_id") == src_template_id:
wlans.append(wlan)
PB.log_success(message, display_pbar=False)
return wlans
else:
PB.log_failure(message, display_pbar=False)
return wlans
except:
PB.log_failure(message, display_pbar=False)
return wlans
def _deploy_wlans(dst_session: mistapi.APISession, dst_oid: str, wlan: dict):
old_id = None
new_id = None
try:
message = f"WLAN: deploying {wlan.get('ssid')}"
old_id = wlan.get("id")
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.wlans.createOrgWlan(dst_session, dst_oid, wlan)
if resp.status_code == 200:
PB.log_success(message, display_pbar=False)
new_id = resp.data.get("id")
else:
PB.log_failure(message, display_pbar=False)
LOGGER.debug(
f"_deploy_wlans:unable to create {wlan.get('ssid')} in dst org"
)
except:
PB.log_failure(message, display_pbar=False)
LOGGER.debug(f"_deploy_wlans:unable to create {wlan.get('ssid')} in dst org")
LOGGER.error("Exception occurred", exc_info=True)
return old_id, new_id
########################
def _get_wxrules(src_session: mistapi.APISession, src_oid: str, src_template_id: str):
wxrules = []
try:
message = f"WXRULES: retrieving for template {src_template_id}"
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.wxrules.listOrgWxRules(src_session, src_oid)
if resp.status_code == 200:
data = mistapi.get_all(src_session, resp)
for wxrule in data:
if wxrule.get("template_id") == src_template_id:
wxrules.append(wxrule)
PB.log_success(message, display_pbar=False)
return wxrules
else:
PB.log_failure(message, display_pbar=False)
return wxrules
except:
PB.log_failure(message, display_pbar=False)
return wxrules
def _deploy_wxrules(dst_session: mistapi.APISession, dst_oid: str, wxrules: list):
for wxrule in wxrules:
try:
message = f"WXRULE: deploying {wxrule.get('id')}"
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.wxrules.createOrgWxRule(
dst_session, dst_oid, wxrule
)
if resp.status_code == 200:
PB.log_success(message, display_pbar=False)
else:
PB.log_failure(message, display_pbar=False)
LOGGER.debug(
f"_deploy_wxrules:unable to create wxrule {wxrules.get('order')} in dst org"
)
except:
PB.log_failure(message, display_pbar=False)
LOGGER.debug(
f"_deploy_wxrules:unable to create wxrule {wxrules.get('order')} in dst org"
)
LOGGER.error("Exception occurred", exc_info=True)
########################
def _get_src_wxtags(
src_session: mistapi.APISession, src_oid: str, src_template_id: str
):
wxtags = []
try:
message = f"WXTAGS: retrieving for template {src_template_id}"
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.wxtags.listOrgWxTags(src_session, src_oid)
if resp.status_code == 200:
wxtags = mistapi.get_all(src_session, resp)
PB.log_success(message, display_pbar=False)
return wxtags
else:
PB.log_failure(message, display_pbar=False)
return wxtags
except:
PB.log_failure(message, display_pbar=False)
return wxtags
def _get_dst_wxtags(dst_session: mistapi.APISession, dst_oid: str):
wxtags = []
try:
message = f"WXTAGS: retrieving existing in the dest org"
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.wxtags.listOrgWxTags(dst_session, dst_oid)
if resp.status_code == 200:
wxtags = mistapi.get_all(dst_session, resp)
PB.log_success(message, display_pbar=False)
return wxtags
else:
PB.log_failure(message, display_pbar=False)
return wxtags
except:
PB.log_failure(message, display_pbar=False)
return wxtags
def _deploy_wxtags(dst_session: mistapi.APISession, dst_oid: str, wxtag: dict):
new_id = None
try:
message = f"WXTAG: deploying {wxtag.get('name')}"
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.wxtags.createOrgWxTag(dst_session, dst_oid, wxtag)
if resp.status_code == 200:
PB.log_success(message, display_pbar=False)
new_id = resp.data.get("id")
LOGGER.debug(
f"_deploy_wxtags:{wxtag.get('name')} created in dst org. New id is {new_id}"
)
else:
PB.log_failure(message, display_pbar=False)
LOGGER.debug(
f"_deploy_wxtags:unable to create {wxtag.get('name')} in dst org"
)
except:
PB.log_failure(message, display_pbar=False)
LOGGER.debug(f"_deploy_wxtags:unable to create {wxtag.get('name')} in dst org")
LOGGER.error("Exception occurred", exc_info=True)
return new_id
def _find_or_create_wxtags(
dst_session: mistapi.APISession,
dst_oid: str,
src_wxtag: dict,
dst_wxtags: list,
wlan_mapping: list,
):
src_wxtag_id = src_wxtag.get("id")
src_wxtag_name = src_wxtag.get("name")
LOGGER.debug(f"_find_or_create_wxtags:{src_wxtag_id} is named {src_wxtag_name}")
try:
dst_wxtag = next(
tag for tag in dst_wxtags if tag.get("name") == src_wxtag_name
)
dst_wxtag_id = dst_wxtag.get("id")
dst_wxtag_name = dst_wxtag.get("name")
LOGGER.debug(
f"_find_or_create_wxtags:{src_wxtag_name} already exists in dst org with id {dst_wxtag_id}"
)
message = f"WXTAG: {dst_wxtag_name} already exists in dest org"
PB.log_message(message, display_pbar=False)
PB.log_success(message, display_pbar=False)
except:
LOGGER.debug(
f"_find_or_create_wxtags:{src_wxtag_name} does not exists in dst org"
)
if src_wxtag.get("match") == "wlan_id":
LOGGER.debug(
f"_find_or_create_wxtags:{src_wxtag_name} is a wlan_id wxtag"
)
tmp_wlan_id = []
for wlan_id in src_wxtag.get("values", []):
if wlan_mapping.get(wlan_id):
tmp_wlan_id.append(wlan_mapping.get(wlan_id))
LOGGER.debug(
f"_find_or_create_wxtags:{src_wxtag_name} replacing {src_wxtag['values']} with {tmp_wlan_id}"
)
src_wxtag["values"] = tmp_wlan_id
dst_wxtag_id = _deploy_wxtags(dst_session, dst_oid, src_wxtag)
return dst_wxtag_id
########################
def _process_wxrules(
src_session: mistapi.APISession,
dst_session: mistapi.APISession,
src_oid: str,
dst_oid: str,
src_template_id: str,
dst_template_id: str,
wlan_mapping: list,
):
wxrules = _get_wxrules(src_session, src_oid, src_template_id)
src_wxtags = _get_src_wxtags(src_session, src_oid, src_template_id)
dst_wxtags = _get_dst_wxtags(dst_session, dst_oid)
wxtag_mapping = {}
for wxrule in wxrules:
wxrule["template_id"] = dst_template_id
for wxtag_type in [
"src_wxtags",
"dst_wxtags",
"dst_allow_wxtags",
"dst_deny_wxtags",
]:
LOGGER.debug(f"_process_wxrules:processing {wxtag_type}")
tmp_wxtags = []
for wxtag_id in wxrule.get(wxtag_type, []):
if wxtag_mapping.get(wxtag_id):
LOGGER.debug(
f"_process_wxrules:src wxtag id {wxtag_id} already mapped"
)
tmp_wxtags.append(wxtag_mapping.get(wxtag_id))
else:
LOGGER.debug(f"_process_wxrules:src wxtag id {wxtag_id} not mapped")
try:
src_wxtag = next(t for t in src_wxtags if t["id"] == wxtag_id)
LOGGER.debug(
f"_process_wxrules:src wxtag id {wxtag_id} config: {src_wxtag}"
)
dst_wxtag_id = _find_or_create_wxtags(
dst_session, dst_oid, src_wxtag, dst_wxtags, wlan_mapping
)
LOGGER.debug(
f"_process_wxrules:src wxtag id {wxtag_id} mapped to {dst_wxtag_id}"
)
wxtag_mapping[wxtag_id] = dst_wxtag_id
tmp_wxtags.append(dst_wxtag_id)
except:
LOGGER.error("Exception occurred", exc_info=True)
LOGGER.debug(
f"_process_wxrules:{wxtag_type} is {wxrule[wxtag_type]} replaced with {tmp_wxtags}"
)
wxrule[wxtag_type] = tmp_wxtags
_deploy_wxrules(dst_session, dst_oid, wxrules)
def clone_wlan_template(
src_session: mistapi.APISession,
dst_session: mistapi.APISession,
src_oid: str,
dst_oid: str,
src_template_id: str,
dst_template_name: str = None,
):
template = _get_wlan_template(src_session, src_oid, src_template_id)
dst_template_id = None
wlans = _get_wlans(src_session, src_oid, src_template_id)
if dst_template_name:
template["name"] = dst_template_name
if template:
if dst_template_name:
template["name"] = dst_template_name
dst_template_id = _deploy_wlan_template(dst_session, dst_oid, template)
if dst_template_id:
wlan_mapping = {}
for wlan in wlans:
wlan["template_id"] = dst_template_id
old_id, new_id = _deploy_wlans(dst_session, dst_oid, wlan)
wlan_mapping[old_id] = new_id
_process_wxrules(
src_session,
dst_session,
src_oid,
dst_oid,
src_template_id,
dst_template_id,
wlan_mapping,
)
#####################################################################
#### SWITCH TEMPLATE ####
def _get_switch_template(
src_session: mistapi.APISession, src_oid: str, src_template_id: str
):
try:
message = f"Retrieving network template {src_template_id}"
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.networktemplates.getOrgNetworkTemplate(
src_session, src_oid, src_template_id
)
if resp.status_code == 200:
PB.log_success(message, display_pbar=False)
return resp.data
else:
PB.log_failure(message, display_pbar=False)
return None
except:
PB.log_failure(message, display_pbar=False)
return None
def _deploy_switch_template(
dst_session: mistapi.APISession, dst_oid: str, template: dict
):
try:
message = f"Deploying network template {template.get('name')}"
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.networktemplates.createOrgNetworkTemplate(
dst_session, dst_oid, template
)
if resp.status_code == 200:
PB.log_success(message, display_pbar=False)
else:
PB.log_failure(message, display_pbar=False)
except:
PB.log_failure(message, display_pbar=False)
def clone_switch_template(
src_session: mistapi.APISession,
dst_session: mistapi.APISession,
src_oid: str,
dst_oid: str,
src_template_id: str,
dst_template_name: str = None,
):
template = _get_switch_template(src_session, src_oid, src_template_id)
if dst_template_name:
template["name"] = dst_template_name
if template:
_deploy_switch_template(dst_session, dst_oid, template)
#####################################################################
#### WAN TEMPLATE ####
def _get_wan_template(
src_session: mistapi.APISession, src_oid: str, src_template_id: str
):
try:
message = f"Retrieving gateway template {src_template_id}"
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.gatewaytemplates.getOrgGatewayTemplate(
src_session, src_oid, src_template_id
)
if resp.status_code == 200:
PB.log_success(message, display_pbar=False)
return resp.data
else:
PB.log_failure(message, display_pbar=False)
return None
except:
PB.log_failure(message, display_pbar=False)
return None
def _deploy_wan_template(dst_session: mistapi.APISession, dst_oid: str, template: dict):
try:
message = f"Deploying gateway template {template.get('name')}"
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.gatewaytemplates.createOrgGatewayTemplate(
dst_session, dst_oid, template
)
if resp.status_code == 200:
PB.log_success(message, display_pbar=False)
else:
PB.log_failure(message, display_pbar=False)
except:
PB.log_failure(message, display_pbar=False)
########################
#### HUB PROFILE ####
def _get_device_profile(
src_session: mistapi.APISession, src_oid: str, src_template_id: str
):
try:
message = f"Retrieving gateway template {src_template_id}"
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.deviceprofiles.getOrgDeviceProfile(
src_session, src_oid, src_template_id
)
if resp.status_code == 200:
PB.log_success(message, display_pbar=False)
return resp.data
else:
PB.log_failure(message, display_pbar=False)
return None
except:
PB.log_failure(message, display_pbar=False)
return None
def _deploy_device_profile(
dst_session: mistapi.APISession, dst_oid: str, template: dict
):
try:
message = f"Deploying gateway template {template.get('name')}"
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.deviceprofiles.createOrgDeviceProfiles(
dst_session, dst_oid, template
)
if resp.status_code == 200:
PB.log_success(message, display_pbar=False)
else:
PB.log_failure(message, display_pbar=False)
except:
PB.log_failure(message, display_pbar=False)
########################
def _get_wan_services(src_session: mistapi.APISession, src_oid: str):
try:
message = f"Retrieving gateway services"
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.services.listOrgServices(
src_session, src_oid, limit=1000
)
if resp.status_code == 200:
data = mistapi.get_all(src_session, resp)
PB.log_success(message, display_pbar=False)
return data
else:
PB.log_failure(message, display_pbar=False)
return None
except:
PB.log_failure(message, display_pbar=False)
return None
def _deploy_wan_services(dst_session: mistapi.APISession, dst_oid: str, service: dict):
try:
message = f"Deploying gateway service {service.get('name')}"
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.services.createOrgService(
dst_session, dst_oid, service
)
if resp.status_code == 200:
PB.log_success(message, display_pbar=False)
else:
PB.log_failure(message, display_pbar=False)
except:
PB.log_failure(message, display_pbar=False)
########################
def _get_wan_servicepolicies(src_session: mistapi.APISession, src_oid: str):
try:
message = f"Retrieving gateway service policies"
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.servicepolicies.listOrgServicePolicies(
src_session, src_oid, limit=1000
)
if resp.status_code == 200:
data = mistapi.get_all(src_session, resp)
PB.log_success(message, display_pbar=False)
return data
else:
PB.log_failure(message, display_pbar=False)
return None
except:
PB.log_failure(message, display_pbar=False)
return None
def _deploy_wan_servicepolicy(
dst_session: mistapi.APISession, dst_oid: str, servicepolicy: dict, uuid_map: dict
):
try:
src_tid = servicepolicy.get("id")
message = f"Deploying gateway service policy {servicepolicy.get('name')}"
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.servicepolicies.createOrgServicePolicy(
dst_session, dst_oid, servicepolicy
)
if resp.status_code == 200:
dst_tid = resp.data.get("id")
uuid_map[src_tid] = dst_tid
PB.log_success(message, display_pbar=False)
else:
PB.log_failure(message, display_pbar=False)
except:
PB.log_failure(message, display_pbar=False)
########################
def _get_wan_networks(src_session: mistapi.APISession, src_oid: str):
try:
message = f"Retrieving gateway networks"
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.networks.listOrgNetworks(
src_session, src_oid, limit=1000
)
if resp.status_code == 200:
data = mistapi.get_all(src_session, resp)
PB.log_success(message, display_pbar=False)
return data
else:
PB.log_failure(message, display_pbar=False)
return None
except:
PB.log_failure(message, display_pbar=False)
return None
def _deploy_wan_networks(dst_session: mistapi.APISession, dst_oid: str, network: dict):
try:
message = f"Deploying gateway service {network.get('name')}"
PB.log_message(message, display_pbar=False)
resp = mistapi.api.v1.orgs.networks.createOrgNetwork(
dst_session, dst_oid, network
)
if resp.status_code == 200:
PB.log_success(message, display_pbar=False)
else:
PB.log_failure(message, display_pbar=False)
except:
PB.log_failure(message, display_pbar=False)
########################
def clone_wan_template(
src_session: mistapi.APISession,
dst_session: mistapi.APISession,
src_oid: str,
dst_oid: str,
src_template_id: str,
dst_template_name: str = None,
deviceprofile: bool = False,
):
uuid_map = {}
network_names = []
service_names = []
servicepolicy_ids = []
dst_networks = []
dst_services = []
dst_servicepolicies = []
if not deviceprofile:
template = _get_wan_template(src_session, src_oid, src_template_id)
else:
template = _get_device_profile(src_session, src_oid, src_template_id)
if template:
# PROCESS NETWORKS FROM TEMPLATE
for port, config in template.get("port_config", {}).items():
for network in config.get("networks", []):
if not network in network_names:
network_names.append(network)
# PROCESS SERVICE POLICIES FROM TEMPLATE
for servicepolicy in template.get("service_policies", []):
if servicepolicy.get("servicepolicy_id"):
if not servicepolicy["servicepolicy_id"] in servicepolicy_ids:
servicepolicy_ids.append(servicepolicy["servicepolicy_id"])
else:
for service in servicepolicy.get("services", []):
if not service in service_names:
service_names.append(service)
# PROCESS NETWORKS FROM SRC ORG
if network_names:
src_networks = _get_wan_networks(src_session, src_oid)
for network in src_networks:
if network.get("name") in network_names:
dst_networks.append(network)
# PROCESS SERVICE POLICIES FROM SRC ORG
if servicepolicy_ids:
src_servicepolicies = _get_wan_servicepolicies(src_session, src_oid)
for servicepolicy in src_servicepolicies:
if servicepolicy.get("id") in servicepolicy_ids:
dst_servicepolicies.append(servicepolicy)
for service in servicepolicy.get("services", []):
if not service in service_names:
service_names.append(service)
# PROCESS SERVICES FROM SRC ORG
if service_names:
src_services = _get_wan_services(src_session, src_oid)
for service in src_services:
if service.get("name") in service_names:
dst_services.append(service)
# DEPLOY NETWORKS TO DST ORG
if dst_networks:
for network in dst_networks:
_deploy_wan_networks(dst_session, dst_oid, network)
# DEPLOY SERVICES TO DST ORG
if dst_services:
for service in dst_services:
_deploy_wan_services(dst_session, dst_oid, service)
# DEPLOY SERVICE POLICIES TO DST ORG
if dst_servicepolicies:
for servicepolicy in dst_servicepolicies:
_deploy_wan_servicepolicy(dst_session, dst_oid, servicepolicy, uuid_map)
if uuid_map:
template_string = json.dumps(template)
for sid, did in uuid_map.items():
template_string.replace(sid, did)
template = json.loads(template_string)
if dst_template_name:
template["name"] = dst_template_name
if not deviceprofile:
_deploy_wan_template(dst_session, dst_oid, template)
else:
_deploy_device_profile(dst_session, dst_oid, template)
#######
#######
def _print_new_step(message):
print()
print("".center(80, "*"))
print(f" {message} ".center(80, "*"))
print("".center(80, "*"))
print()
print()
LOGGER.info(f"{message}")
#######
#######
def _check_org_name(
apisession: mistapi.APISession, dst_org_id: str, org_type: str, org_name: str = None
):
if not org_name:
org_name = mistapi.api.v1.orgs.orgs.getOrg(apisession, dst_org_id).data["name"]
while True:
print()
resp = input(
f"To avoid any error, please confirm the current {org_type} orgnization name: "
)
if resp == org_name:
return True
else:
print()
print("The orgnization names do not match... Please try again...")
#######
#######
def _select_org(org_type: str, mist_session=None):
org_id = mistapi.cli.select_org(mist_session)[0]
org_name = mistapi.api.v1.orgs.orgs.getOrg(mist_session, org_id).data["name"]
_check_org_name(mist_session, org_id, org_type, org_name)
return org_id, org_name
def _check_org_name_in_script_param(
apisession: mistapi.APISession, org_id: str, org_name: str = None
):
response = mistapi.api.v1.orgs.orgs.getOrg(apisession, org_id)
if response.status_code != 200:
console.critical(f"Unable to retrieve the org information: {response.data}")
sys.exit(3)
org_name_from_mist = response.data["name"]
if org_name == org_name_from_mist:
return org_id, org_name
else:
console.critical(f"Org name {org_name} does not match the org {org_id}")
sys.exit(0)
def _check_dst_org(
dst_apisession: mistapi.APISession, dst_org_id: str, dst_org_name: str
):
if dst_org_id and dst_org_name:
return _check_org_name_in_script_param(dst_apisession, dst_org_id, dst_org_name)
elif dst_org_id and not dst_org_name:
return _check_org_name(dst_apisession, dst_org_id, "destination")
elif not dst_org_id and not dst_org_name:
_print_new_step("DESTINATION Org")
return _select_org("destination", dst_apisession)
else: # should not since we covered all the possibilities...
sys.exit(0)
def _select_template_type():
while True:
print()
print("Type of template to clone")
for i, template in enumerate(TEMPLATE_TYPES):
print(f"{i}) {template}")
resp = input(
f"Which type of template do you want to clone (0-{len(TEMPLATE_TYPES)-1})? "
)
try:
resp_int = int(resp)
return TEMPLATE_VALUES[resp_int]
except:
print(
f"Invalid input. Only numbers between 0 and {len(TEMPLATE_TYPES)-1} are allowed"
)
def _retrieve_template_list(
src_session: mistapi.APISession, src_oid: str, template_type: str
):
resp = None
if template_type == "wlan":
resp = mistapi.api.v1.orgs.templates.listOrgTemplates(
src_session, src_oid, limit=1000
)
elif template_type == "lan":
resp = mistapi.api.v1.orgs.networktemplates.listOrgNetworkTemplates(
src_session, src_oid, limit=1000
)
elif template_type == "wan":
resp = mistapi.api.v1.orgs.gatewaytemplates.listOrgGatewayTemplates(
src_session, src_oid, limit=1000
)
elif template_type == "hub":
resp = mistapi.api.v1.orgs.deviceprofiles.listOrgDeviceProfiles(
src_session, src_oid, type="gateway", limit=1000
)
else:
print(f"unknown tempate type {template_type}")
sys.exit(2)
return mistapi.get_all(src_session, resp)
def _select_template_to_clone(
src_session: mistapi.APISession, src_oid: str, template_type: str
):
templates = _retrieve_template_list(src_session, src_oid, template_type)
while True:
print()
print("Available templates:")
for i, template in enumerate(templates):
print(f"{i}) {template.get('name')} (id: {template.get('id')})")
resp = input(f"Which template do you want to clone (0-{len(templates)-1})? ")
try:
resp_int = int(resp)
return templates[resp_int].get("id")