-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathintersight_os_installer.py
2380 lines (2234 loc) · 120 KB
/
intersight_os_installer.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
"""
Automated OS Install Tool for Cisco Intersight, v1.4
Author: Ugo Emekauwa
Contact: [email protected], [email protected]
Summary: The Automated OS Install Tool for Cisco Intersight automates the
installation of operating systems on UCS servers managed by Intersight.
GitHub Repository: https://github.com/ugo-emekauwa/intersight-os-installer
"""
import sys
import traceback
import json
import copy
import intersight
import re
import urllib3
import time
import pathlib
import requests
########################
# MODULE REQUIREMENT 1 #
########################
"""
For the following variable below named key_id, please fill in between
the quotes your Intersight API Key ID.
Here is an example:
key_id = "5c89885075646127773ec143/5c82fc477577712d3088eb2f/5c8987b17577712d302eaaff"
"""
key_id = ""
########################
# MODULE REQUIREMENT 2 #
########################
"""
For the following variable below named key, please fill in between
the quotes your system's file path to your Intersight API key "SecretKey.txt"
file.
Here is an example:
key = "C:\\Users\\demouser\\Documents\\SecretKey.txt"
"""
key = ""
########################
# MODULE REQUIREMENT 3 #
########################
"""
Provide the required configuration settings to automate
OS installations on Cisco Intersight. Remove the sample
values and replace them with your own, where applicable.
"""
####### Start Configuration Settings - Provide values for the variables listed below. #######
# General Settings
## NOTE - For the "Server Identifier" key below, the accepted values are the Server serial, name, model, PID (product ID), or user label. This information can be found in Intersight, if needed.
## If there are Server with duplicate names, models, PIDs, or user labels, please use the serial to ensure the correct Server is selected.
## Here is an example using the Server serial: "Server Identifier": " FCH37527777"
## Here is an example using the Server name: "Server Identifier": "UCS-IMM-Pod-1-1"
## Here is an example using the Server model: "Server Identifier": "UCSX-210C-M7"
## Here is an example using the Server PID: "Server Identifier": "UCSX-210C-M7"
## For the "Server Form Factor" key, the options are "Blade or "Rack".
## For the "Server Connection Type" key, the options are "FI-Attached" or "Standalone".
os_install_target_server_id_dictionary = {
"Server Identifier": "UCS-IMM-Pod-1-1",
"Server Form Factor": "Blade",
"Server Connection Type": "FI-Attached"
}
os_install_organization = "default"
os_install_tags = {"Org": "IT", "Dept": "DevOps"} # Empty the os_install_tags dictionary if no tags are needed, for example: os_install_tags = {}
# Operating System Settings
## Add OS Image Link
os_image_link_access_protocol_type = "NFS" # Options: "CIFS", "NFS", "HTTP/S"
os_image_link_file_location = "192.168.1.25/isos/ubuntu-22.04.4-live-server-amd64.iso"
os_image_link_mount_options = ""
os_image_link_access_username = ""
os_image_link_access_password = ""
os_image_link_name = "Ubuntu Server 22.04.2 ISO Image - 001"
os_image_link_vendor = "Ubuntu" # Options: "CentOS", "Citrix", "Microsoft", "Nutanix", "Oracle", "Red Hat", "Rocky Linux, "SuSE", "Ubuntu", "VMware" as of 6/4/24. See Intersight docs for updates.
os_image_link_version = "Ubuntu Server 22.04.2 LTS" # Options: "CentOS 8.3", "Windows Server 2022", "Rocky Linux 9.1", "Ubuntu Server 22.04.2 LTS", "ESXi 8.0 U2", "ESXi 7.0 U3", Etc. See Intersight docs for all available options.
os_image_link_description = "OS Image Link added by the Automated OS Install Tool for Cisco Intersight."
## Select Pre-Loaded OS Image Link (Change only if using an OS Image Link that has already been loaded into the target Intersight account)
pre_loaded_os_image_link = False
pre_loaded_os_image_link_name = ""
## Microsoft Windows Server OS Specific Settings (Only applicable if installing Microsoft Windows Server)
os_install_windows_server_edition = "" # Options: "Standard", "Datacenter", "StandardCore", "DatacenterCore". Provide an empty string ("") if installing other OSs.
# Configuration Settings (Only "File" (Custom File from Local Machine) and "Embedded" configuration sources are supported at this time)
os_install_configuration_file_source = "File" # Options: "File", "Embedded"
## Custom File - Local Machine Configuration Source (Only applicable if os_install_configuration_file_source is set to "File")
os_install_configuration_file_location = "C:\\Users\\demouser\\Documents\\OS Configuration Files\\ubuntu-cloud-config-host1-v1.cfg"
os_install_configuration_file_location_type = "local" # Options: "local", "http"
os_install_remove_return_from_configuration_file = True # NOTE: Change only if there are issues reading the configuration file.
# Server Configuration Utility Settings
## Add SCU Image Link
scu_image_link_access_protocol_type = "NFS" # Options: "CIFS", "NFS", "HTTP/S"
scu_image_link_file_location = "192.168.1.25/isos/ucs-scu-6.3.2c.iso"
scu_image_link_mount_options = ""
scu_image_link_access_username = ""
scu_image_link_access_password = ""
scu_image_link_name = "UCS SCU 6.3(2c) ISO Image - 001"
scu_image_link_version = "6.3(2c)" # Options: "CentOS 8.3", "Windows Server 2022", "Rocky Linux 9.1", "Ubuntu Server 22.04.2 LTS", "ESXi 8.0 U2", etc. See Intersight docs for all available options.
scu_image_link_supported_models = ["UCSX-210C-M6", "UCSX-210C-M7", "UCSB-B200-M5"]
scu_image_link_description = "SCU Image Link added by the Automated OS Install Tool for Cisco Intersight."
## Select Pre-Loaded SCU Image Link (Change only if using a SCU Image Link that has already been loaded into the target Intersight account)
pre_loaded_scu_image_link = False
pre_loaded_scu_image_link_name = ""
# Installation Target Disk Storage Settings (Only "Local Disk" connectivity is supported at this time, Fibre Channel and iSCSI will be added when tested.)
os_install_target_disk_type = "Virtual" # Options: "Virtual", "Physical"
os_install_target_disk_name = "MStorBootVd"
os_install_target_disk_storage_controller_slot = "MSTOR-RAID" # Options: "MSTOR-RAID", "MRAID", "FMEZZ1-SAS", "NVMe-direct-U.2-drives", Etc. See Intersight docs for more options.
os_install_target_disk_virtual_id = "0"
os_install_target_disk_physical_serial_number = ""
# Secure Boot Settings
os_install_secure_boot_override = True
# Misc Settings (Change only if needed)
os_install_name = f"Sample_OS_Install_{int(time.time())}"
os_install_description = f"Sample OS Install launched at {int(time.time())}."
os_install_method = "vMedia" # NOTE: Only "vMedia" is supported at this time by Intersight. iPXE to be supported in the future.
# Intersight Base URL Setting (Change only if using the Intersight Virtual Appliance)
intersight_base_url = "https://www.intersight.com/api/v1"
url_certificate_verification = True
####### Finish Configuration Settings - The required value entries are complete. #######
#############################################################################################################################
#############################################################################################################################
# Suppress InsecureRequestWarning error messages
urllib3.disable_warnings()
# Function to get Intersight API client as specified in the Intersight Python SDK documentation for OpenAPI 3.x
## Modified to align with overall formatting, try/except blocks added for additional error handling, certificate verification option added
def get_api_client(api_key_id,
api_secret_file,
endpoint="https://intersight.com",
url_certificate_verification=True
):
try:
with open(api_secret_file, 'r') as f:
api_key = f.read()
if re.search('BEGIN RSA PRIVATE KEY', api_key):
# API Key v2 format
signing_algorithm = intersight.signing.ALGORITHM_RSASSA_PKCS1v15
signing_scheme = intersight.signing.SCHEME_RSA_SHA256
hash_algorithm = intersight.signing.HASH_SHA256
elif re.search('BEGIN EC PRIVATE KEY', api_key):
# API Key v3 format
signing_algorithm = intersight.signing.ALGORITHM_ECDSA_MODE_DETERMINISTIC_RFC6979
signing_scheme = intersight.signing.SCHEME_HS2019
hash_algorithm = intersight.signing.HASH_SHA256
configuration = intersight.Configuration(
host=endpoint,
signing_info=intersight.signing.HttpSigningConfiguration(
key_id=api_key_id,
private_key_path=api_secret_file,
signing_scheme=signing_scheme,
signing_algorithm=signing_algorithm,
hash_algorithm=hash_algorithm,
signed_headers=[
intersight.signing.HEADER_REQUEST_TARGET,
intersight.signing.HEADER_HOST,
intersight.signing.HEADER_DATE,
intersight.signing.HEADER_DIGEST,
]
)
)
if not url_certificate_verification:
configuration.verify_ssl = False
except Exception:
print("\nA configuration error has occurred!\n")
print("Unable to access the Intersight API Key.")
print("Exiting due to the Intersight API Key being unavailable.\n")
print("Please verify that the correct API Key ID and API Key have "
"been entered, then re-attempt execution.\n")
print("Exception Message: ")
traceback.print_exc()
sys.exit(0)
return intersight.ApiClient(configuration)
# Establish function to test for the availability of the Intersight API and Intersight account
def test_intersight_api_service(intersight_api_key_id,
intersight_api_key,
intersight_base_url="https://www.intersight.com/api/v1",
preconfigured_api_client=None
):
"""This is a function to test the availability of the Intersight API and
Intersight account. The tested Intersight account contains the user who is
the owner of the provided Intersight API Key and Key ID.
Args:
intersight_api_key_id (str):
The ID of the Intersight API key.
intersight_api_key (str):
The system file path of the Intersight API key.
intersight_base_url (str):
Optional; The base URL for Intersight API paths. The default value
is "https://www.intersight.com/api/v1". This value typically only
needs to be changed if using the Intersight Virtual Appliance. The
default value is "https://www.intersight.com/api/v1".
preconfigured_api_client ("ApiClient"):
Optional; An ApiClient class instance which handles
Intersight client-server communication through the use of API keys.
The default value is None. If a preconfigured_api_client argument
is provided, empty strings ("") or None can be provided for the
intersight_api_key_id, intersight_api_key, and intersight_base_url
arguments.
Returns:
A string of the name for the Intersight account tested, verifying the
Intersight API service is up and the Intersight account is accessible.
Raises:
Exception:
An exception occurred due to an issue with the provided API Key
and/or API Key ID.
"""
# Define Intersight SDK ApiClient variable
if preconfigured_api_client is None:
api_client = get_api_client(api_key_id=intersight_api_key_id,
api_secret_file=intersight_api_key,
endpoint=intersight_base_url
)
else:
api_client = preconfigured_api_client
try:
# Check that Intersight Account is accessible
print("Testing access to the Intersight API by verifying the "
"Intersight account information...")
api_client.call_api(resource_path="/iam/Accounts",
method="GET",
auth_settings=['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']
)
response = api_client.last_response.data
iam_account = json.loads(response)
if api_client.last_response.status != 200:
print("\nThe Intersight API and Account Availability Test did not "
"pass.")
print("The Intersight account information could not be verified.")
print("Exiting due to the Intersight account being unavailable.\n")
print("Please verify that the correct API Key ID and API Key have "
"been entered, then re-attempt execution.\n")
sys.exit(0)
else:
intersight_account_name = iam_account["Results"][0]["Name"]
print("The Intersight API and Account Availability Test has "
"passed.\n")
print(f"The Intersight account named '{intersight_account_name}' "
"has been found.")
return intersight_account_name
except Exception:
print("\nA configuration error has occurred!\n")
print("Unable to access the Intersight API.")
print("Exiting due to the Intersight API being unavailable.\n")
print("Please verify that the correct API Key ID and API Key have "
"been entered, then re-attempt execution.\n")
print("Exception Message: ")
traceback.print_exc()
sys.exit(0)
# Establish function to retrieve the MOID of a specific Intersight API object by name
def intersight_object_moid_retriever(intersight_api_key_id,
intersight_api_key,
object_name,
intersight_api_path,
object_type="object",
organization="default",
intersight_base_url="https://www.intersight.com/api/v1",
preconfigured_api_client=None
):
"""This is a function to retrieve the MOID of Intersight objects
using the Intersight API.
Args:
intersight_api_key_id (str):
The ID of the Intersight API key.
intersight_api_key (str):
The system file path of the Intersight API key.
object_name (str):
The name of the Intersight object.
intersight_api_path (str):
The Intersight API path of the Intersight object.
object_type (str):
Optional; The type of Intersight object. The default value is
"object".
organization (str):
Optional; The Intersight organization of the Intersight object.
The default value is "default".
intersight_base_url (str):
Optional; The base URL for Intersight API paths. The default value
is "https://www.intersight.com/api/v1". This value typically only
needs to be changed if using the Intersight Virtual Appliance.
preconfigured_api_client ("ApiClient"):
Optional; An ApiClient class instance which handles
Intersight client-server communication through the use of API keys.
The default value is None. If a preconfigured_api_client argument
is provided, empty strings ("") or None can be provided for the
intersight_api_key_id, intersight_api_key, and intersight_base_url
arguments.
Returns:
A string of the MOID for the provided Intersight object.
Raises:
Exception:
An exception occurred due to an issue accessing the Intersight API
path. The status code or error message will be specified.
"""
# Define Intersight SDK ApiClient variable
if preconfigured_api_client is None:
api_client = get_api_client(api_key_id=intersight_api_key_id,
api_secret_file=intersight_api_key,
endpoint=intersight_base_url
)
else:
api_client = preconfigured_api_client
try:
# Retrieve the Intersight Account name
api_client.call_api(resource_path="/iam/Accounts",
method="GET",
auth_settings=['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']
)
response = api_client.last_response.data
iam_account = json.loads(response)
if api_client.last_response.status != 200:
print("The provided Intersight account information could not be "
"accessed.")
print("Exiting due to the Intersight account being unavailable.\n")
print("Please verify that the correct API Key ID and API Key have "
"been entered, then re-attempt execution.\n")
sys.exit(0)
else:
intersight_account_name = iam_account["Results"][0]["Name"]
except Exception:
print("\nA configuration error has occurred!\n")
print("Unable to access the Intersight API.")
print("Exiting due to the Intersight API being unavailable.\n")
print("Please verify that the correct API Key ID and API Key have "
"been entered, then re-attempt execution.\n")
sys.exit(0)
# Retrieving the provided object from Intersight...
full_intersight_api_path = f"/{intersight_api_path}"
try:
api_client.call_api(resource_path=full_intersight_api_path,
method="GET",
auth_settings=['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']
)
response = api_client.last_response.data
intersight_objects = json.loads(response)
# The Intersight API resource path has been accessed successfully.
except Exception:
print("\nA configuration error has occurred!\n")
print("There was an issue retrieving the "
f"{object_type} from Intersight.")
print("Unable to access the provided Intersight API resource path "
f"'{intersight_api_path}'.")
print("Please review and resolve any error messages, then re-attempt "
"execution.\n")
print("Exception Message: ")
traceback.print_exc()
sys.exit(0)
if intersight_objects.get("Results"):
for intersight_object in intersight_objects.get("Results"):
if intersight_object.get("Organization"):
provided_organization_moid = intersight_object_moid_retriever(intersight_api_key_id=None,
intersight_api_key=None,
object_name=organization,
intersight_api_path="organization/Organizations?$top=1000",
object_type="Organization",
preconfigured_api_client=api_client
)
if intersight_object.get("Organization", {}).get("Moid") == provided_organization_moid:
if intersight_object.get("Name") == object_name:
intersight_object_moid = intersight_object.get("Moid")
# The provided object and MOID has been identified and retrieved.
return intersight_object_moid
else:
if intersight_object.get("Name") == object_name:
intersight_object_moid = intersight_object.get("Moid")
# The provided object and MOID has been identified and retrieved.
return intersight_object_moid
else:
print("\nA configuration error has occurred!\n")
print(f"The provided {object_type} named '{object_name}' was not "
"found.")
print("Please check the Intersight Account named "
f"{intersight_account_name}.")
print("Verify through the API or GUI that the needed "
f"{object_type} is present.")
print(f"If the needed {object_type} is missing, please create it.")
print("Once the issue has been resolved, re-attempt execution.\n")
sys.exit(0)
else:
print("\nA configuration error has occurred!\n")
print(f"The provided {object_type} named '{object_name}' was not "
"found.")
print(f"No requested {object_type} instance is currently available in "
f"the Intersight account named {intersight_account_name}.")
print("Please check the Intersight Account named "
f"{intersight_account_name}.")
print(f"Verify through the API or GUI that the needed {object_type} "
"is present.")
print(f"If the needed {object_type} is missing, please create it.")
print("Once the issue has been resolved, re-attempt execution.\n")
sys.exit(0)
# Establish function to retrieve all instances of a particular Intersight API object type
def get_intersight_objects(intersight_api_key_id,
intersight_api_key,
intersight_api_path,
object_type="object",
intersight_base_url="https://www.intersight.com/api/v1",
preconfigured_api_client=None
):
"""This is a function to perform an HTTP GET on all objects under an
available Intersight API type.
Args:
intersight_api_key_id (str):
The ID of the Intersight API key.
intersight_api_key (str):
The system file path of the Intersight API key.
intersight_api_path (str):
The path to the targeted Intersight API object type. For example,
to specify the Intersight API type for adapter configuration
policies, enter "adapter/ConfigPolicies". More API types can be
found in the Intersight API reference library at
https://intersight.com/apidocs/introduction/overview/.
object_type (str):
Optional; The type of Intersight object. The default value is
"object".
intersight_base_url (str):
Optional; The base URL for Intersight API paths. The default value
is "https://www.intersight.com/api/v1". This value typically only
needs to be changed if using the Intersight Virtual Appliance.
preconfigured_api_client ("ApiClient"):
Optional; An ApiClient class instance which handles
Intersight client-server communication through the use of API keys.
The default value is None. If a preconfigured_api_client argument
is provided, empty strings ("") or None can be provided for the
intersight_api_key_id, intersight_api_key, and intersight_base_url
arguments.
Returns:
A dictionary containing all objects of the specified API type. If the
API type is inaccessible, an implicit value of None will be returned.
Raises:
Exception:
An exception occurred due to an issue accessing the Intersight API
path. The status code or error message will be specified.
"""
# Define Intersight SDK ApiClient variable
if preconfigured_api_client is None:
api_client = get_api_client(api_key_id=intersight_api_key_id,
api_secret_file=intersight_api_key,
endpoint=intersight_base_url
)
else:
api_client = preconfigured_api_client
# Retrieving the provided object from Intersight...
full_intersight_api_path = f"/{intersight_api_path}"
try:
api_client.call_api(resource_path=full_intersight_api_path,
method="GET",
auth_settings=['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']
)
response = api_client.last_response.data
intersight_objects = json.loads(response)
# The Intersight API resource path has been accessed successfully.
return intersight_objects
except Exception:
print("\nA configuration error has occurred!\n")
print(f"There was an issue retrieving the requested {object_type} "
"instances from Intersight.")
print("Unable to access the provided Intersight API resource path "
f"'{intersight_api_path}'.")
print("Please review and resolve any error messages, then re-attempt "
"execution.\n")
print("Exception Message: ")
traceback.print_exc()
sys.exit(0)
# Establish function to retrieve a particular instance of a particular Intersight API object type
def get_single_intersight_object(intersight_api_key_id,
intersight_api_key,
intersight_api_path,
object_moid,
object_type="object",
intersight_base_url="https://www.intersight.com/api/v1",
preconfigured_api_client=None
):
"""This is a function to perform an HTTP GET on a single object under an
available Intersight API type.
Args:
intersight_api_key_id (str):
The ID of the Intersight API key.
intersight_api_key (str):
The system file path of the Intersight API key.
intersight_api_path (str):
The path to the targeted Intersight API object type. For example,
to specify the Intersight API type for adapter configuration
policies, enter "adapter/ConfigPolicies". More API types can be
found in the Intersight API reference library at
https://intersight.com/apidocs/introduction/overview/.
object_moid (str):
The MOID of the single Intersight object.
object_type (str):
Optional; The type of Intersight object. The default value is
"object".
intersight_base_url (str):
Optional; The base URL for Intersight API paths. The default value
is "https://www.intersight.com/api/v1". This value typically only
needs to be changed if using the Intersight Virtual Appliance.
preconfigured_api_client ("ApiClient"):
Optional; An ApiClient class instance which handles
Intersight client-server communication through the use of API keys.
The default value is None. If a preconfigured_api_client argument
is provided, empty strings ("") or None can be provided for the
intersight_api_key_id, intersight_api_key, and intersight_base_url
arguments.
Returns:
A dictionary containing all objects of the specified API type. If the
API type is inaccessible, an implicit value of None will be returned.
Raises:
Exception:
An exception occurred due to an issue accessing the Intersight API
path. The status code or error message will be specified.
"""
# Define Intersight SDK ApiClient variable
if preconfigured_api_client is None:
api_client = get_api_client(api_key_id=intersight_api_key_id,
api_secret_file=intersight_api_key,
endpoint=intersight_base_url
)
else:
api_client = preconfigured_api_client
# Retrieving the provided object from Intersight...
full_intersight_api_path = f"/{intersight_api_path}/{object_moid}"
try:
api_client.call_api(resource_path=full_intersight_api_path,
method="GET",
auth_settings=['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']
)
response = api_client.last_response.data
single_intersight_object = json.loads(response)
# The Intersight API resource path has been accessed successfully.
return single_intersight_object
except Exception:
print("\nA configuration error has occurred!\n")
print(f"There was an issue retrieving the requested {object_type} "
"instance from Intersight.")
print("Unable to access the provided Intersight API resource path "
f"'{intersight_api_path}'.")
print("Please review and resolve any error messages, then re-attempt "
"execution.\n")
print("Exception Message: ")
traceback.print_exc()
sys.exit(0)
# Establish advanced function to retrieve Intersight API objects
def advanced_intersight_object_moid_retriever(intersight_api_key_id,
intersight_api_key,
object_attributes,
intersight_api_path,
object_type="object",
organization="default",
intersight_base_url="https://www.intersight.com/api/v1",
preconfigured_api_client=None
):
"""This is a function to retrieve the MOID of Intersight objects based on
various provided attributes using the Intersight API.
Args:
intersight_api_key_id (str):
The ID of the Intersight API key.
intersight_api_key (str):
The system file path of the Intersight API key.
object_attributes (dict):
A dictionary containing the identifying attribute keys and values
of the Intersight object to be found.
intersight_api_path (str):
The Intersight API path of the Intersight object.
object_type (str):
Optional; The type of Intersight object. The default value is
"object".
organization (str):
Optional; The Intersight organization of the Intersight object.
The default value is "default".
intersight_base_url (str):
Optional; The base URL for Intersight API paths. The default value
is "https://www.intersight.com/api/v1". This value typically only
needs to be changed if using the Intersight Virtual Appliance.
preconfigured_api_client ("ApiClient"):
Optional; An ApiClient class instance which handles
Intersight client-server communication through the use of API keys.
The default value is None. If a preconfigured_api_client argument
is provided, empty strings ("") or None can be provided for the
intersight_api_key_id, intersight_api_key, and intersight_base_url
arguments.
Returns:
A string of the MOID for the provided Intersight object.
Raises:
Exception:
An exception occurred due to an issue accessing the Intersight API
path. The status code or error message will be specified.
"""
# Define Intersight SDK ApiClient variable
if preconfigured_api_client is None:
api_client = get_api_client(api_key_id=intersight_api_key_id,
api_secret_file=intersight_api_key,
endpoint=intersight_base_url
)
else:
api_client = preconfigured_api_client
try:
# Retrieve the Intersight Account name
api_client.call_api(resource_path="/iam/Accounts",
method="GET",
auth_settings=['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']
)
response = api_client.last_response.data
iam_account = json.loads(response)
if api_client.last_response.status != 200:
print("The provided Intersight account information could not be "
"accessed.")
print("Exiting due to the Intersight account being unavailable.\n")
print("Please verify that the correct API Key ID and API Key have "
"been entered, then re-attempt execution.\n")
sys.exit(0)
else:
intersight_account_name = iam_account["Results"][0]["Name"]
except Exception:
print("\nA configuration error has occurred!\n")
print("Unable to access the Intersight API.")
print("Exiting due to the Intersight API being unavailable.\n")
print("Please verify that the correct API Key ID and API Key have "
"been entered, then re-attempt execution.\n")
sys.exit(0)
# Retrieving the provided object from Intersight...
full_intersight_api_path = f"/{intersight_api_path}"
try:
api_client.call_api(resource_path=full_intersight_api_path,
method="GET",
auth_settings=['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']
)
response = api_client.last_response.data
intersight_objects = json.loads(response)
# The Intersight API resource path has been accessed successfully.
except Exception:
print("\nA configuration error has occurred!\n")
print("There was an issue retrieving the "
f"{object_type} from Intersight.")
print("Unable to access the provided Intersight API resource path "
f"'{intersight_api_path}'.")
print("Please review and resolve any error messages, then re-attempt "
"execution.\n")
print("Exception Message: ")
traceback.print_exc()
sys.exit(0)
if intersight_objects.get("Results"):
for intersight_object in intersight_objects.get("Results"):
if intersight_object.get("Organization"):
provided_organization_moid = intersight_object_moid_retriever(intersight_api_key_id=None,
intersight_api_key=None,
object_name=organization,
intersight_api_path="organization/Organizations?$top=1000",
object_type="Organization",
preconfigured_api_client=api_client
)
if intersight_object.get("Organization", {}).get("Moid") == provided_organization_moid:
for object_attribute in object_attributes:
try:
intersight_object[object_attribute]
except KeyError:
break
if intersight_object.get(object_attribute) != object_attributes.get(object_attribute):
break
else:
intersight_object_moid = intersight_object.get("Moid")
# The provided object and MOID has been identified and retrieved.
return intersight_object_moid
else:
for object_attribute in object_attributes:
try:
intersight_object[object_attribute]
except KeyError:
break
if intersight_object.get(object_attribute) != object_attributes.get(object_attribute):
break
else:
intersight_object_moid = intersight_object.get("Moid")
# The provided object and MOID has been identified and retrieved.
return intersight_object_moid
else:
print("\nA configuration error has occurred!\n")
print(f"The provided {object_type} was not found.")
print("Please check the Intersight Account named "
f"{intersight_account_name}.")
print("Verify through the API or GUI that the needed "
f"{object_type} is present.")
print(f"If the needed {object_type} is missing, please create it.")
print("Once the issue has been resolved, re-attempt execution.\n")
sys.exit(0)
else:
print("\nA configuration error has occurred!\n")
print(f"The provided {object_type} was not found.")
print(f"No requested {object_type} instance is currently available in "
f"the Intersight account named {intersight_account_name}.")
print("Please check the Intersight Account named "
f"{intersight_account_name}.")
print(f"Verify through the API or GUI that the needed {object_type} "
"is present.")
print(f"If the needed {object_type} is missing, please create it.")
print(f"Once the issue has been resolved, re-attempt execution.\n")
sys.exit(0)
# Establish function to convert a list of strings in string type format to list type format.
def string_to_list_maker(string_list,
remove_duplicate_elements_in_list=True
):
"""This function converts a list of strings in string type format to list
type format. The provided string should contain commas, semicolons, or
spaces as the separator between strings. For each string in the list,
leading and rear spaces will be removed. Duplicate strings in the list are
removed by default.
Args:
string_list (str):
A string containing an element or range of elements.
remove_duplicate_elements_in_list (bool):
Optional; A setting to determine whether duplicate elements are
removed from the provided string list. The default value is True.
Returns:
A list of elements.
"""
def string_to_list_separator(string_list,
separator
):
"""This function converts a list of elements in string type format to
list type format using the provided separator. For each element in the
list, leading and rear spaces are removed.
Args:
string_list (str):
A string containing an element or range of elements.
separator (str):
The character to identify where elements in the
list should be separated (e.g., a comma, semicolon,
hyphen, etc.).
Returns:
A list of separated elements that have been stripped of any spaces.
"""
fully_stripped_list = []
# Split string by provided separator and create list of separated elements.
split_list = string_list.split(separator)
for element in split_list:
if element:
# Remove leading spaces from elements in list.
lstripped_element = element.lstrip()
# Remove rear spaces from elements in list.
rstripped_element = lstripped_element.rstrip()
# Populate new list with fully stripped elements.
fully_stripped_list.append(rstripped_element)
return fully_stripped_list
def list_to_list_separator(provided_list,
separator
):
"""This function converts a list of elements in list type format to
list type format using the provided separator. For each element in the
list, leading and rear spaces are removed.
Args:
provided_list (list): A list of elements to be separated.
separator (str): The character to identify where elements in the
list should be separated (e.g., a comma, semicolon,
hyphen, etc.).
Returns:
A list of separated elements that have been stripped of any spaces.
"""
new_list = []
# Split list by provided separator and create new list of separated elements.
for element in provided_list:
if separator in element:
split_provided_list = string_to_list_separator(element, separator)
new_list.extend(split_provided_list)
else:
new_list.append(element)
return new_list
staged_list = []
# Split provided list by spaces.
space_split_list = string_to_list_separator(string_list, " ")
# Split provided list by commas.
post_comma_split_list = list_to_list_separator(space_split_list, ",")
# Split provided list by semicolons.
post_semicolon_split_list = list_to_list_separator(post_comma_split_list, ";")
# Split provided list by hyphens.
for post_semicolon_split_string_set in post_semicolon_split_list:
staged_list.append(post_semicolon_split_string_set)
# Remove duplicates from list if enabled.
if remove_duplicate_elements_in_list:
final_list = list(set(staged_list))
return final_list
# Establish function to load a configuration file
def load_configuration_file(
configuration_file_location,
configuration_file_location_type="local",
remove_return_from_configuration_file=True
):
"""This is a function to load a file containing configuration data in
string format.
Args:
configuration_file_location (str):
The location of the configuration file.
configuration_file_location_type (str):
Optional; The location type for the configuration file. Available
options are "local" for local file paths and "http" for access over
a URL. The default value is "local".
remove_return_from_configuration_file (bool):
Optional; The option to remove any instance of '\r' from the
content of the configuration file. The default value is True.
Returns:
The configuration file data in string format.
Raises:
Exception:
An exception was raised due to an error reading the configuration
file.
"""
# Load the configuration file
try:
if configuration_file_location_type == "local":
configuration_file = pathlib.Path(configuration_file_location)
configuration_file_data = configuration_file.read_text()
if remove_return_from_configuration_file:
return configuration_file_data.replace('\r', '')
else:
return configuration_file_data
elif configuration_file_location_type == "http":
http_configuration_file_url_response = requests.get(configuration_file_location)
if http_configuration_file_url_response.status_code == 200:
if remove_return_from_configuration_file:
return http_configuration_file_url_response.text.replace('\r', '')
else:
return http_configuration_file_url_response.text
else:
print("\nA configuration error has occurred!\n")
print("There was an issue reading the configuration file at "
"the location:")
print(f"'{configuration_file_location}'\n")
print("The response status code is: "
f"{http_configuration_file_url_response.status_code}\n")
print("Please review and resolve any error messages, then "
"re-attempt execution.\n")
sys.exit(0)
else:
print("\nA configuration error has occurred!\n")
print("There was an issue with the value "
"provided for the configuration_file_location_type argument.")
print(f"The value provided was {configuration_file_location_type}.")
print("To proceed, the value provided for the "
"configuration_file_location_type argument should be "
"updated to an accepted string format.")
print("The accepted values are 'local' or 'http'.")
print("Please update the argument, then re-attempt "
"execution.\n")
sys.exit(0)
except Exception:
print("\nA configuration error has occurred!\n")
print("There was an issue reading the configuration file at the location:")
print(f"'{configuration_file_location}'\n")
print("Please review and resolve any error messages, then re-attempt "
"execution.\n")
print("Exception Message: ")
traceback.print_exc()
sys.exit(0)
# Establish function to retrieve target server data
def retrieve_target_server_data(
intersight_api_key_id,
intersight_api_key,
server_identifier,
server_form_factor="Blade",
server_connection_type="FI-Attached",
intersight_base_url="https://www.intersight.com/api/v1",
preconfigured_api_client=None
):
"""
This is a function to retrieve data for the target server of an
Intersight OS install.
Args:
intersight_api_key_id (str):
The ID of the Intersight API key.
intersight_api_key (str):
The system file path of the Intersight API key.
server_identifier (str):
The identifier of the target server for the OS install.
server_form_factor (str):
Optional; The form factor of the target server. The accepted values
are "Blade" or "Rack". The default value is "Blade".
server_connection_type (str):
Optional; The connection type of the target server. The accepted
values are "FI-Attached" or "Standalone". IMM (Intersight Managed
Mode) environments should use "FI-Attached". The default value is
"FI-Attached".
intersight_base_url (str):
Optional; The base URL for Intersight API paths. The default value
is "https://www.intersight.com/api/v1". This value typically only
needs to be changed if using the Intersight Virtual Appliance.
preconfigured_api_client ("ApiClient"):
Optional; An ApiClient class instance which handles
Intersight client-server communication through the use of API keys.
The default value is None. If a preconfigured_api_client argument
is provided, empty strings ("") or None can be provided for the
intersight_api_key_id, intersight_api_key, and intersight_base_url
arguments.
Returns:
A dictionary with the data needed for the "Server" attribute of the
Intersight OS Install object.
"""
# Define Intersight SDK ApiClient variable
if preconfigured_api_client is None:
api_client = get_api_client(api_key_id=intersight_api_key_id,
api_secret_file=intersight_api_key,
endpoint=intersight_base_url
)
else:
api_client = preconfigured_api_client
try:
# Retrieve the Intersight Account name
api_client.call_api(resource_path="/iam/Accounts",
method="GET",
auth_settings=['cookieAuth', 'http_signature', 'oAuth2', 'oAuth2']
)
response = api_client.last_response.data
iam_account = json.loads(response)
if api_client.last_response.status != 200:
print("The provided Intersight account information could not be "
"accessed.")
print("Exiting due to the Intersight account being unavailable.\n")
print("Please verify that the correct API Key ID and API Key have "
"been entered, then re-attempt execution.\n")
sys.exit(0)
else:
intersight_account_name = iam_account["Results"][0]["Name"]
except Exception:
print("\nA configuration error has occurred!\n")
print("Unable to access the Intersight API.")