Take stu_name as input paramer and corrected typos

Author: ashviniwaghmode

recipes/python/backup-restore/README.md

@@ -1,18 +1,19 @@
-# NetBackup VmWare agentless single and group VM backup and restore APIs code samples
+# NetBackup VMware agentless single and group VM backup and restore APIs code samples
 
 ## Executing the scripts:
 
 Pre-requisites:
 - NetBackup 8.3 or higher
 - Python 3.6 or higher
 - Python modules: `requests`
+- create_protection_plan_template.json template file. This template contain the required payload which is used to create the protection plan.
 
 Use the following commands to run the scripts.
 ### - Single VM backup and restore
 
-This single_vm_backup_restore.py script demonstrates how to backup a VM (VMware virtual machine) using a protection plan and restore it using NetBackup APIs.
+This single_vm_backup_restore.py script demonstrates how to backup a VM (VMware virtual machine) using a protection plan and instant access restore of VM using NetBackup APIs.
 
-`python single_vm_backup_restore.py --master_server <master_server> --master_username <master_username> --master_password <master_password> --vcenter_name <vcenter_name> --vcenter_username <vcenter_username> --vcenter_password <vcenter_password> --protection_plan_name <protection_plan_name> --clientvm <client_vm_name> --restore_vmname <restore_vm_name>`
+`python single_vm_backup_restore.py --master_server <master_server> --master_username <master_username> --master_password <master_password> --vcenter_name <vcenter_name> --vcenter_username <vcenter_username> --vcenter_password <vcenter_password> --stu_name <stu_name> --protection_plan_name <protection_plan_name> --clientvm <client_vm_name> --restore_vmname <restore_vm_name>`
 
 All parameters can also be passed as command line arguments.
 - `python single_vm_backup_restore.py --help`
@@ -25,6 +26,7 @@ usage: single_vm_backup_restore.py [-h] [--master_server MASTER_SERVER]
                                    [--vcenter_username VCENTER_USERNAME]
                                    [--vcenter_password VCENTER_PASSWORD]
                                    [--vcenter_port VCENTER_PORT]
+                                   [--stu_name STU_NAME]
                                    [--protection_plan_name PROTECTION_PLAN_NAME]
                                    [--clientvm CLIENTVM]
                                    [--restore_vmname RESTORE_VMNAME]
@@ -42,13 +44,15 @@ Arguments:
   --master_password MASTER_PASSWORD
                         NetBackup master server password
   --vcenter_name VCENTER_NAME
-                        Vcenter name
+                        vCenter name
   --vcenter_username VCENTER_USERNAME
-                        Vcenter username
+                        vCenter username
   --vcenter_password VCENTER_PASSWORD
-                        Vcenter password
+                        vCenter password
   --vcenter_port VCENTER_PORT
-                        Vcenter port
+                        vCenter port
+  --stu_name STU_NAME
+                        Storage unit name
   --protection_plan_name PROTECTION_PLAN_NAME
                         Protection plan name
   --clientvm CLIENTVM   Client VM name
@@ -69,9 +73,9 @@ Execution flow of single VM backup and restore script:
 
 ### - Group VM backup and restore
 
-This group_vm_backup_restore.py script demonstrates how to backup multiple VMs (VMware virtual machines) using a protection plan and perform bulk restore of the VMs using NetBackup APIs.
+This group_vm_backup_restore.py script demonstrates how to backup multiple VMs (VMware virtual machines) using a protection plan and perform bulk instant access restore of the VMs using NetBackup APIs.
 
-`python group_vm_backup_restore.py --master_server <master_server> --master_username <master_username> --master_password <master_password> --vcenter_name <vcenter_name> --vcenter_username <vcenter_username> --vcenter_password <vcenter_password> --protection_plan_name <protection_plan_name> --querystring <Query_string> --vip_group_name <group_name> --restore_vmname_prefix <restore_vmname_prefix>`
+`python group_vm_backup_restore.py --master_server <master_server> --master_username <master_username> --master_password <master_password> --vcenter_name <vcenter_name> --vcenter_username <vcenter_username> --vcenter_password <vcenter_password> --stu_name <stu_name> --protection_plan_name <protection_plan_name> --querystring <Query_string> --vip_group_name <group_name> --restore_vmname_prefix <restore_vmname_prefix>`
 
 All parameters can also be passed as command line arguments.
 - `python group_vm_backup_restore.py --help`
@@ -84,6 +88,7 @@ usage: group_vm_backup_restore.py [-h] [--master_server MASTER_SERVER]
                                   [--vcenter_username VCENTER_USERNAME]
                                   [--vcenter_password VCENTER_PASSWORD]
                                   [--vcenter_port VCENTER_PORT]
+                                  [--stu_name STU_NAME]
                                   [--protection_plan_name PROTECTION_PLAN_NAME]
                                   [--querystring QUERYSTRING]
                                   [--vip_group_name VIP_GROUP_NAME]
@@ -109,6 +114,8 @@ Arguments:
                         Vcenter password
   --vcenter_port VCENTER_PORT
                         Vcenter port
+  --stu_name STU_NAME
+                        Storage unit name
   --protection_plan_name PROTECTION_PLAN_NAME
                         Protection plan name
   --querystring QUERYSTRING

recipes/python/backup-restore/common.py

@@ -88,22 +88,20 @@ def get_asset_info(baseurl, token, workload_type, client):
     print(f"Client exsi host:[{exsi_host}]")
     return asset_id, uuid, exsi_host
 
-# Get StorageUnits
-def get_storage_units(baseurl, token):
-    """ This function return the storage unit name """
+# Verify the storage unit is supported for instant access
+def verify_stu_instant_access_enable(baseurl, token, storage_unit_name):
+    """ Verify the storage unit is supported for instant access """
     headers.update({'Authorization': token})
-    url = f"{baseurl}storage/storage-units"
+    url = f"{baseurl}storage/storage-units/?filter=name eq '{storage_unit_name}'"
     status_code, response_text = rest_request('GET', url, headers)
     validate_response(status_code, 200, response_text)
-    storage_unit_name = response_text['data'][0]['id']
     is_instant_access_enable = response_text['data'][0]['attributes']['instantAccessEnabled']
 
     if is_instant_access_enable:
         print(f"Storage unit:[{storage_unit_name}] enabled for instant access")
     else:
         print(f"Storage unit:[{storage_unit_name}] disable for instant access")
         raise Exception(f"Storage unit:[{storage_unit_name}] disabled for instant access")
-    return storage_unit_name
 
 # Create protection plan
 def create_protection_plan(baseurl, token, protection_plan_name, storage_unit_name):

recipes/python/backup-restore/group_vm_backup_restore.py

@@ -18,6 +18,7 @@
 PARSER.add_argument("--vcenter_username", type=str, help="Vcenter username")
 PARSER.add_argument("--vcenter_password", type=str, help="Vcenter password")
 PARSER.add_argument("--vcenter_port", type=str, help="Vcenter port", required=False)
+PARSER.add_argument("--stu_name", type=str, help="Storage Unit name")
 PARSER.add_argument("--protection_plan_name", type=str, help="Protection plan name")
 PARSER.add_argument("--querystring", type=str, help="Query string to create the VM intelligent group")
 PARSER.add_argument("--vip_group_name", type=str, help="VM intelligent group name")
@@ -159,8 +160,8 @@ def remove_vm_intelligent_group(baseurl, token, vm_group_id):
         print(f"Setup the VMware environment for vCenter:[{ARGS.vcenter_name}]")
         common.add_vcenter_credential(BASEURL, TOKEN, ARGS.vcenter_name, ARGS.vcenter_username, ARGS.vcenter_password, ARGS.vcenter_port, SERVER_TYPE)
         common.verify_vmware_discovery_status(BASEURL, TOKEN, WORKLOAD_TYPE, ARGS.vcenter_name)
-        STORAGE_UNIT_NAME = common.get_storage_units(BASEURL, TOKEN)
-        PROTECTION_PLAN_ID = common.create_protection_plan(BASEURL, TOKEN, ARGS.protection_plan_name, STORAGE_UNIT_NAME)
+        common.verify_stu_instant_access_enable(BASEURL, TOKEN, ARGS.stu_name)
+        PROTECTION_PLAN_ID = common.create_protection_plan(BASEURL, TOKEN, ARGS.protection_plan_name, ARGS.stu_name)
 
         print("Create intelligent VM group and take backup")
         create_vm_intelligent_group(BASEURL, TOKEN, ARGS.vip_group_name, ARGS.querystring, ARGS.vcenter_name)

recipes/python/backup-restore/single_vm_backup_restore.py

@@ -19,6 +19,7 @@
 PARSER.add_argument("--vcenter_username", type=str, help="Vcenter username")
 PARSER.add_argument("--vcenter_password", type=str, help="Vcenter password")
 PARSER.add_argument("--vcenter_port", type=str, help="Vcenter port", required=False)
+PARSER.add_argument("--stu_name", type=str, help="Storage Unit name")
 PARSER.add_argument("--protection_plan_name", type=str, help="Protection plan name")
 PARSER.add_argument("--clientvm", type=str, help="Client VM name")
 PARSER.add_argument("--restore_vmname", type=str, help="Restore VM name")
@@ -40,9 +41,9 @@
         print(f"Setup the VMware environment for vCenter:[{ARGS.vcenter_name}]")
         common.add_vcenter_credential(BASEURL, TOKEN, ARGS.vcenter_name, ARGS.vcenter_username, ARGS.vcenter_password, ARGS.vcenter_port, SERVER_TYPE)
         common.verify_vmware_discovery_status(BASEURL, TOKEN, WORKLOAD_TYPE, ARGS.vcenter_name)
-        STORAGE_UNIT_NAME = common.get_storage_units(BASEURL, TOKEN)
+        common.verify_stu_instant_access_enable(BASEURL, TOKEN, ARGS.stu_name)
         ASSET_ID, _, EXSI_HOST = common.get_asset_info(BASEURL, TOKEN, WORKLOAD_TYPE, ARGS.clientvm)
-        PROTECTION_PLAN_ID = common.create_protection_plan(BASEURL, TOKEN, ARGS.protection_plan_name, STORAGE_UNIT_NAME)
+        PROTECTION_PLAN_ID = common.create_protection_plan(BASEURL, TOKEN, ARGS.protection_plan_name, ARGS.stu_name)
         SUBSCRIPTION_ID = common.subscription_asset_to_slo(BASEURL, TOKEN, PROTECTION_PLAN_ID, ASSET_ID)
 
         # Single VM backup and restore