2.5.18 Execution of instant recovery of JP1/VERITAS
Function
This service template is used to execute the virtual server's instant recovery jobs on the JP1/VERITAS NetBackup server, and outputs a detailed list of the running instant recovery jobs to the output file (local) (jp1veritas.listFileLocal property).
This service template requires the following server:
- JP1/VERITAS NetBackup server (#)
A server on which JP1/VERITAS NetBackup (master server) runs.
A backup must be created beforehand.
#: Agentless connection destination
The following is an overview of the procedure:
(1) Use JP1/VERITAS NetBackup to execute an instant recovery job (by using the nbrestorevm -ir_activate command).
To specify the virtual server for instant recovery, use the display name of the virtual server in VMware vCenter Server.
Instant recovery of the specified virtual server will be performed on the ESX server that managed the virtual server when the backup was made.
(2) Make sure that the instant recovery job successfully started. (Make sure that an instant recovery job exists with the virtual server name specified in the output result of the nbrestorevm -ir_listvm command.) Then, output a detailed list of the running instant recovery jobs (output result of the nbrestorevm -ir_listvm command) to the output file (remote) (jp1veritas.listFileRemote property).
(3) Transfer the remote temporary file created in (2) to the specified local output file.
(4) Delete the remote temporary file.
Note the following when you specify the property settings:
(1) If the media server and master server of JP1/VERITAS NetBackup exist on different servers, specify the host name of the media server for the jp1veritas.mediaServerHost property.
(2) When you perform instant recovery, wait for the number of seconds specified for the instant recovery job start wait interval (jp1veritas.waitJobActInterval property). Then, repeat the operation of checking the instance status the number of times specified for the instant recovery job start wait count (jp1veritas.waitJobActCount property). Adjust the values of individual properties according to your environment.
(3) For the snapshot creation datastore (jp1veritas.dataStoreName property), specify the name of a datastore managed by the ESX server on which instant recovery is executed.
Prerequisites
For the most recent information about the prerequisite products for the system, prerequisite products for the system executing the service templates, and the supported OSs for the prerequisite products for the system executing the service templates, see the release notes.
[Required product in the system]
JP1/Automatic Operation 12-00 or later
[Prerequisite products in the system executing the service template]
(1) Prerequisite products for the JP1/VERITAS NetBackup server
- 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]
(1) Required OS for the JP1/VERITAS NetBackup server
- 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
- Red Hat Enterprise Linux Server 6 (64-bit x86_64)
- Red Hat Enterprise Linux Server 7 (64-bit x86_64)
- Red Hat Enterprise Linux Server 8 (64-bit x86_64)
[Usage conditions of prerequisite products in the system executing the service template]
(1) A backup of the virtual server specified for the virtual server name (vmware.vmName property) on the JP1/VERITAS NetBackup server must be created. Create the backup, meeting the following conditions:
- In the backup policy, the VM display name is specified for the primary VM identifier.
- In the backup policy, a Windows server is specified as the backup host.
(2) Conditions regarding the virtual server
- Each virtual server name must be unique in the same vCenter management environment.
- The virtual server whose name is specified for the virtual server name (vmware.vmName property) must not exist in the same vCenter management environment.
Cautions
(1) Even if a task running in Job Management Partner 1/Automatic Operation is canceled (forced termination), the JP1/VERITAS NetBackup job is not canceled.
To cancel an instant recovery job running in JP1/VERITAS NetBackup, you must cancel the job in JP1/VERITAS NetBackup (by using the nbrestorevm -ir_deactivate command).
(2) Do not execute this service and the nbrestorevm -ir_activate command at the same time, or multiple services at the same time when the same virtual server name (vmware.vmName property) is specified. If they are executed at the same time, the instant recovery job might not be started correctly, even if the service successfully ended. Therefore, in the detailed list of the running instant recovery jobs, make sure that the following values are the same as the values specified in this plugin:
- virtual server name (VM Display Name)
- temporary datastore name (Temporary datastore name for writes)
- media server name (Media Server Name) (Only if the host name of the media server (common.mediaServerHost property) is specified)
(3) If the file names to be specified for the remote and local files already exist, the existing files are overwritten, and the remote files are deleted. Therefore, make sure that the specified file names are correct.
(4) If a folder for the specified path does not exist, the folder is created. The created folder remains undeleted. Delete the folder if it is not necessary.
Execution privilege
(1) The following privileges are required for a user to connect to the JP1/VERITAS NetBackup server:
- For Windows: Administrator privileges
- For Unix: Root privileges
Version
02.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 |
|---|---|---|
|
Environment information of the instant recovery execution server |
Specify the environment information about the JP1/VERITAS NetBackup server. |
Y |
|
Virtual server information |
Specify the virtual server information. |
Y |
|
Instant recovery information |
Specify the information necessary for instant recovery. |
Y |
|
Output file storage information |
Specify the storage destination of the output file. |
Y |
|
Execution option |
A property regarding the status check when instant recovery is executed. Change the option as necessary. |
N |
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 JP1/VERITAS NetBackup server |
Specify the host name or IP address of the JP1/VERITAS NetBackup master server. IPv6 addresses are not supported. For a cluster configuration, specify the physical host or logical host of the active server. |
Input |
Disabled |
R |
Environment information of the instant recovery execution server |
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 |
|---|---|---|---|---|---|---|
|
vmware.vmName |
Virtual server name |
Specify the name of the virtual server subject to instantly recovery (specify the display name of the virtual server in VMware vCenter Server, not the host name for the OS). |
Input |
Disabled |
R |
Virtual server information |
|
jp1veritas.mediaServerHost |
Host name of the media server |
Specify the host name of the JP1/VERITAS NetBackUp media server. Specify this parameter if the master server and media server exist on different servers. |
Input |
Disabled |
O |
Instant recovery information |
|
jp1veritas.dataStoreName |
Snapshot creation data store |
Specify the temporary data store on the ESX server to which snapshots are written until the virtual server is restored. Specify a created data store. |
Input |
Disabled |
R |
Instant recovery information |
|
jp1veritas.startVM |
Whether to start the virtual server |
Select "true" to start the virtual server after an instant recovery. Specify "false" to terminate processing without starting the virtual server. |
Input |
Disabled |
R |
Instant recovery information |
|
jp1veritas.listFileRemote |
Output file (remote) |
Specify the full path name of a temporary file used to output the details list for the running instant recovery job to the JP1/VERITAS NetBackup server. |
Input |
Disabled |
R |
Output file storage information |
|
jp1veritas.listFileLocal |
Output file (local) |
Specify the full path name of the file on the JP1/AO server that acquires the details list for the running instant recovery job. |
Input |
Disabled |
R |
Output file storage information |
|
jp1veritas.waitJobActCount |
Wait count for starting instant recovery jobs |
Specify the number of times to confirm that the instant recovery job has started. You can specify a value in the range from 1 to 3600. |
Input |
Disabled |
R |
Execution option |
|
jp1veritas.waitJobActInterval |
Wait interval for starting instant recovery jobs |
Specify the interval (seconds) for confirming that the instant recovery job has started. You can specify a value in the range from 1 to 60. |
Input |
Disabled |
R |
Execution option |
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 |
|---|---|
|
vmware.vmName |
60 or fewer one-byte alphanumeric characters, spaces, plus signs (+), hyphens (-), underscores (_), left parentheses ((), right parentheses ()), and periods (.). However, the last character cannot be a period. |
|
jp1veritas.mediaServerHost |
256 or fewer one-byte alphanumeric characters, periods (.), and hyphens (-) |
|
jp1veritas.dataStoreName |
42 or fewer one-byte alphanumeric characters, spaces, plus signs (+), hyphens (-), underscores (_), left parentheses ((), right parentheses ()), and periods (.). However, the last character cannot be a period. |
|
jp1veritas.startVM |
Select one of the following values: true,false |
|
jp1veritas.listFileRemote |
A string of 256 or fewer characters. The string cannot end in a yen sign (\) or forward slash (/), and the following characters cannot be used: <, >, |, ;, &, *, ?, ", %, ` |
|
jp1veritas.listFileLocal |
A string of 256 or fewer characters. The string cannot end in a yen sign (\) or forward slash (/), and the following characters cannot be used: <, >, |, ;, &, *, ?, ", % |
|
jp1veritas.waitJobActCount |
An integer value in the range from 1 to 3600 |
|
jp1veritas.waitJobActInterval |
An integer value in the range from 1 to 60 |
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 |
jp1veritasStartInstantRecovery |
Execution of instant recovery (JP1/VERITAS) |
Executes instant recovery. |
Check the job status in the NetBackup Administration Console, and then perform the recommended procedure described in JP1/VERITAS Symantec NetBackup(TM) Status Code Reference Guide. If you cannot check the job status in the NetBackup Administration Console, contact the system administrator. |
|
2 |
FileTransferPlugin |
File-forwarding plug-in |
Transfers a remote temporary file to the specified local output file. |
After removing the cause of the error, execute this and subsequent steps. |
|
3 |
osDeleteFile |
File deletion |
Deletes a remote temporary file. |
Check whether a temporary file exists. If the temporary file has not been deleted, delete it. |