Modifying the virtual machine disk restore file
This topic describes how to modify the file that describes the virtual machine disk restore parameters. You must modify the file to describe your specific restore instance.
Two methods exist to modify the restore file, as follows:
|
A text editor |
With a text editor, you can modify any or all of the fields. See To modify a VMware virtual machine disk restore file by using a text editor. |
|
A Veritas provided Perl script |
With the restore_spec_utility.pl Perl script, you can perform the following operations:
Examine the script for a description of the options and example usage statements. Perl must be installed on the host on which you modify the restore parameters file. Examine the script to determine which modules are required; some may require separate installation. See To modify a VMware virtual machine disk restore file by using the restore_spec_utility.pl script. |
The following table describes some restore scenarios and the values of the fields that are required to accommodate those scenarios.
Table: Restore parameters file items to edit
| Item | Description |
|---|---|
|
Disks |
Edit the VMwareVirtualDiskDestination section of the file so that it contains only the virtual machine disk or disks that you want to restore. To ensure data integrity, be aware of the following:
|
Restore to a datastore cluster | For a restore of virtual disks to a datastore cluster, specify the name of the datastore cluster in the Datastore field of the VMwareVirtualDiskDestination section. Do not specify the cluster in the Path field. Note: If the restore is to an existing VM, the VMDKs are not located in the existing datastore path for the VM. They reside in a datastore path based on the name of the temporary VM used in the restore. The name of the temporary VM is available in the details for the restore job in NetBackup. |
Restore to an existing VM | By default, the restore parameters file that the nbrestorevm -restorespecout command creates is configured to restore to a new VM. To restore the virtual disks to an existing VM, do the following:
The VMwareAdvancedRestoreOptions section of the restore parameters file includes other parameters that are related to restoring to an existing VM. The restore job details show the datastore path of the virtual disk when it was backed up and after it is restored. |
|
Standalone ESXi hypervisor |
To restore to a standalone ESXi hypervisor when the backup was through a vCenter, edit the following fields so that their values are None, as follows:
|
|
The VM name |
The nbrestorevm -restorespecout command adds a timestamp to the name of the original VM client when it populates the VMName field in the restore parameters file. The timestamp is the decimal number of seconds since January 1, 1970. Depending on the requirements of the restore instance, you may need to edit the VMName field. |
|
Other fields |
Edit any of the other fields so that the values that describe the restore meet your needs. |
This task is part of a larger process that describes how to restore an individual VMware virtual machine disk or disks.
See Restoring VMware virtual machine disks by using NetBackup commands.
To modify a VMware virtual machine disk restore file by using a text editor
- Open the restore file in a text editor.
- Modify the parameters as necessary, save the file, and then close the editor.
- Continue to the next task in the individual virtual machine disk restore process.
To modify a VMware virtual machine disk restore file by using the restore_spec_utility.pl script
- Invoke the Perl script to modify the restore parameters file as necessary, one field at a time. Examples of three supported -req_type operations follow:
The following is an example of a modify operation to change the VMName field:
Windows: perl.exe C:\Progra~1\Veritas\NetBackup\bin\goodies\restore_spec_utility.pl -req_type modify -file_path restore_filename -field VMName -value new_vm_name
UNIX: perl /usr/openv/netbackup/bin/goodies/restore_spec_utility.pl -req_type modify -file_path restore_filename -field VMName -value new_vm_name
The following is an example of a keep_disks operation to retain a subset of the disks that are described in a restore parameters file. It retains the scsi0-1 and scsi0-2 virtual disks and deletes all of the other defined disks from the file:
Windows: perl.exe C:\Progra~1\Veritas\NetBackup\bin\goodies\restore_spec_utility.pl -req_type keep_disks -file_path restore_filename -controller scsi0-1,scsi0-2
UNIX: perl /usr/openv/netbackup/bin/goodies/restore_spec_utility.pl -req_type keep_disks -file_path restore_filename -controller scsi0-1,scsi0-2
The following is an example of a delete_disks operation to delete a subset of the disks that are described in a restore parameters file. It deletes the scsi0-1 and scsi0-2 virtual disks and retains the other defined disks in the file:
Windows: perl.exe C:\Progra~1\Veritas\NetBackup\bin\goodies\restore_spec_utility.pl -req_type delete_disks -file_path restore_filename -controller scsi0-0,scsi0-1
UNIX: perl /usr/openv/netbackup/bin/goodies/restore_spec_utility.pl -req_type delete_disks -file_path restore_filename -controller scsi0-0,scsi0-1
The following is an example of modifying a restore specification for In-place disk restore:
Windows: perl.exe C:\Progra~1\Veritas\NetBackup\bin\goodies\restore_spec_utility.pl -req_type modify -file_path restore_filename -field AttachDisksToExistingVM -value DeleteAllDisksAndReplace
UNIX: perl /usr/openv/netbackup/bin/goodies/restore_spec_utility.pl -req_type modify -file_path restore_filename -field AttachDisksToExistingVM -value DeleteAllDisksAndReplace
- Repeat step 1 until you have finished modifying the file.
- Continue to the next task in the individual virtual machine disk restore process.