4.12.11 Virtual-machine restoration
Function
This plug-in restores a virtual machine in a vSphere environment on a specified server linked with JP1/VERITAS NetBackup.
This plug-in assumes the following servers:
- Execution-target server
The execution-target server refers to a server on which JP1/VERITAS NetBackup (master server) is running. This product transfers plug-ins to this server, and the plug-ins are executed on this server.
- ESX server
The ESX server refers to a server on which the restore-target virtual machine and VMware vSphere ESXi are running.
If an existing virtual machine on the restore-destination ESX has the same name as the restore-target virtual machine, the existing virtual machine is overwritten with the restore-target virtual machine.
You must place a rename file on the execution-target server when you restore a virtual machine on an ESX server different from the backup source or change settings such as virtual-machine display name and datastore. Use the rename file creation plug-in to output the rename file.
The script in this plug-in executes the following command:
- nbrestorevm -vmw -C <restore-target-virtual-machine-name> ' JP1VERITAS.restoreVmName property
[-R <rename-file-path>] ' JP1VERITAS.renameFilePath property
[-vmproxy <backup-server-name>] ' JP1VERITAS.recoveryHost property
[-vmserver <restore-target-vCenter-server-name>] ' JP1VERITAS.restorevCenterServer property)
-O -vmtm nbd -vmkeephv -w
For details about the nbrestorevm command of JP1/VERITAS NetBackup, see descriptions of the command in the relevant manual for JP1/VERITAS NetBackup.
Use situation
Use this plug-in to restore a virtual machine backed up by JP1/VERITAS NetBackup.
Prerequisites
For the latest support information about [Required product for the system]/[Required product for the system executing the service template]/[Prerequisite product OS running in the system executing the service template], see the Release Notes.
[Required product for the system]
- JP1/Automatic Operation 11-00 or later
[Required product for the system executing the service template]
(1) JP1/VERITAS NetBackup 7.6, 7.7
(2) JP1/VERITAS NetBackup 8.0, 8.1, 8.2, 8.3
(3) JP1/VERITAS NetBackup 9.0, 9.1
[Prerequisite product OS running in the system executing the service template]
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Windows Server 2019 Standard/Datacenter
[Use conditions of required product for the system]
None
Cautions
(1) Do not use a character string that includes a double quotation mark (") or single quotation mark (') in a property of this plug-in.
(2) Do not specify a character string that includes an exclamation mark (!) or percent sign (%) in the path name (JP1VERITAS.renameFilePath property) of a rename file.
(3) For other points to be noted, see the notes on the corresponding command in the relevant manual for JP1/VERITAS NetBackup.
Execution privilege
The user who executes this plug-in must be a member of the Administrators group.
Version
02.01.00
Plug-in tags
Control JP1,VERITAS,Windows
Plug-in name displayed in the task log
jp1veritasRestoreVm
Return code
0: Normal
21: Error (invalid environment) Command cannot be found (error detected in the plug-in script)
27: Error (check task logs for the nature of error)
41: Error (error detected in plug-in) Missing property (error detected in the plug-in script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
JP1VERITAS.restoreVmName |
Restore-target virtual machine name |
This parameter specifies the name of the virtual machine to be restored. The virtual machine name must match the type of name that was selected in the Primary VM identifier option of the backup policy. |
-- |
Input |
R |
|
JP1VERITAS.restorevCenterServer |
Restore-target vCenter server name |
Specify the name of the vCenter server to be restored. If you restore the vCenter server as a vCenter server different from the backup source, specify this parameter. |
-- |
Input |
O |
|
JP1VERITAS.recoveryHost |
Backup server name |
Specify the name of the backup server to perform the restoration. If you use a backup server different from the one used for backup execution, specify this parameter. |
-- |
Input |
O |
|
JP1VERITAS.renameFilePathOption |
Rename-file path |
Specify the absolute path name of the rename file. Specify this parameter if you will change the location or settings of the virtual machine to be restored. |
-- |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |