4.12.2 End instant recovery (JP1/VERITAS)
Function
This plugin performs end processing (the nbrestorevm -ir_done command) for the instant recovery job running on the JP1/VERITAS NetBackup server. Then, the plugin confirms that the instant recovery job ended normally (that is, the instant recovery job with the specified instant recovery ID does not exist in the output results of the nbrestorevm -ir_listvm command).
The following are notes concerning the setting properties.
- For details on the values that can be entered for the instant recovery ID (JP1VERITAS.instantRecoveryID property), see the details list for the running instant recovery job (output results of the nbrestorevm -ir_listvm command).
- To confirm that the instant recovery job ended normally, the plugin waits for the time (seconds) specified for the wait interval (JP1VERITAS.waitJobFinInterval property), and performs confirmation operations the number of times specified for the wait count (JP1VERITAS.waitJobFinCount property). If the job ends by the time the confirmation is performed the specified number of times, the plugin ends normally. If the job does not end, the plugin ends abnormally.
This plugin requires the following server:
- JP1/VERITAS NetBackup server (execution target server)
The server on which JP1/VERITAS NetBackup (master server) runs
Use situation
This plugin is used to end the instance recovery when a VMWare virtual server is quickly recovered on the JP1/VERITAS NetBackup server.
Prerequisites
See the Release Notes for the latest support statuses of prerequisite products in the system, prerequisite products on the execution target server, and OSs of prerequisite products on the execution target server.
Prerequisite products for the system:
JP1/Automatic Operation 11-00 or later
Prerequisite products for the execution-target server:
(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
OSs of prerequisite products on the execution target server:
(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
(5) Red Hat Enterprise Linux Server 6 (64-bit x86_64)
(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)
(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)
Conditions for using the execution-target server:
(1) The instant recovery job specified by the instant recovery ID (JP1VERITAS.instantRecoveryID property) must be running on the JP1/VERITAS NetBackup server.
(2) Condition relating to the virtual server
- The virtual servers being managed by a vCenter instance must have unique names.
Cautions
(1) Do not specify a string containing a double-quotation mark (") or single quotation mark (') for a property of this plugin.
(2) If the instant recovery ID of an instant recovery job that is not started is specified for the JP1VERITAS.instantRecoveryID property, the plugin ends abnormally.
Execution privilege
- For Windows, users must belong to the Administrators group.
- For UNIX, users must have root privileges.
Version
02.00.00
Plug-in tags
Control JP1,VERITAS,Windows,Linux
Plug-in name displayed in the task log
jp1veritasFinishInstantRecovery
Return code
0: Normal
12: Error (Mistake by user) Invalid property
21: Error (Environmental error) No command was found (An error was detected in the component script)
27: Error (Check with the task log about the error detail) Unidentified error
41: Error (An error was detected in the component) Property not entered (An error was detected in the component 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.instantRecoveryID |
Instant recovery ID |
Specifies the ID of the instant recovery job to be terminated. |
-- |
Input |
R |
|
JP1VERITAS.waitJobFinCount |
Termination check count for instant recovery jobs |
Specifies the maximum number of times the termination of the instant recovery job is checked. You can specify a value in the range from 1 to 3,600. |
60 |
Input |
R |
|
JP1VERITAS.waitJobFinInterval |
Termination check interval for instant recovery jobs |
Specifies the interval (in seconds) at which the termination of the instant recovery job is checked. You can specify a value in the range from 1 to 60. |
10 |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |