diff --git a/.gitignore b/.gitignore index 7672c6c..b931b33 100755 --- a/.gitignore +++ b/.gitignore @@ -19,3 +19,4 @@ build/ *.egg-info/ *.log +*.swp diff --git a/python/get_cluster_info_v3/.gitignore b/python/get_cluster_info_v3/.gitignore new file mode 100644 index 0000000..8a3e402 --- /dev/null +++ b/python/get_cluster_info_v3/.gitignore @@ -0,0 +1,2 @@ + venv/ +*.html diff --git a/python/get_cluster_info_v3/get_cluster_info_v3.py b/python/get_cluster_info_v3/get_cluster_info_v3.py index 3576200..35372b5 100755 --- a/python/get_cluster_info_v3/get_cluster_info_v3.py +++ b/python/get_cluster_info_v3/get_cluster_info_v3.py @@ -57,8 +57,11 @@ def __init__(self): self.read_timeout = 10 self.entity_response_length = 20 # these are the supported entities for this environment + # self.supported_entities = ['vm', 'subnet', 'cluster', 'project', + # 'network_security_rule', 'image', + # 'host', 'blueprint', 'app'] self.supported_entities = ['vm', 'subnet', 'cluster', 'project', - 'network_security_rule', 'image', + 'image', 'host', 'blueprint', 'app'] def __repr__(self): @@ -239,8 +242,11 @@ def generate_template(json_results): it should be a relatively simple task to update this list to support those entities ''' + # supported_entities = [ + # 'vm', 'subnet', 'cluster', 'project', 'network_security_rule', + # 'image', 'host', 'blueprint', 'app'] supported_entities = [ - 'vm', 'subnet', 'cluster', 'project', 'network_security_rule', + 'vm', 'subnet', 'cluster', 'project', 'image', 'host', 'blueprint', 'app'] for row_label in supported_entities: HTML_ROWS[row_label] = '' @@ -269,6 +275,7 @@ def generate_template(json_results): # VM # ########## if json_result[0] == 'vm': + print("Processing VMs ...") try: for vm in json_result[1]['entities']: entity_name = vm["spec"]["cluster_reference"]["name"] @@ -290,6 +297,7 @@ def generate_template(json_results): # SUBNET # ########## elif json_result[0] == 'subnet': + print("Processing subnets ...") try: for subnet in json_result[1]['entities']: entity_name = subnet["spec"]["cluster_reference"]["name"] @@ -306,6 +314,7 @@ def generate_template(json_results): # PROJECT # ########### elif json_result[0] == 'project': + print("Processing projects ...") vm_total = 0 cpu_total = 0 storage_total = 0 @@ -358,16 +367,20 @@ def generate_template(json_results): ######################### # NETWORK_SECURITY_RULE # + # NO LONGER SUPPORTED # ######################### - elif json_result[0] == 'network_security_rule': - for network_security_rule in json_result[1]['entities']: - entity_name = network_security_rule['spec']['name'] - HTML_ROWS['network_security_rule'] += (f'{entity_name}' - '') + # elif json_result[0] == 'network_security_rule': + # print("Processing network security rules ...") + # for network_security_rule in json_result[1]['entities']: + # entity_name = network_security_rule['spec']['name'] + # HTML_ROWS['network_security_rule'] += (f'{entity_name}' + # '') + ######### # IMAGE # ######### elif json_result[0] == 'image': + print("Processing images ...") try: for image in json_result[1]['entities']: entity_name = image["status"]["name"] @@ -384,6 +397,7 @@ def generate_template(json_results): # HOST # ######## elif json_result[0] == 'host': + print("Processing hosts ...") try: for host in json_result[1]['entities']: if 'name' in host['status']: @@ -425,6 +439,7 @@ def generate_template(json_results): # CLUSTER # ########### elif json_result[0] == 'cluster': + print("Processing clusters ...") for cluster in json_result[1]['entities']: try: cluster_ip = ((cluster['spec']['resources']['network'] @@ -461,6 +476,7 @@ def generate_template(json_results): # BLUEPRINT # ############# elif json_result[0] == 'blueprint': + print("Processing blueprints ...") try: for blueprint in json_result[1]['entities']: entity_name = blueprint["status"]["name"] @@ -486,6 +502,7 @@ def generate_template(json_results): # APP # ####### elif json_result[0] == 'app': + print("Processing apps ...") for app in json_result[1]['entities']: try: entity_name = app['status']['name'] @@ -508,8 +525,8 @@ def generate_template(json_results): specify the HTML page template ''' - current_path = os.path.dirname(sys.argv[0]) - + current_path = os.path.dirname(os.path.realpath(__file__)) + if os.path.isfile(f'{current_path}/templates/nutanixv3.html'): template_name = f'{current_path}/templates/nutanixv3.html' else: @@ -529,7 +546,7 @@ def generate_template(json_results): vms=str(HTML_ROWS['vm']), subnets=str(HTML_ROWS['subnet']), projects=str(HTML_ROWS['project']), - network_security_rules=str(HTML_ROWS['network_security_rule']), + # network_security_rules=str(HTML_ROWS['network_security_rule']), images=str(HTML_ROWS['image']), hosts=str(HTML_ROWS['host']), blueprints=str(HTML_ROWS['blueprint']), @@ -539,8 +556,8 @@ def generate_template(json_results): vm_total=str(ENTITY_TOTALS['vm']), subnet_total=str(ENTITY_TOTALS['subnet']), project_total=str(ENTITY_TOTALS['project']), - network_security_rule_total=str( - ENTITY_TOTALS['network_security_rule']), + # network_security_rule_total=str( + # ENTITY_TOTALS['network_security_rule']), image_total=str(ENTITY_TOTALS['image']), host_total=str(ENTITY_TOTALS['host']), blueprint_total=str(ENTITY_TOTALS['blueprint']), @@ -600,7 +617,7 @@ def main(): practices ''' - current_path = os.path.dirname(sys.argv[0]) + current_path = os.path.dirname(os.path.realpath(__file__)) ''' make sure our template exists @@ -656,6 +673,7 @@ def main(): print('Iterating over all supported endpoints ...\n') for endpoint in endpoints: + print(f"Processing {endpoint['name_plural']} ...") client = ApiClient( environment_options.cluster_ip, f'{endpoint["name_plural"]}/list', diff --git a/python/get_cluster_info_v3/readme.rst b/python/get_cluster_info_v3/readme.rst index 5ba68c6..e63f56e 100755 --- a/python/get_cluster_info_v3/readme.rst +++ b/python/get_cluster_info_v3/readme.rst @@ -70,6 +70,13 @@ All the steps below assume you have a terminal session running with the current - **self.entity_response_length** - Dictates how many entities are returned from a single request. **Maximum** value can be **500**. - **self.read_timeout** - Increase or decrease depending on the desired timeout delay (in seconds) for each request +Templates +========= + +An example template has been included with this repository. + +- Rename `templates/nutanixv3.html.example` to `templates/nutnixv3.html`, if required. + Script Command Line =================== diff --git a/python/get_cluster_info_v3/requirements.txt b/python/get_cluster_info_v3/requirements.txt new file mode 100644 index 0000000..491c9b3 --- /dev/null +++ b/python/get_cluster_info_v3/requirements.txt @@ -0,0 +1,2 @@ +urllib3==2.2.2 +requests==2.32.3 diff --git a/python/get_cluster_info_v3/templates/nutanixv3.html.example b/python/get_cluster_info_v3/templates/nutanixv3.html.example new file mode 100644 index 0000000..314bcbe --- /dev/null +++ b/python/get_cluster_info_v3/templates/nutanixv3.html.example @@ -0,0 +1,177 @@ + + + + + + Prism Central Details (API v3) + + + + + + + +
+ +

The Prism Central information shown in this page is intended for demo purposes only.

+

Please be aware that the totals shown in parentheses next to each entity type are accurate for each entity type, but includes deleted entities. This is particularly applicable to entities such as blueprints and apps.

+ +
+
Clusters ($cluster_total)
+
+ + + + + + + + + + $clusters + +
TypeNameIP addressSoftwareCE?
+
+
+ +
+
Hosts ($host_total)
+
+ + + + + + + + + + $hosts + +
NameS/NIPCVM IP# of VMs
+
+
+ +
+
VMs ($vm_total)
+
+ + + + + + + $vms + +
Cluster:NameDescription
+
+
+ +
+
Subnets ($subnet_total)
+
+ + + + + + + $subnets + +
NameCluster
+
+
+ +
+
Projects ($project_total)
+
+ + + + + + + + + + $projects + +
NameVMsvCPUsStorage (GB)RAM (GB)
+
+
+ +
+
Apps ($app_total)
+
+ + + + + + + + $apps + +
NameProjectStatus
+
+
+ +
+
Blueprints ($blueprint_total)
+
+ + + + + + + + $blueprints + +
NameProjectStatus
+
+
+ + + +
+
Images ($image_total)
+
+ + + + + + + $images + +
NameImage Type
+
+
+ +
+ +
+ Nutanix cluster details generated on $day at $now by $username on $computer_name +
+ + + + diff --git a/python/v4api_sdk/batch_ops_actions.py b/python/v4api_sdk/batch_ops_actions.py new file mode 100644 index 0000000..0c8262c --- /dev/null +++ b/python/v4api_sdk/batch_ops_actions.py @@ -0,0 +1,286 @@ +""" +Use the Nutanix v4 API SDKs to demonstrate Prism batch ACTION operations +Requires Prism Central 2024.1 or later and AOS 6.8 or later +""" + +import getpass +import argparse +import sys +import urllib3 +from pprint import pprint + +import ntnx_prism_py_client +from ntnx_prism_py_client import Configuration as PrismConfiguration +from ntnx_prism_py_client import ApiClient as PrismClient +from ntnx_prism_py_client.rest import ApiException as PrismException + +import ntnx_vmm_py_client +from ntnx_vmm_py_client import Configuration as VMMConfiguration +from ntnx_vmm_py_client import ApiClient as VMMClient +from ntnx_vmm_py_client.rest import ApiException as VMMException + +from ntnx_vmm_py_client.models.vmm.v4.ahv.config.AssociateVmCategoriesParams import ( + AssociateVmCategoriesParams, +) +from ntnx_vmm_py_client.models.vmm.v4.ahv.config.CategoryReference import ( + CategoryReference, +) + +from ntnx_prism_py_client.models.prism.v4.operations.BatchSpec import BatchSpec +from ntnx_prism_py_client.models.prism.v4.operations.BatchSpecMetadata import ( + BatchSpecMetadata, +) +from ntnx_prism_py_client.models.prism.v4.operations.BatchSpecPayload import ( + BatchSpecPayload, +) +from ntnx_prism_py_client.models.prism.v4.operations.BatchSpecPayloadMetadata import ( + BatchSpecPayloadMetadata, +) +from ntnx_prism_py_client.models.prism.v4.operations.BatchSpecPayloadMetadataHeader import ( + BatchSpecPayloadMetadataHeader, +) +from ntnx_prism_py_client.models.prism.v4.operations.BatchSpecPayloadMetadataPath import ( + BatchSpecPayloadMetadataPath, +) + +from ntnx_prism_py_client.models.prism.v4.operations.ActionType import ActionType + + +from tme import Utils + + +def confirm_entity(api, client, entity_name: str) -> str: + """ + make sure the user is selecting the correct entity + """ + instance = api(api_client=client) + print(f"Retrieving {entity_name} list ...") + + try: + if entity_name == "category": + # this filter is specific to this code sample and would need + # to be modified before use elsewhere + entities = instance.list_categories( + async_req=False, + _filter="type eq Schema.Enums.CategoryType'USER' and not contains(key, 'Calm')", + ) + else: + print(f"{entity_name} is not supported. Exiting.") + sys.exit() + except PrismException as ex: + print( + f"\nAn exception occurred while retrieving the {entity_name} list.\ + Details:\n" + ) + print(ex) + sys.exit() + except urllib3.exceptions.MaxRetryError as ex: + print( + f"Error connecting to {client.configuration.host}. Check connectivity, then try again. Details:" + ) + print(ex) + sys.exit() + + # do some verification and make sure the user selects + # the correct entity + found_entities = [] + for entity in entities.data: + found_entities.append( + { + "key": entity.key, + "value": entity.value, + "ext_id": entity.ext_id, + } + ) + print(f"The following categories ({len(found_entities)}) were found.") + pprint(found_entities) + + expected_entity_ext_id = input( + f"\nPlease enter the ext_id of the selected {entity_name}: " + ).lower() + matches = [ + x + for x in found_entities + if x["ext_id"].lower() == expected_entity_ext_id.lower() + ] + if not matches: + print( + f"No {entity_name} was found matching the ext_id \ +{expected_entity_ext_id}. Exiting." + ) + sys.exit() + # get the entity ext_id + ext_id = matches[0]["ext_id"] + return ext_id + + +def main(): + """ + suppress warnings about insecure connections + please consider the security implications before + doing this in a production environment + """ + urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning) + + """ + setup the command line parameters + for this example only two parameters are required + - the Prism Central IP address or FQDN + - the Prism Central username; the script will prompt for the user's password + so that it never needs to be stored in plain text + """ + parser = argparse.ArgumentParser() + parser.add_argument("pc_ip", help="Prism Central IP address or FQDN") + parser.add_argument("username", help="Prism Central username") + parser.add_argument( + "-p", "--poll", help="Time between task polling, in seconds", default=1 + ) + args = parser.parse_args() + + # get the cluster password + cluster_password = getpass.getpass( + prompt="Enter your Prism Central \ +password: ", + stream=None, + ) + + pc_ip = args.pc_ip + username = args.username + poll_timeout = args.poll + + # make sure the user enters a password + if not cluster_password: + while not cluster_password: + print( + "Password cannot be empty. \ + Enter a password or Ctrl-C/Ctrl-D to exit." + ) + cluster_password = getpass.getpass( + prompt="Enter your Prism Central password: ", stream=None + ) + + try: + # create utils instance for re-use later + utils = Utils(pc_ip=pc_ip, username=username, password=cluster_password) + + prism_config = PrismConfiguration() + vmm_config = VMMConfiguration() + for config in [prism_config, vmm_config]: + # create the configuration instances + config.host = pc_ip + config.username = username + config.password = cluster_password + config.verify_ssl = False + + prism_client = PrismClient(configuration=prism_config) + vmm_client = VMMClient(configuration=vmm_config) + + batch_instance = ntnx_prism_py_client.api.BatchesApi(api_client=prism_client) + vmm_instance = ntnx_vmm_py_client.api.VmApi(api_client=vmm_client) + + # vm_extid = "0628ac56-ba0b-4de6-61aa-4ae4e287acdc" + # existing_vm = vmm_instance.get_vm_by_id(vm_extid) + # etag = vmm_client.get_etag(existing_vm) + + input( + "\nThis demo uses the Nutanix v4 API `prism` namespace's \ +batch APIs to assign matching virtual machines to a specific \ +category.\nVM matches are based on a list of VMs built using OData \ +filters to include those with a name containing the string \ +'batchdemo'.\n\nYou will now be prompted for the ext_id of the category \ +to which these VMs will be assigned.\n\nPress ENTER to continue." + ) + + """ + ask the user to confirm the category ext_id + """ + category_ext_id = confirm_entity( + ntnx_prism_py_client.api.CategoriesApi, prism_client, "category" + ) + + print("Building filtered list of existing VMs ...") + print("Note: By default this will retrieve a maximum of 50 VMs.") + vm_list = vmm_instance.list_vms( + async_req=False, _filter="startswith(name, 'batchdemo')" + ) + if vm_list.data: + print(f"{len(vm_list.data)} VM(s) found:") + for vm in vm_list.data: + print(f"- {vm.name}") + else: + print("No matching VMs found. Exiting ...") + sys.exit() + + confirm_action = utils.confirm("Submit batch operation?") + if confirm_action: + # initiate the list of VMs that will be modified + # this is a list of BatchSpecPayload + batch_spec_payload_list = [] + + print("Building VM batch $action payload ...") + for vm in vm_list.data: + existing_vm = vmm_instance.get_vm_by_id(vm.ext_id) + vm_ext_id = existing_vm.data.ext_id + etag = vmm_client.get_etag(existing_vm) + + # build the payload that will be used when assigning categories + batch_spec_payload_list.append( + BatchSpecPayload( + data=AssociateVmCategoriesParams( + categories=[CategoryReference(ext_id=category_ext_id)] + ), + metadata=BatchSpecPayloadMetadata( + headers=[ + BatchSpecPayloadMetadataHeader( + name="If-Match", value=etag + ) + ], + path=[ + BatchSpecPayloadMetadataPath( + name="extId", value=vm_ext_id + ) + ], + ), + ) + ) + + batch_spec = BatchSpec( + metadata=BatchSpecMetadata( + action=ActionType.ACTION, + name="Associate Categories", + stop_on_error=True, + chunk_size=1, + uri="/api/vmm/v4.0.b1/ahv/config/vms/{extId}/$actions/associate-categories", + ), + payload=batch_spec_payload_list, + ) + + print("Submitting batch operation to assign VM categories ...") + batch_response = batch_instance.submit_batch( + async_req=False, body=batch_spec + ) + + # grab the ext ID of the batch operation task + modify_ext_id = batch_response.data.ext_id + utils.monitor_task( + task_ext_id=modify_ext_id, + task_name="Batch VM Category Assignment", + pc_ip=pc_ip, + username=username, + password=cluster_password, + poll_timeout=poll_timeout, + ) + print(f"{len(batch_spec_payload_list)} VMs assigned to category.") + else: + print("Batch operation cancelled.") + + except VMMException as vmm_exception: + print( + f"Unable to authenticate using the supplied credentials. \ +Check your username and/or password, then try again. \ +Exception details: {vmm_exception}" + ) + + +if __name__ == "__main__": + main()