The nbrestorevm -R rename file for restoring virtual machines
The -R option on the nbrestorevm command is for restoring a VM to a different location. It identifies a text file that is called the rename file. This file describes the restore location by means of change directives. Each change directive provides information about a VMware attribute or object that defines the VM when it is restored. For example: the change directives can set the display name for the restored VM, the name of the datastore, and the name of the ESX server.
Note the following about the -R rename file:
The -R option must specify the absolute path to the rename file.
The -R option and rename file are not required when you restore the VM to its original location with all its original settings.
Each change directive in the -R rename file must end with a carriage return. If the file contains only one change directive, that line must end with a carriage return.
The change directives to include in the rename file depend on the VMware environment.
Unlike the Backup, Archive, and Restore interface, the nbrestorevm command does not have its own validation checks. When you use the nbrestorevm -R option, you must include all the change entries that the VMware environment requires. Otherwise, the restore does not succeed or the VM does not function correctly.
The change directives can be placed in any order in the file.
The change directive should be entered exactly as shown in Table: -R rename file change directives, except for the variable at the end (such as new_display_name). Replace that variable with the new name.
If a vSphere object does not apply to the restore destination, enter None as its value. For example: For restore to a standalone ESX, enter change datacenter to None.
The rename file overrides the nbrestorevm -vmsn and -vmvmxd options:
If the rename file includes a change directive for a .vmdk path and nbrestorevm includes the - vmvmxd option, the - vmvmxd option is ignored. The change directive determines the .vmdk path of the restored VM.
If the rename file includes a change directive to designate a network for the restored VM and nbrestorevm includes the - vmsn option, - vmsn is ignored.
Table: -R rename file change directives
-R rename file directives | Description and notes |
|---|---|
change vmname to new_display_name | Sets the display name for the restored VM. If this entry is omitted, the original display name is used. |
change esxhost to new_ESX_host | Designates the ESX server to restore to. This entry is required when you restore to a different ESX server. |
change datacenter to /new_datacenter | Designates the datacenter in which to restore the VM. If the destination does not have a datacenter, enter None as the value: change datacenter to None |
change folder to /new_datacenter/new_folder | Designates the folder in which to restore the VM. If the destination does not have a folder, enter None as the value: change folder to None |
change resourcepool to /new_datacenter/host/new_ESX_host/resources /new_resource_pool | For restore to a different ESX server, 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: For restore to a standalone ESX server, the change resourcepool entry must include the literal string ha-datacenter in the path: change resourcepool to /ha_datacenter/host/new_ESX_host/Resources |
change datastore to new_vmx_datastore | Designates the vmx datastore (configuration datastore) of the restored VM. The vmx datastore contains the configuration files that describe the virtual machine. This change entry is required when you use the - vmvmxd option on the nbrestorevm command. The -vmvmxd option allows the vmdk files to be restored to the same datastore where the vmx file is specified. Note: See the change /original_vmdk_path to /new_vmdk_path directive in this table. |
change /original_vmdk_path to /new_vmdk_path | Designates the original path to the .vmdk file, and the new path to the .vmdk file of the restored VM. As a rule, this change entry is required when you restore to a different datastore. Depending on your VMware environment, this change entry may take the following form: change /original_datastore/original_VM_folder/original_vmdk.vmdk to /new_datastore/new_VM_folder/new_vmdk.vmdk Note: If you use the -vmvmxd option on nbrestorevm to restore the .vmdk files to the vmx datastore, do not use this change directive. By specifying the datastore for the vmdk files, this change directive overrides the -vmvmxd option. Note: If the change vmdk directive specifies a different path for some of the VM's vmdk files, the other vmdk files are restored to their original datastore. To restore more than one vmdk file to a specified datastore: change /first_vmdk_path to /new_first_vmdk_path change /second_vmdk_path to /new_second_vmdk_path change /nth_vmdk_path to /new_nth_vmdk_path |
change network to new_network | Designates the new network for the restored VM. To designate multiple networks, enter the following: change network to new_network, new_network(n) |
change organization to new_organization | Designates the vCloud Director organization to restore to. |
change orgvdc to new_organization_virtual_datacenter | Designates the virtual datacenter in the vCloud Director organization to restore to. |
change vcdserver to new_vcdserver | Designates the vCloud Director server to restore to. |
change vcdvapp to new_vcdvapp | Designates the vCloud Director vApp to restore to. |
change vcdvapptemplate to new_vcdvapptemplate | Designates the vCloud Director vApp template to restore to. |
change vcdvmname to new_vcdvmname | Sets the display name for the restored VM in vCloud Director. |
change vcdcatalog to new_vcdcatalog | Designates the vCloud Director catalog to restore to. |