2.5.19 End of instant recovery of JP1/VERITAS
Function
This service template is used to restore the virtual server (for which instant recovery is being executed on the JP1/VERITAS NetBackup server). Specifically, this template migrates data from the temporary datastore used for instant recovery to the datastore to be used after restoration. This template also deletes the snapshot created when instant recovery is executed, and finishes the processing of the instant recovery job.
This service template supports the following types of servers:
- JP1/VERITAS NetBackup server (#)
A server on which JP1/VERITAS NetBackup (master server) runs.
An instant recovery job must be running.
- vCenter server
A server on which VMware vCenter Server has been installed
- vCenter control server (#)
A server on which the VMware vSphere PowerCLI has been installed
- Virtual server
A virtual server that is managed by the vCenter server and VMware vSphere ESXi.
#: Agentless connection destination
The following is an overview of the procedure:
(1) Perform migration.
Migrate data from the temporary datastore to the datastore to be used after restoration. Specify the destination datastore with the datastore name.
(2) Delete the snapshot.
Delete the snapshot created when instant recovery is executed (snapshot name: NBU_IR_SNAPSHOT).
(3) Finish the instant recovery job (by using the nbrestorevm -ir_done command).
Finish the instant recovery job by specifying it with the instant recovery ID.
Note the following when you specify the property settings:
(1) For the value to be entered for the instant recovery ID (jp1veritas.instantRecoveryID property), see the detailed list of the running instant recovery jobs (output result of the nbrestorevm -ir_listvm command).
(2) For the virtual server name to be specified for the vmware.vmName property, see the list of instant recovery jobs, and then enter the value corresponding to the instant recovery ID.
(3) Do not specify a temporary datastore name for the vmware.dataStoreName property.
(4) When you finish an instant recovery job, wait for the number of seconds specified for the instant recovery job end wait interval (jp1veritas.waitJobFinInterval property). Then, repeat the operation of finishing the instant recovery job the number of times specified for the instant recovery job end wait count (jp1veritas.waitJobFinCount property). Adjust the values of individual properties, according to your environment.
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
(2) Prerequisite products for the vCenter server
- VMware vCenter Server 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0
(3) Instance of VMware vSphere ESXi that manages the virtual server
- VMware vSphere ESXi 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0
(4) Prerequisite products for the vCenter control server
- VMware vSphere PowerCLI 6.0 Release3, 6.0 Release1, 5.8 Release1, 5.5 Release2, 5.5 Release1, 5.1 Release2, 5.0
- VMware PowerCLI 6.5 Release1
- VMware PowerCLI 6.5.1, 6.5.4
- VMware PowerCLI 10.1.0, 10.1.1, 11.3.0, 12.0.0, 12.1.0
Note that instances of VMware vSphere ESXi that manage a virtual server, and the prerequisite products for the vCenter control server support the versions supported by JP1/VERITAS NetBackup.
[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)
(2) Prerequisite OS for the virtual server
In a configuration supported by the prerequisite products for the vCenter server, instances of VMware vSphere ESXi that manage a virtual server, and the prerequisite products for the vCenter control server, the following OSs are supported:
- 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 (32-bit x86), 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)
(3) Prerequisite OS for the vCenter control 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
[Usage conditions of prerequisite products in the system executing the service template]
(1) The instant recovery job specified for the instant recovery ID (common.instantRecoveryID property) is running on the JP1/VERITAS NetBackup server.
(2) VMware vSphere ESXi is managed by VMware vCenter Server.
(3) Conditions regarding the virtual server
- The virtual server name must be unique in the same vCenter management environment.
- VMwareTools has been installed on the virtual server.
- Each datastore name must be unique in the same vCenter management environment.
- Each snapshot name must be unique in the same vCenter management environment.
(4) The target virtual server environment meets the prerequisite of vMotion.
(5) The target virtual server environment meets the prerequisite of Storage vMotion.
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.
(2) Multiple services cannot be executed at the same time when the same virtual server name (common.vmName property) is specified. If they are executed at the same time, migration or deletion of snapshots might fail.
(3) Do not execute this service and the nbrestorevm -ir_done command at the same time with the same instance recovery ID (common.instantRecoveryID property) specified. If they are executed at the same time, the service might be abnormally terminated even if the instant recovery job has ended. Therefore, check the status of the instant recovery job in the NetBackup Administration Console.
Execution privilege
(1) The following privileges are required for a user to connect to VMware vCenter Server:
- A role that has the privileges of vMotion query, migration, and reallocation for the target virtual server, or the system administrator role
(2) 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.11.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 system environment information |
Specify the VMware vCenter Server information. |
Y |
|
Virtual server information |
Specify the virtual server information. |
Y |
|
Instant recovery information |
Specify the information necessary for instant recovery. |
Y |
|
Execution option |
A property regarding the status check when instant recovery is finished. 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 |
|
vmware.powerCLIHost |
Host name of the vCenter control server |
Specify the host name or IP address of the server on which VMware vSphere PowerCLI is installed. IPv6 addresses are not supported. |
Input |
Disabled |
R |
Virtual system environment information |
|
vmware.vCenterServerName |
vCenter server name |
Specify the host name or IP address of the VMware vCenter server. You cannot specify an IPv6 address. |
Input |
Disabled |
R |
Virtual system environment information |
|
vmware.userName |
User name for connecting to the VMware vCenter Server |
Specify the user name to use when connecting to the VMware vCenter server. |
Input |
Disabled |
R |
Virtual system environment information |
|
vmware.password |
Password for connecting to the VMware vCenter Server |
Specify the password to use when connecting to the VMware vCenter server. |
Input |
Disabled |
R |
Virtual system environment information |
|
vmware.portNumber |
VMware vCenter Server connection port number |
Specify the port number to use when connecting to the VMware vCenter server (specifically, the port number of the VMware vCenter server's Web service). If you omit this property, the default value of the VMware vCenter server applies. |
Input |
Disabled |
R |
Virtual system environment information |
|
vmware.protocol |
VMware vCenter Server connection protocol |
Specify the protocol to use when connecting to the VMware vCenter server. |
Input |
Disabled |
R |
Virtual system environment 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 |
|---|---|---|---|---|---|---|
|
vmware.vmName |
Virtual server name |
Specify the name of the virtual server. This name is used to represent the virtual server in VMware vCenter server. It is not used as a host name by the OS. |
Input |
Disabled |
R |
Virtual server information |
|
vmware.dataStoreName |
Data store name |
Specify the data store to be migrated from the temporary data store created when an instant recovery is performed. Specify a created data store. |
Input |
Disabled |
R |
Virtual server information |
|
jp1veritas.instantRecoveryID |
Instant recovery ID |
Specify the ID of the instant recovery job to end. |
Input |
Disabled |
R |
Instant recovery information |
|
jp1veritas.waitJobFinCount |
Wait count for ending instant recovery jobs |
Specify the number of times to confirm that the instant recovery job ended. You can specify a value in the range from 1 to 3600. |
Input |
Disabled |
R |
Execution option |
|
jp1veritas.waitJobFinInterval |
Wait interval for ending instant recovery jobs |
Specify the interval (seconds) for confirming that the instant recovery job ended. 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 -. |
|
vmware.powerCLIHost |
256 or fewer one-byte alphanumeric characters, periods (.), and hyphens (-). |
|
vmware.vCenterServerName |
A maximum of 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
vmware.userName |
A maximum of 512 characters can be entered. Characters that can be used include alphanumeric characters and symbols. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, /, :, =, , , +, %. |
|
vmware.password |
A maximum of 127 characters can be entered. Characters that can be used include alphanumeric characters and symbols. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, %. |
|
vmware.portNumber |
Integer between 1 and 65535 can be entered. |
|
vmware.protocol |
Select one of the following values: http,https |
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. |
|
vmware.dataStoreName |
A maximum of 42 characters can be entered. Characters that can be used include alphanumeric characters and symbols. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, %. |
|
jp1veritas.instantRecoveryID |
An integer value in the range from 1 to 2147483647 |
|
jp1veritas.waitJobFinCount |
An integer value in the range from 1 to 3600 |
|
jp1veritas.waitJobFinInterval |
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 |
vsphereMigration |
Migration of the virtual server |
Migrates the data from the temporary datastore used for instant recovery to the datastore to be used after restoration. |
Check the task log. After removing the cause of the error, run the service again. |
|
2 |
vsphereRemoveSnapshot |
Deletion of the virtual server snapshot |
Deletes the snapshot created during instant recovery. |
Delete the snapshot (snapshot name: NBU_IR_SNAPSHOT) of the virtual server, and then execute the next and subsequent steps. |
|
3 |
jp1veritasFinInstantRecovery |
End of instant recovery (JP1/VERITAS) |
Finishes the instant recovery job. |
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. |