Search <book_title>...

Veritas NetBackup™ for VMware Administrator's Guide

Last Published: 2019-06-28

Product(s): NetBackup (8.2)

Using the nbrestorevm command to restore virtual machines into vCloud Director

To search the virtual environment for VMs, use the nbdiscover command.

See Using the nbdiscover command to search the virtual environment.

To restore the virtual machines, run nbrestorevm on the master server or backup host. The nbrestorevm command is located in the following directory:

UNIX and Linux:

/usr/openv/netbackup/bin/nbrestorevm

Windows:

install_path\NetBackup\bin\nbrestorevm.exe

The following command options are used in these examples:

- vmw
Required for all VMware virtual machine restores.
-vcd
Required for all virtual machine restores into vCloud.
- C virtual_machine_to_restore
The VM name must match the type of name that was selected in the Primary VM identifier option of the backup policy. For example, if the VM was backed up by its VM display name, specify the display name on the -C option.
-R absolute_path_to_rename_file
Restores to a different location. The entries that are required in the rename file depend on the destination for the restore. See each example in this topic. Further notes are available on the rename file:
See The nbrestorevm -R rename file for restoring virtual machines.
-vcdovw
Overwrites an existing vApp.
-vcdrte
Restores to an existing vApp. (If this option is set but the vApp does not exist, the restore fails.)
-vcdtemplate
Restores a vApp as a template.
-vcdlfree
Restores to the datastore that has the most free space.
-vcdremv
Removes a vApp after capture to a template.
-vmid
Retains the BIOS UUID of the original virtual machine.
-vmInstanceId
Retains the Instance UUID of the original virtual machine (note that the Instance UUID is a vCenter specific unique identifier of a virtual machine).

A: Restore to the original vApp in vCloud and overwrite the VM.

nbrestorevm -vmw -vcd -C VM_to_restore -vcdrte -O -vmInstanceId

The -O option overwrites the VM.

B: Restore to the original vApp in vCloud, overwrite the VM, and retain the BIOS UUID.

nbrestorevm -vmw -vcd -C VM_to_restore -vcdrte -O -vmid

The -O option overwrites the VM, and the -vmid option retains the original Instance UUID.

C: Restore to the original vApp in vCloud, overwrite the VM, and retain the instance UUID.

nbrestorevm -vmw -vcd -C VM_to_restore -vcdrte -O -vmInstanceId

The -O option overwrites the VM, and the -vmInstanceId option retains the original Instance UUID.

D: Restore to the original vCloud location to an existing vApp. Remove the existing vApp and create a new vApp.

nbrestorevm - vmw - vcd - C VM_to_restore - vcdovw

The - vcdovw option deletes the vApp and the VMs inside it, and creates a new vApp.

Note:

For restore to the original location, you must use either the - vcdovw option or the - O option.

E: Restore to the original vCloud location in a vApp template.

nbrestorevm - vmw - vcd - C VM_to_restore - vcdovw

Note:

To restore a VM that resides in a vApp template to its original location, use the - vcdovw option. If you use - O option, the restore fails with status 2820.

F: Restore to a different vCloud vApp but to the same vCloud organization.

nbrestorevm - vmw - vcd - C VM_to_restore - R absolute_path_to_rename_file - vcdrte

For the -R rename file, create a text file with the following entries. These entries describe the restore location. Replace the italicized values with the actual values:

change vcdvapp to new_vcdvapp
change orgvdc to new_organization_VDC

Note:

In the rename file, each change line must end with a carriage return.

Note:

If you want to associate the restored VM with a different organization VDC, use the change orgvdc entry to specify the organization VDC.

G: Restore to a different vCloud organization.

nbrestorevm - vmw - vcd - C VM_to_restore - R absolute_path_to_rename_file - vcdrte

Include the following in the rename file:

change organization to new_organization
change orgvdc to new_organization_VDC
change vcdvapp to new_vcdvapp
change resourcepool to /new_datacenter/host/new_ESX_host/resources
/new_resource_pool
change datastore to new_vmx_datastore

Note:

To create the organization on a different vCenter, include the - vmserver vCenter_server option on the command. You must also include other change directives, such as for datacenter and ESX server.

See The nbrestorevm -R rename file for restoring virtual machines.

H: Restore to a different vCloud Director.

nbrestorevm - vmw - vcd - C VM_to_restore - R absolute_path_to_rename_file - vcdrte - vmserver vCenter_server

Include the following in the rename file:

change vcdserver to new_vcdserver
change organization to new_organization
change orgvdc to new_organization_VDC
change vcdvapp to new_vcdvapp
change vcdvmname to new_vcdvmname
change esxhost to new_ESX_host
change datacenter to /new_datacenter
change resourcepool to /new_datacenter/host/new_ESX_host/resources
/new_resource_pool
change datastore to new_vmx_datastore

I: Restore to a different vCloud vApp and capture it as a template in a catalog.

nbrestorevm - vmw - vcd - C VM_to_restore - R absolute_path_to_rename_file - vcdtemplate

Include the following in the rename file:

change vcdvapp to new_vcdvapp
change vcdcatalog to new_vcdcatalog

The vApp is restored to the original organization and organization VDC. To associate the vApp with a different organization VDC, include this directive:

change orgvdc to new_organization_VDC

Note:

After the template is created, no other VMs can be added to the template.

J: Restore to a different vCloud vApp, capture the vApp as a template, and remove the vApp.

nbrestorevm - vmw - vcd - C VM_to_restore - R absolute_path_to_rename_file - vcdtemplate - vcdremv

Include the following in the rename file:

change vcdvapp to new_vcdvapp
change vcdcatalog to new_vcdcatalog

The -vcdremv option removes the non-template vApp; the new vApp template is retained.

Note:

After the template is created, no other VMs can be added to the template.

K: Restore a vCloud vApp template that has multiple virtual machines.

First, restore a virtual machine to a non-template vApp:

nbrestorevm -vmw -vcd -C VM_to_restore -vcdrte

Run this command for each VM but do not restore the last VM.

Next, restore the last VM, create a vApp template, and copy all the restored VMs into that template:

nbrestorevm -vmw -vcd -C VM_to_restore -R absolute_path_to_rename_file -vcdtemplate -vcdremv -vcdlfree

Include the following in the rename file:

change vcdvapp to vApp_template

The change directive provides the name for the new vApp template into which the VMs are to be restored.

The -vcdremv option removes the non-template vApp into which you initially restored the virtual machines. The -vcdlfree option selects the datastore that has the largest available space.

Note:

After the template is created, no other VMs can be added to the template.

See Allowing other servers or clients to restore virtual machines.