4.12.12 Rename-file creation
Function
This plug-in creates a rename file to be used to restore a virtual machine in a vSphere environment linked with JP1/VERITAS NetBackup. The path name of the rename file created by this plug-in is specified in the JP1VERITAS.renameFilePath property of the virtual-machine restoration plug-in.
This plug-in assumes the following server:
- Execution-target server
The execution-target server refers to a server on which JP1/VERITAS NetBackup (master server) is running. The rename file is output to the folder that has the specified path name on the execution-target server.
The script in this plug-in outputs the rename file having the following content to the folder that has the specified path name:
[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.
Use situation
Use this plug-in in combination with the virtual-machine restoration plug-in when restoring 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) 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.
(4) 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 who executes this plug-in must be a member of the Administrators group.
Version
02.01.01
Plug-in tags
Control JP1,VERITAS,Windows
Plug-in name displayed in the task log
jp1veritasCreateRenameFile
Return code
0: Normal
14: Error (user error) File cannot be accessed
21: Error (invalid environment) Command cannot be found (error detected in the plug-in script)
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.renameFilePath |
Rename-file path |
Specify the absolute path name of the rename file. |
-- |
Input |
R |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
JP1VERITAS.newVmxDatastore |
Restore-destination datastore |
Specify the datastore in which to restore the virtual machine. |
-- |
Input |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |