2.5.21 Virtual-machine restoration with JP1/VERITAS
Function
This service template restores a virtual machine in a vSphere environment linked with JP1/VERITAS NetBackup.
This plug-in assumes the following servers:
- Backup execution server
The backup execution 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.
The following is an outline of the processing:
(1) The rename file defining restore-destination information is output to the backup execution server.
(2) The virtual machine is restored in the specified vSphere environment.
(3) The rename file is deleted.
Create a rename file when you restore a virtual machine on an ESX server different from the backup source, or when you change settings such as the virtual-machine display name and datastore.
This service template outputs the rename file of the following content to the folder that has the path name specified by the jp1veritas.renameFilePath property on the backup execution server:
[change vmname to virtual-machine-display-name (jp1veritas.newDisplayName property)]
[change esxhost to restore-destination-ESX-server (jp1veritas.newEsxHost property)]
[change datacenter to restore-destination-datacenter (jp1veritas.newDatacenter property)]
[change folder to restore-destination-folder (jp1veritas.newFolder property)]
[change resourcepool to restore-destination-resource-pool (jp1veritas.newResourcePool property)]
[change datastore to restore-destination-datastore (jp1veritas.newVmxDatastore property)]
[change original-vmdk-file-path-1 (jp1veritas.originalVmdkPath1 property) to restore-destination-vmdk-file-path-1 (jp1veritas.newVmdkPath1 property)]
[change original-vmdk-file-path-2 (jp1veritas.originalVmdkPath2 property) to restore-destination-vmdk-file-path-2 (jp1veritas.newVmdkPath2 property)]
[change original-vmdk-file-path-3 (jp1veritas.originalVmdkPath3 property) to restore-destination-vmdk-file-path-3 (jp1veritas.newVmdkPath3 property)]
[change original-vmdk-file-path-4 (jp1veritas.originalVmdkPath4 property) to restore-destination-vmdk-file-path-4 (jp1veritas.newVmdkPath4 property)]
[change original-vmdk-file-path-5 (jp1veritas.originalVmdkPath5 property) to restore-destination-vmdk-file-path-5 (jp1veritas.newVmdkPath5 property)]
[change original-vmdk-file-path-6 (jp1veritas.originalVmdkPath6 property) to restore-destination-vmdk-file-path-6 (jp1veritas.newVmdkPath6 property)]
[change original-vmdk-file-path-7 (jp1veritas.originalVmdkPath7 property) to restore-destination-vmdk-file-path-7 (jp1veritas.newVmdkPath7 property)]
[change original-vmdk-file-path-8 (jp1veritas.originalVmdkPath8 property) to restore-destination-vmdk-file-path-8 (jp1veritas.newVmdkPath8 property)]
[change original-vmdk-file-path-9 (jp1veritas.originalVmdkPath9 property) to restore-destination-vmdk-file-path-9 (jp1veritas.newVmdkPath9 property)]
[change original-vmdk-file-path-10 (jp1veritas.originalVmdkPath10 property) to restore-destination-vmdk-file-path-10 (jp1veritas.newVmdkPath10 property)]
[change network network-name (jp1veritas.newNetwork property)]
For details about the rename file, see descriptions of the nbrestorevm in the relevant manual for 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 12-00 or later
[Required product for the system executing the service template]
- JP1/VERITAS NetBackup 7.6, 7.7
- JP1/VERITAS NetBackup 8.0, 8.1, 8.2, 8.3
- JP1/VERITAS NetBackup 9.0, 9.1
[Prerequisite product OS running in the system executing the service template]
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
- Windows Server 2016 Standard/Datacenter
- Windows Server 2019 Standard/Datacenter
[Use conditions of required product for the system]
None
Cautions
(1) If an existing file has the same path name as that of the rename file (path name specified in the JP1VERITAS.renameFilePath property), the existing file is overwritten with the rename file. Make sure that a correct path name has been specified for the rename file.
(2) If the folder with a path name included in the path name of the rename file to be created does not exist, create the folder.
Execution privilege
The user must belong to the Administrators group.
Version
03.00.00
Tags
Control JP1,VERITAS
Property list
The following shows the list of the property groups set in the property:
|
Property group |
Description |
Initial display |
|---|---|---|
|
JP1/VERITAS NetBackup configuration information |
Specify the configuration information on JP1/VERITAS NetBackup. |
Y |
|
Restore-target virtual machine information |
Specify the information about the virtual machine to be restored. |
Y |
|
Rename-file information |
Specify the information to be output to the rename file. |
Y |
The following shows the list of the properties to be displayed in the "Service Definition" window:
- (Legend)
-
R: The property must be specified.
O: The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
jp1veritas.targetHost |
Host name of the active backup server |
Specifies the host name or IP address of the JP1/VERITAS NetBackup master server. IPv6 addresses are not supported. In the case of a cluster configuration, specify the physical host or logical host of the active server. |
Input |
Disabled |
R |
JP1/VERITAS NetBackup configuration information |
The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
jp1veritas.restoreVmName |
Restore-target virtual machine name |
Specify 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 |
Disabled |
R |
Restore-target virtual machine information |
|
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 |
Disabled |
O |
Restore-target virtual machine information |
|
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 |
Disabled |
O |
Restore-target virtual machine information |
|
jp1veritas.renameFilePath |
Rename-file path |
Specify the absolute path name of the rename file. If you restore the virtual machine with the original settings at the original location, you do not need to specify this property. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.newDisplayName |
Virtual-machine display name |
Specify the display name of the virtual machine to be restored. If this parameter is omitted, the original display name of the virtual machine is used. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.newEsxHost |
Restore-destination ESX server |
Specify the ESX server in which to restore the virtual machine. If you restore the virtual machine on an ESX server different from the backup source, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.newDatacenter |
Restore-destination datacenter |
Specify the datacenter in which to restore the virtual machine. For the specification, use the format "/datacenter-name". If no datacenter is found at the restore destination, specify "None" in this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.newFolder |
Restore-destination folder |
Specify the folder in which to restore the virtual machine. For the specification, use the format "/datacenter-name/folder-name". If no folder is found at the restore destination, specify "None" in this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.newResourcePool |
Restore-destination resource pool |
Specify the resource pool in which to restore the virtual machine. For the specification, use the format "/datacenter-name/host/ESX-server-name/resources/resource-pool-name". |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.newVmxDatastore |
Restore-destination datastore |
Specify the datastore in which to restore the virtual machine. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.originalVmdkPath1 |
Original vmdk file path 1 |
Specify the path name of the original vmdk file. If you restore the virtual machine in a datastore different from the original datastore, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.newVmdkPath1 |
Restore-destination vmdk file path 1 |
Specify the path name of the vmdk file at the restore destination. If you restore the virtual machine in a datastore different from the original datastore, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.originalVmdkPath2 |
Original vmdk file path 2 |
Specify the path name of the original vmdk file. If you restore the virtual machine in a datastore different from the original datastore, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.newVmdkPath2 |
Restore-destination vmdk file path 2 |
Specify the path name of the vmdk file at the restore destination. If you restore the virtual machine in a datastore different from the original datastore, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.originalVmdkPath3 |
Original vmdk file path 3 |
Specify the path name of the original vmdk file. If you restore the virtual machine in a datastore different from the original datastore, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.newVmdkPath3 |
Restore-destination vmdk file path 3 |
Specify the path name of the vmdk file at the restore destination. If you restore the virtual machine in a datastore different from the original datastore, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.originalVmdkPath4 |
Original vmdk file path 4 |
Specify the path name of the original vmdk file. If you restore the virtual machine in a datastore different from the original datastore, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.newVmdkPath4 |
Restore-destination vmdk file path 4 |
Specify the path name of the vmdk file at the restore destination. If you restore the virtual machine in a datastore different from the original datastore, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.originalVmdkPath5 |
Original vmdk file path 5 |
Specify the path name of the original vmdk file. If you restore the virtual machine in a datastore different from the original datastore, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.newVmdkPath5 |
Restore-destination vmdk file path 5 |
Specify the path name of the vmdk file at the restore destination. If you restore the virtual machine in a datastore different from the original datastore, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.originalVmdkPath6 |
Original vmdk file path 6 |
Specify the path name of the original vmdk file. If you restore the virtual machine in a datastore different from the original datastore, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.newVmdkPath6 |
Restore-destination vmdk file path 6 |
Specify the path name of the vmdk file at the restore destination. If you restore the virtual machine in a datastore different from the original datastore, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.originalVmdkPath7 |
Original vmdk file path 7 |
Specify the path name of the original vmdk file. If you restore the virtual machine in a datastore different from the original datastore, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.newVmdkPath7 |
Restore-destination vmdk file path 7 |
Specify the path name of the vmdk file at the restore destination. If you restore the virtual machine in a datastore different from the original datastore, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.originalVmdkPath8 |
Original vmdk file path 8 |
Specify the path name of the original vmdk file. If you restore the virtual machine in a datastore different from the original datastore, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.newVmdkPath8 |
Restore-destination vmdk file path 8 |
Specify the path name of the vmdk file at the restore destination. If you restore the virtual machine in a datastore different from the original datastore, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.originalVmdkPath9 |
Original vmdk file path 9 |
Specify the path name of the original vmdk file. If you restore the virtual machine in a datastore different from the original datastore, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.newVmdkPath9 |
Restore-destination vmdk file path 9 |
Specify the path name of the vmdk file at the restore destination. If you restore the virtual machine in a datastore different from the original datastore, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.originalVmdkPath10 |
Original vmdk file path 10 |
Specify the path name of the original vmdk file. If you restore the virtual machine in a datastore different from the original datastore, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.newVmdkPath10 |
Restore-destination vmdk file path 10 |
Specify the path name of the vmdk file at the restore destination. If you restore the virtual machine in a datastore different from the original datastore, specify this parameter. |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.newNetwork |
Network name |
Specify a new network name for the virtual machine to be restored. If you specify multiple network names, separate them by a comma (,). |
Input |
Disabled |
O |
Rename-file information |
|
jp1veritas.deleteRenameFile |
Rename-file deletion |
Specify "true" to delete the rename file after processing ends normally on the execution-target server, or "false" to not delete the rename file. |
Input |
Disabled |
R |
Rename-file information |
The following shows the restrictions on inputs to the properties displayed in the "Service Definition" window:
|
Property key |
Characters that can be input |
|---|---|
|
jp1veritas.targetHost |
A maximum of 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
The following shows the restrictions on inputs to the property displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Characters that can be input |
|---|---|
|
jp1veritas.restoreVmName |
String of 60 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "'", """, "*", "?", "[", "]", "`", ",", and "%". |
|
jp1veritas.restorevCenterServer |
String of 256 or fewer alphanumeric characters, ".", and "-" |
|
jp1veritas.recoveryHost |
String of 256 or fewer alphanumeric characters, ".", and "-" |
|
jp1veritas.renameFilePath |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.newDisplayName |
String of 60 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "'", """, "*", "?", "[", "]", "`", ",", and "%". |
|
jp1veritas.newEsxHost |
String of 256 or fewer alphanumeric characters, ".", and "-" |
|
jp1veritas.newDatacenter |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "'", """, "*", "?", "[", "]", "`", and "%". |
|
jp1veritas.newFolder |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "'", """, "*", "?", "[", "]", "`", and "%". |
|
jp1veritas.newResourcePool |
String of 1,024 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "'", """, "*", "?", "[", "]", "`", and "%". |
|
jp1veritas.newVmxDatastore |
String of 42 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "'", """, "*", "?", "[", "]", "`", and "%". |
|
jp1veritas.originalVmdkPath1 |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.newVmdkPath1 |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.originalVmdkPath2 |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.newVmdkPath2 |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.originalVmdkPath3 |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.newVmdkPath3 |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.originalVmdkPath4 |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.newVmdkPath4 |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.originalVmdkPath5 |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.newVmdkPath5 |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.originalVmdkPath6 |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.newVmdkPath6 |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.originalVmdkPath7 |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.newVmdkPath7 |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.originalVmdkPath8 |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.newVmdkPath8 |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.originalVmdkPath9 |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.newVmdkPath9 |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.originalVmdkPath10 |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.newVmdkPath10 |
String of 256 or fewer characters. The following characters are excluded: "<", ">", "|", ";", "&", "*", "?", """, and "%". In addition, the characters "\" and "/" cannot be the last character in the string. |
|
jp1veritas.newNetwork |
String of 1,000 or fewer characters. The following characters are excluded: "<", ">", "|", ";", and "&". |
|
jp1veritas.deleteRenameFile |
Select one of the following values: true,false |
Flow specification details
The following table shows the detailed specification of the flow:
|
Hierarchy |
Display name |
Plug-in |
||
|---|---|---|---|---|
|
Plug-in name |
Description |
Error recovery method |
||
|
1 |
JudgeValuePlugin1 |
Branch by Property Value Plug-in |
This plug-in determines whether the rename file needs to be output. |
Remove the cause of the error, and then execute the service again. |
|
2 |
Rename-file creation |
Rename-file creation |
Remove the cause of the error, and then execute the service again. |
|
|
3 |
restoreVm |
Virtual-machine restoration |
This plug-in restores the virtual machine. |
Check indications on the Activity Monitor of JP1/VERITAS NetBackup, remove the cause of the error, and then execute the service again. |
|
4 |
JudgeValuePlugin2 |
Branch by Property Value Plug-in |
This plug-in determines whether the rename file needs to be deleted. |
Remove the cause of the error, and then manually delete the rename file. |
|
5 |
Flow Plug-in |
This plug-in deletes the rename file. |
-- |
|
|
6 |
Branch by Property Value Plug-in |
This plug-in determines whether the rename file needs to be deleted. |
Remove the cause of the error, and then manually delete the rename file. |
|
|
7 |
File deletion |
This plug-in deletes the rename file. |
Remove the cause of the error, and then manually delete the rename file. |
|