Adding in samples on how to do a restore of a singular copy of a backup

alexoelke · alexoelke · commit bb2086c54a13 · 2021-01-14T14:18:27.000-06:00
diff --git a/recipes/python/backup-restore/README.md b/recipes/python/backup-restore/README.md
@@ -140,7 +140,7 @@ Execution flow of group VM backup and restore script:
 
 This mssql_db_backup_restore.py script demonstrates how to Protect a MSSQL Database or Instance using a protection plan, and perform a alternate recovery of a single database or all user databases using NetBackup APIs.
 
-`python -W ignore recipes/python/backup-restore/mssql_db_backup_restore.py --master_server <master_server> --master_server_port 1556 --master_username <master_username> --master_password <master_password> --mssql_instance <mssql_instance_name> --mssql_database <mssql_database_name> --mssql_server_name <mssql_server_name> --mssql_use_localcreds 0 --mssql_domain <mssql_domain> --mssql_username <mssql_sysadmin_user> --mssql_password <mssql_sysadmin_pwd> --stu_name <storage_unit_used_in_protection_plan> --protection_plan_name <protection_plan_name> --asset_type <mssql_asset_type> --restore_db_prefix <mssql_restore_database_name_prefix> --restore_db_path <mssql_restore_database_path> --recoveralluserdbs <0|1>`
+`python -W ignore recipes/python/backup-restore/mssql_db_backup_restore.py --master_server <master_server> --master_server_port 1556 --master_username <master_username> --master_password <master_password> --mssql_instance <mssql_instance_name> --mssql_database <mssql_database_name> --mssql_server_name <mssql_server_name> --mssql_use_localcreds 0 --mssql_domain <mssql_domain> --mssql_username <mssql_sysadmin_user> --mssql_password <mssql_sysadmin_pwd> --stu_name <storage_unit_used_in_protection_plan> --protection_plan_name <protection_plan_name> --asset_type <mssql_asset_type> --restore_db_prefix <mssql_restore_database_name_prefix> --restore_db_path <mssql_restore_database_path> --recover_all_user_dbs <0|1> --recover_from_copy <1|2> --copy_stu_name <storage_unit_used_for_copy>`
 
 All parameters can also be passed as command line arguments.
 - `python mssql_db_backup_restore.py -h`
@@ -161,7 +161,9 @@ usage: mssql_db_backup_restore.py [-h] [--master_server MASTER_SERVER]
                                   [--asset_type ASSET_TYPE]
                                   [--restore_db_prefix RESTORE_DB_PREFIX]
                                   [--restore_db_path RESTORE_DB_PATH]
-                                  [--recoveralluserdbs RECOVERALLUSERDBS]
+                                  [--recover_all_user_dbs RECOVER_ALL_USER_DBS]
+                                  [--recover_from_copy RECOVER_FROM_COPY]
+                                  [--copy_stu_name COPY_STU_NAME]
 Mssql backup and alternate database recovery scenario
 
 Arguments:
@@ -197,8 +199,12 @@ Arguments:
                         Restore database name prefix
   --restore_db_path RESTORE_DB_PATH
                         Restore database path
-  --recover_alluserdbs RECOVERALLUSERDBS
-                        Recover all User databases to the mssql_instance specfied with a database name prefix.
+  --recover_alluserdbs recover_all_user_dbs
+                        Recover all User databases to the mssql_instance specfied with a database name prefix
+  --recover_from_copy RECOVER_FROM_COPY
+                        Create a policy with a copy and then recover using the specified copy of the backup
+  --copy_stu_name COPY_STU_NAME
+                        Storage Unit name for the copy
 
 Execution flow of a Single MSSQL database protection and alternate database recovery workflow:
 - Login to Master Server get authorization token for API use
diff --git a/recipes/python/backup-restore/common.py b/recipes/python/backup-restore/common.py
@@ -127,6 +127,31 @@ def create_protection_plan(baseurl, token, protection_plan_name, storage_unit_na
     print(f"Protection plan created successfully:[{protection_plan_id}]")
     return protection_plan_id
 
+def run_netbackup_policy(base_url, token, policy_name):
+    print(f"Run policy:[{policy_name}]")
+    headers.update({'Authorization': token})
+    url = base_url + "/admin/manual-backup/"
+
+    cur_dir = os.path.dirname(os.path.abspath(__file__))
+    cur_dir = cur_dir + os.sep + "sample-payloads" + os.sep
+    file_name = os.path.join(cur_dir, "post_manual_backup.json")
+    with open(file_name, 'r') as file_handle:
+        data = json.load(file_handle)
+    data['data']['attributes']['policyName'] = policy_name
+
+    status_code, response_text = rest_request('POST', url, headers, data=data)
+    validate_response(status_code, 202, response_text)
+    print(f"Policy run successfully:[{policy_name}]")
+    return response_text['data'][0]['id']
+
+def delete_netbackup_policy(base_url, token, policy_name):
+    print(f"Delete policy:[{policy_name}]")
+    headers.update({'Authorization': token})
+    url = base_url + f"/config/policies/{policy_name}"
+    status_code, response_text = rest_request('DELETE', url, headers, data='')
+    validate_response(status_code, 204, response_text)
+    print(f"Policy deleted successfully:[{policy_name}]")
+
 # Subscription asset to SLO
 def subscription_asset_to_slo(baseurl, token, protection_plan_id, asset_id, is_vm_group=0):
     """ This function subscribe the asset/group asset to protection plan """
@@ -287,6 +312,22 @@ def get_recovery_points(baseurl, token, workload_type, asset_id):
         recoverypoint_id = ""
     return recoverypoint_id
 
+def get_recovery_point_copy_info(baseurl, token, workload_type, recovery_point_id):
+    """ This function returns the optional information for a given recovery point"""
+    print(f"Get the recovery point optional info:[{recovery_point_id}]")
+    headers.update({'Authorization': token})
+    include = f"optional{workload_type.capitalize()}RecoveryPointInfo"
+    url = f"{baseurl}recovery-point-service/workloads/{workload_type}/"\
+                f"recovery-points/{recovery_point_id}?include={include}"
+    status_code, response_text = rest_request('GET', url, headers)
+    validate_response(status_code, 200, response_text)
+    if (len(response_text['included'])>0):
+        print(response_text)
+        copy_info = response_text['included'][0]['attributes']['backupImageCopyInfo']
+    else:
+        copy_info = []
+    return copy_info
+
 # Validate the response code of the request
 def validate_response(actual_status_code, expected_status_code, response_text):
     """ This function validate the response status code with expected response code """
diff --git a/recipes/python/backup-restore/mssql_db_backup_restore.py b/recipes/python/backup-restore/mssql_db_backup_restore.py
@@ -27,7 +27,9 @@
 PARSER.add_argument("--asset_type", type=str, help="MSSQL asset type (AvailabilityGroup, Instance, Database)", required=False)
 PARSER.add_argument("--restore_db_prefix", type=str, help="Restore database name prefix", required=True)
 PARSER.add_argument("--restore_db_path", type=str, help="Restore database path", required=True)
-PARSER.add_argument("--recoveralluserdbs", type=int, help="Recover all user databases", required=False, default=0)
+PARSER.add_argument("--recover_all_user_dbs", type=int, help="Recover all user databases", required=False, default=0)
+PARSER.add_argument("--recover_from_copy", type=int, help="Recover from the copy number specified", choices=[1,2])
+PARSER.add_argument("--copy_stu_name", type=str, help="Storage Unit name for copies", required=False)
 
 ARGS = PARSER.parse_args()
 
@@ -66,27 +68,32 @@
 
         print(f"Start Discovery on the instance [{INSTANCE_NAME}] on the host [{ARGS.mssql_server_name}]")
         workload_mssql.mssql_instance_deepdiscovery(BASEURL, TOKEN, INSTANCE_ID)
-        # create protection plan and subscribe the assettype to it
-        PROTECTION_PLAN_ID = workload_mssql.create_mssql_protection_plan(BASEURL, TOKEN, ARGS.protection_plan_name, ARGS.stu_name, "SQL_SERVER")
-        # update protection plan to set MSSQL policy settings to skip offline databases
-        workload_mssql.update_protection_plan_mssql_attr(BASEURL, TOKEN, ARGS.protection_plan_name, PROTECTION_PLAN_ID, skip_offline_db=1)
-        SUBSCRIPTION_ID = common.subscription_asset_to_slo(BASEURL, TOKEN, PROTECTION_PLAN_ID, SUBSCRIPTION_ASSET_ID)
+        if(ARGS.recover_from_copy):
+            workload_mssql.create_netbackup_policy(BASEURL, TOKEN, ARGS.protection_plan_name, ARGS.mssql_server_name, ARGS.stu_name, ARGS.copy_stu_name)
+            BACKUP_JOB_ID = common.run_netbackup_policy(BASEURL, TOKEN, ARGS.protection_plan_name)
 
-        # MSSQL backup restore
-        print("Start MSSQL backup")
-        BACKUP_JOB_ID = common.protection_plan_backupnow(BASEURL, TOKEN, PROTECTION_PLAN_ID, SUBSCRIPTION_ASSET_ID)
+        else:
+            # create protection plan and subscribe the assettype to it
+            PROTECTION_PLAN_ID = workload_mssql.create_mssql_protection_plan(BASEURL, TOKEN, ARGS.protection_plan_name, ARGS.stu_name, "SQL_SERVER")
+            # update protection plan to set MSSQL policy settings to skip offline databases
+            workload_mssql.update_protection_plan_mssql_attr(BASEURL, TOKEN, ARGS.protection_plan_name, PROTECTION_PLAN_ID, skip_offline_db=1)
+            SUBSCRIPTION_ID = common.subscription_asset_to_slo(BASEURL, TOKEN, PROTECTION_PLAN_ID, SUBSCRIPTION_ASSET_ID)
+
+            # MSSQL backup restore
+            print("Start MSSQL backup")
+            BACKUP_JOB_ID = common.protection_plan_backupnow(BASEURL, TOKEN, PROTECTION_PLAN_ID, SUBSCRIPTION_ASSET_ID)
         #timeout is set at 300 seconds (5 mins to keep looking if the backups are complete)
         common.verify_job_state(BASEURL, TOKEN, BACKUP_JOB_ID, 'DONE', timeout=300)
 
         # give nbwebservice 30 seconds to service any queued tasks, before launching recoveries
         time.sleep(30)
-        if (ARGS.recoveralluserdbs != 1):
+        if (ARGS.recover_all_user_dbs != 1):
             # fetch the asset
             RECOVERY_ASSET_ID = workload_mssql.get_mssql_asset_info(BASEURL, TOKEN, "database", ARGS.mssql_server_name, DATABASE_NAME, INSTANCE_NAME)
             RECOVERY_POINT = common.get_recovery_points(BASEURL, TOKEN, WORKLOAD_TYPE, RECOVERY_ASSET_ID)
             print(f"Perform Mssql single database [{DATABASE_NAME}] alternate recovery:[{ARGS.mssql_server_name}]")
             ALT_DB = ALT_DB + DATABASE_NAME
-            RECOVERY_JOB_ID = workload_mssql.create_mssql_recovery_request(BASEURL, TOKEN, "post_mssql_singledb_alt_recovery.json", RECOVERY_POINT, RECOVERY_ASSET_ID, ARGS.mssql_username, ARGS.mssql_domain, ARGS.mssql_password, ALT_DB, ALT_DB_PATH, INSTANCE_NAME, ARGS.mssql_server_name)
+            RECOVERY_JOB_ID = workload_mssql.create_mssql_recovery_request(BASEURL, TOKEN, "post_mssql_singledb_alt_recovery.json", RECOVERY_POINT, RECOVERY_ASSET_ID, ARGS.mssql_username, ARGS.mssql_domain, ARGS.mssql_password, ALT_DB, ALT_DB_PATH, INSTANCE_NAME, ARGS.mssql_server_name, ARGS.recover_from_copy)
             print(f"Recovery initiated , follow Job #: [{RECOVERY_JOB_ID}]")
         else:
             print(f"Perform alternate recovery of all databases")
@@ -104,13 +111,17 @@
                     if (RECOVERY_POINT != ""):
                         print(f"Perform Mssql database [{DATABASE_NAME}] alternate recovery:[{ARGS.mssql_server_name}]")
                         ALT_DB = ARGS.restore_db_prefix + DATABASE_NAME
-                        RECOVERY_JOB_ID = workload_mssql.create_mssql_recovery_request(BASEURL, TOKEN, "post_mssql_singledb_alt_recovery.json", RECOVERY_POINT, RECOVERY_ASSET_ID, ARGS.mssql_username, ARGS.mssql_domain, ARGS.mssql_password, ALT_DB, ALT_DB_PATH, INSTANCE_NAME, ARGS.mssql_server_name)
+                        RECOVERY_JOB_ID = workload_mssql.create_mssql_recovery_request(BASEURL, TOKEN, "post_mssql_singledb_alt_recovery.json", RECOVERY_POINT, RECOVERY_ASSET_ID, ARGS.mssql_username, ARGS.mssql_domain, ARGS.mssql_password, ALT_DB, ALT_DB_PATH, INSTANCE_NAME, ARGS.mssql_server_name, ARGS.recover_from_copy)
                     else:
                         print(f"Skipping recovery, could not find RecoveryPoint for [{DATABASE_NAME}] assetid [{RECOVERY_ASSET_ID}]")
 
     finally:
         print("Start cleanup")
-        # Cleanup the created protection plan
-        common.remove_subscription(BASEURL, TOKEN, PROTECTION_PLAN_ID, SUBSCRIPTION_ID)
-        common.remove_protectionplan(BASEURL, TOKEN, PROTECTION_PLAN_ID)
+        if(ARGS.recover_from_copy):
+            # Cleanup the created policy
+            common.delete_netbackup_policy(BASEURL, TOKEN, ARGS.protection_plan_name)
+        else:
+            # Cleanup the created protection plan
+            common.remove_subscription(BASEURL, TOKEN, PROTECTION_PLAN_ID, SUBSCRIPTION_ID)
+            common.remove_protectionplan(BASEURL, TOKEN, PROTECTION_PLAN_ID)
         workload_mssql.remove_mssql_credential(BASEURL, TOKEN, CREDENTIAL_ID)
diff --git a/recipes/python/backup-restore/sample-payloads/create_mssql_policy_template.json b/recipes/python/backup-restore/sample-payloads/create_mssql_policy_template.json
@@ -0,0 +1,71 @@
+{
+    "data": {
+        "type": "policy",
+        "id": "policy",
+        "attributes": {
+            "policy": {
+                "policyName": "policy",
+                "policyType": "MS-SQL-Server",
+                "policyAttributes": {},
+                "clients": [
+                    {
+                        "databaseName": "$ALL",
+                        "hostName": "host",
+                        "instanceName": "MSSQLSERVER"
+                    }
+                ],
+				"schedules": [
+					{
+						"backupCopies": {
+							"copies": [
+								{
+									"failStrategy": "Continue",
+									"mediaOwner": "*ANY*",
+									"retentionLevel": 1,
+									"retentionPeriod": {
+										"value": 2,
+										"unit": "WEEKS"
+                                    },
+                                    "storage": "storageUnit"
+								},
+								{
+									"failStrategy": "Continue",
+									"mediaOwner": "*ANY*",
+									"retentionLevel": 1,
+									"retentionPeriod": {
+										"value": 2,
+										"unit": "WEEKS"
+                                    },
+                                    "storage": "copyStorageUnit"
+								}
+							],
+							"priority": -1
+						},
+						"backupType": "Full Backup",
+						"frequencySeconds": 604800,
+						"mediaMultiplexing": 1,
+						"retriesAllowedAfterRunDay": false,
+						"scheduleName": "Full",
+						"scheduleType": "Frequency",
+						"snapshotOnly": false,
+						"startWindow": [
+							{
+								"dayOfWeek": 1,
+								"startSeconds": 21600,
+								"durationSeconds": 43200
+							}
+						],
+						"storageIsSLP": false,
+						"syntheticBackup": false
+					}
+				],
+                
+                "backupSelections": {
+                    "selections": [
+                        "WHOLE_DATABASE"
+                    ]
+                }
+            }
+        }
+    }
+}
diff --git a/recipes/python/backup-restore/sample-payloads/post_manual_backup.json b/recipes/python/backup-restore/sample-payloads/post_manual_backup.json
@@ -0,0 +1,9 @@
+{
+	"data": {
+		"attributes": {
+			"policyName": "policy",
+			"scheduleName": "Full"
+		},
+		"type": "backupRequest"
+	}
+}
diff --git a/recipes/python/backup-restore/workload_mssql.py b/recipes/python/backup-restore/workload_mssql.py
@@ -114,6 +114,27 @@ def create_mssql_protection_plan(baseurl, token, protection_plan_name, storage_u
     print(f"Protection plan created successfully:[{protection_plan_id}]")
     return protection_plan_id
 
+def create_netbackup_policy(base_url, token, policy_name, client, storage_unit_name, copy_storage_unit_name):
+    print(f"Create policy:[{policy_name}]")
+    headers.update({'Authorization': token})
+    url = base_url + "/config/policies/"
+
+    cur_dir = os.path.dirname(os.path.abspath(__file__))
+    cur_dir = cur_dir + os.sep + "sample-payloads" + os.sep
+    file_name = os.path.join(cur_dir, "create_mssql_policy_template.json")
+    with open(file_name, 'r') as file_handle:
+        data = json.load(file_handle)
+    data['data']['attributes']['policy']['policyName'] = policy_name
+    data['data']['id'] = policy_name
+    data['data']['attributes']['policy']['clients'][0]['hostName'] = client
+    data['data']['attributes']['policy']['policyAttributes']['storage'] = storage_unit_name
+    data['data']['attributes']['policy']['schedules'][0]['backupCopies']['copies'][0]['storage'] = storage_unit_name
+    data['data']['attributes']['policy']['schedules'][0]['backupCopies']['copies'][1]['storage'] = copy_storage_unit_name
+
+    status_code, response_text = common.rest_request('POST', url, headers, data=data)
+    common.validate_response(status_code, 204, response_text)
+    print(f"Policy created successfully:[{policy_name}]")
+
 # Update SLO Mssql attributes
 def update_protection_plan_mssql_attr(baseurl, token, protection_plan_name, protection_plan_id, skip_offline_db=0):
     """ Update SLO with mssql attributes """
@@ -244,7 +265,7 @@ def create_and_register_mssql_instance(baseurl, token, instance_name, server_nam
     status_code, response_text = common.rest_request('GET', url, headers)
 
 # Create mssql recovery request
-def create_mssql_recovery_request(baseurl, token, mssql_recovery_input, rp_id, asset_id, mssql_sysadm_user, mssql_sysadm_domain, mssql_sysadm_pwd, mssql_alt_db_name, mssql_alt_db_path, mssql_instance_name, mssql_server_name):
+def create_mssql_recovery_request(baseurl, token, mssql_recovery_input, rp_id, asset_id, mssql_sysadm_user, mssql_sysadm_domain, mssql_sysadm_pwd, mssql_alt_db_name, mssql_alt_db_path, mssql_instance_name, mssql_server_name, recover_from_copy):
     """ This function is for mssql recovery request"""
     print(f"create mssql recovery request:[{mssql_recovery_input}]")
     headers.update({'Authorization': token})
@@ -264,7 +285,16 @@ def create_mssql_recovery_request(baseurl, token, mssql_recovery_input, rp_id, a
     data['data']['attributes']['alternateRecoveryOptions']['instanceName'] = mssql_instance_name
     data['data']['attributes']['alternateRecoveryOptions']['client'] = mssql_server_name
     data['data']['attributes']['alternateRecoveryOptions']['alternateFileLocation']['renameAllFilesToSameLocation'] = mssql_alt_db_path
-
+    if(recover_from_copy):
+        info = common.get_recovery_point_copy_info(baseurl, token, 'mssql', rp_id)
+        if(len(info)>0):
+            data['data']['attributes']['recoveryOptions']['mssqlRecoveryCopyInfo'] = {}
+            data['data']['attributes']['recoveryOptions']['mssqlRecoveryCopyInfo']['fullRecoveryCollection'] = [{}]
+            for copy in info[0]['copies']:
+                if(copy['copyNumber'] == recover_from_copy):
+                    copy['storage'].pop('sType',None)
+                    data['data']['attributes']['recoveryOptions']['mssqlRecoveryCopyInfo']['fullRecoveryCollection'][0]['backupId'] = info[0]['backupId']
+                    data['data']['attributes']['recoveryOptions']['mssqlRecoveryCopyInfo']['fullRecoveryCollection'][0]['storage'] = copy['storage']
     status_code, response_text = common.rest_request('POST', url, headers, data=data)
     common.validate_response(status_code, 201, response_text)
     recovery_job_id = response_text['data']['id']
