Veritas NetBackup™ for VMware Administrator's Guide
- Required tasks: overview
- Notes and prerequisites
- Configure NetBackup communication with VMware
- Adding NetBackup credentials for VMware
- Configure NetBackup policies for VMware
- VMware backup options
- Exclude Disks tab
- Configure a VMware Intelligent Policy
- Reduce the size of backups
- Back up virtual machines
- Use Accelerator to back up virtual machines
- Restore virtual machines
- Restoring the full VMware virtual machine
- Virtual Machine Recovery dialog boxes (restore to original location)
- Virtual Machine Recovery dialogs boxes (restore to alternate location)
- Restoring VMware virtual machine disks by using Backup, Archive, and Restore
- Restoring VMware virtual machine disks by using NetBackup commands
- Restoring individual VMware virtual machine files
- Browse and search virtual machines for restore
- Restore virtual machines with Instant Recovery
- Use NetBackup for vCloud Director
- Virtual machine recovery dialog boxes for vCloud Director
- Best practices and more information
- Appendix A. NetBackup commands to back up and restore virtual machines
- Using NetBackup commands to create a VMware policy
- Appendix B. Configuring services for NFS on Windows
- About configuring services for NFS on Windows 2012 or 2016 (NetBackup for VMware)
- About configuring services for NFS on Windows 2008 and 2008 R2 (NetBackup for VMware)
- Appendix C. The Reuse VM selection query results option
- Appendix D. Backup of VMware raw devices (RDM)
Instant Recovery options on the nbrestorevm command
NetBackup provides a command-line interface for instant recovery of virtual machines: the nbrestorevm command.
The following is a list of the available nbrestorevm options for performing Instant Recovery of a VMware virtual machine. The options are listed in man page format.
Although the nbrestorevm command has additional options, only the options that are described in this topic apply to Instant Recovery.
Options without brackets are required.
nbrestorevm -vmw -ir_activate -C vm_client -temp_location temp_location_for_writes [-S master_server] [-vmpo] [-vmInstanceId] [-vmsn] [-vmst] [-vmserver vm_server] [-vmproxy vm_proxy] [-vmkeephv] [-vmid] [-vmnewdiskuuid] [-s mm/dd/yyyy [HH:MM:SS]] [-e mm/dd/yyyy [HH:MM:SS]] [-R absolute_path_to_rename_file] [-disk_media_server media_server]
Only -vmw, -ir_activate, -C, and -temp_location are required. If the other options are not specified, NetBackup automatically supplies values for those options from the backup. In most cases, if you do not restore the virtual machine to a different location, you can omit the bracketed options.
nbrestorevm -ir_deactivate instant_recovery_identifier [-force]
nbrestorevm -ir_done instant_recovery_identifier
nbrestorevm -ir_reactivate instant_recovery_identifier [-force] nbrestorevm -ir_reactivate_all -vmhost vm_host -media_server media_server_activate_vm [-force]
Table: Options on the nbrestorevm command for Instant Recovery describes the nbrestorevm options for Instant Recovery of virtual machines. These options are also described in the NetBackup Commands Reference Guide, and in the man page for nbrestorevm.
Table: Options on the nbrestorevm command for Instant Recovery
Indicates the type of virtual machine to restore (VMware).
The name of the virtual machine as identified in the backup. For example, if the policy backed up the virtual machine by its host name, specify that host name.
If a virtual machine with the same name already exists on the target ESX host, the command fails. You can change the display name of the virtual machine in vCenter. As an alternative, use the -R option on nbrestorevm to change the display name or location of the restored virtual machine.
Starts the restore by mounting the backup image of the virtual machine as an NFS datastore. The datastore becomes accessible to the ESX host where the virtual machine is to be restored.
The following procedure has further details:
A temporary datastore on the ESX server where all writes occur until the virtual machine is restored. All writes occur on this datastore until Storage vMotion is complete or until you are finished with the virtual machine (such as for troubleshooting).
This datastore must exist before you run nbrestorevm.
Specifies a different master server, to restore a virtual machine from a backup that was made by that master.
The absolute path to a file that contains directives for restore to a different location.
The following are the entries that you can use in the file (each entry begins with change):
change esxhost to new_ESX_host change resourcepool to new_resource_pool change vmname to new_virtual_machine_name change network to new_network
change esxhost to esx01.prod4.com change resourcepool to /Tech1/esx01.prod4.com/Res change vmname to T1vm5
If the file contains only one
If you restore to a different ESX server, you may have to specify a different resource pool. (The original resource pool cannot be used to create a VM on a different ESX server.) You must specify a resource pool by including the following line in the rename file:
change resourcepool to path_to_new_resource_pool
Removes the virtual machine's tags.
The name of the vCenter server that manages the target ESX host for the restore. To restore to the same vCenter where the virtual machine originally resided, omit this option.
The host to perform the restore (a NetBackup client). The default is the host that performed the backup.
Specifies which media server performs the Instant Recovery.
This option is useful if NetBackup storage is configured over several media servers, such as for load balancing. Without the -disk_media_server option, the Instant Recovery job may select any of the available media servers to do the restore. If only one of the media servers is configured for Instant Recovery, specify that server with the -disk_media_server option.
Turns on the virtual machine after the restore.
Retains the Instance UUID of the original virtual machine (note that the Instance UUID is a vCenter specific unique identifier of a virtual machine). The virtual machine is restored with the same Instance UUID that it had when it was backed up.
If the restore of the virtual machine is to a standalone ESXi host, this option is disabled.
If a virtual machine with the same Instance UUID exists at the target restore location, a message appears that the UUID is used already. In this case, the original instance UUID is not restored and a new UUID is assigned for the virtual machine.
Removes the virtual machine's network interface.
Retains the virtual machine's hardware version: the virtual machine is restored with the same hardware version that it had when it was backed up.
Without this option, the virtual machine is restored with the default hardware version of the target ESX server or vCenter. The default is typically the latest supported hardware version.
Retains the BIOS UUID of the original virtual machine.
Generate new virtual machine disk UUIDs during an instant recovery. Use this option with the - ir_activate option.
The VMs that activate with this option do not retain the new vmdk UUID during a subsequent - ir_reactivate operation. In such a scenario, the VMDKs revert to their UUIDs at the time of the backup.
-ir_deactivate instant recovery ID
Removes the virtual machine from the ESX host. If no other virtual machine uses the NetBackup NFS datastore, this option removes that datastore and releases its resources on the NetBackup media server.
This option is for removing the virtual machine when you are finished copying its files and do not intend to keep it.
If the virtual machine has been migrated to a production datastore by means of vMotion, -ir_deactivate is the same as ir_done.
If vMotion is still in progress for this virtual machine, you should cancel the vMotion job before you use - ir_deactivate.
-ir_done instant recovery ID
When vMotion migration of the virtual machine is finished, this option completes the virtual machine instant recovery job. It also removes the NetBackup NFS datastore if no other virtual machine uses it. When the datastore is removed, its resources are released on the media server.
Reactivates a restored virtual machine: remounts the NetBackup NFS datastore, and from the temporary datastore on the ESX host it registers the restored virtual machines on the ESX host.
instant recovery ID is the virtual machine's numeric identifier from the -ir_listvm output.
If more than one virtual machine needs reactivation: -ir_reactivate_all remounts the NetBackup NFS datastores on the media server and reactivates the virtual machines. For example: If VM1, VM5, and VM6 were mounted on the specified ESX server (-vmhost), and their datastores were mounted on the specified media server (-media_server), those three VMs are reactivated.
When you reactivate virtual machines, this option specifies the ESX host on which the virtual machines were mounted.
When you reactivate virtual machines, this option specifies the media server on which the NFS datastores that contain the backup images were mounted.
For the -ir_deactivate, - ir_reactivate, or - ir_reactivate_all option, -force suppresses confirmation prompts.
-s start_time -e end_time
By default NetBackup selects the latest full backup plus Accelerator-enabled incremental backups (if any).
This option limits the selectable backup images to those with the timestamps that fall within the specified period. NetBackup selects the latest suitable backup image within the range.