4.12.4 Change Backup Policy Attributes (VMware)
Function
This plug-in changes the attributes of the specified backup policy (as a policy in VMware format) in cooperation with JP1/VERITAS NetBackup.
This plug-in assumes the following server:
- JP1/VERITAS NetBackup (execution-target server)
The server that runs JP1/VERITAS NetBackup (master server). This product forwards the plug-in to this server, where the plug-in is executed.
The script in this plug-in executes the following command:
- bpplinfo <backup-policy-name> Note: This is the value of the JP1VERITAS.backupPolicyName property.
-modify
-use_virtual_machine 1 Note: This is a fixed value.
-alt_client_name <alternate-client-name> Note: This is the value of the JP1VERITAS.altClientName property.
-snapshot_method_args [file_system_optimaization=<whether-to-exclude-deleted-blocks>]
Note: This is the value of the JP1VERITAS.fileSystemOpt property.
,[snapact="<orphaned-snapshot-handling>"] Note: This is the value of the JP1VERITAS.snapAct property.
,[Virtual_machine_backup="<whether-to-enable-recovery-from-VM-backup>"] Note: This is the value of the JP1VERITAS.vmBackup property.
,[nameuse="<primary-VM-identifier>"] Note: This is the value of the JP1VERITAS.nameUse property.
,[exclude_swap="<whether-to-exclude-swap-and-paging-files>"] Note: This is the value of the JP1VERITAS.excludeSwap property.
,[trantype="<transport-mode>"] Note: This is the value of the JP1VERITAS.tranType property.
,drive_selection=0 Note: This is a fixed value.
,enable_vCloud=0 Note: This is a fixed value.
,multi_org=0 Note: This is a fixed value.
,disable_quiesce=0 Note: This is a fixed value.
,skipnodisk=0 Note: This is a fixed value.
,post_events=1 Note: This is a fixed value.
,ignore_irvm=0 Note: This is a fixed value.
,rLim=10 Note: This is a fixed value.
,rTO=0 Note: This is a fixed value.
,rHz=10 Note: This is a fixed value.
For details about the bpplinfo command of JP1/VERITAS NetBackup, see the JP1/VERITAS NetBackup manual.
Use situation
The following plug-ins can be used to create and set up a backup policy:
- Create Backup Policy
- Initialize Backup Policy
- Change Backup Policy Attributes
- Add Schedule to Backup Policy
- Change Backup Policy Schedule Attributes
- Add Clients to Backup Policy
- Add File List to Backup Policy
Prerequisites
For the latest support information about [Required product for the system], [Required products for the execution-target server], and [OS of the execution-target server], see the release notes.
[Required product for the system]
JP1/Automatic Operation 11-00 or later
[Required 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
[OS of the execution-target server]
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter or Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Windows Server 2019 Standard/Datacenter
[Conditions for using the required products on the execution-target server]
No special conditions apply.
Cautions
(1) For the properties of this plug-in, do not specify a string that includes a double quotation mark (") or single quotation mark (').
(2) For the backup policy name (JP1VERITAS.backupPolicyName property), you can specify single-byte alphanumeric characters and periods (.), hyphens (-), plus signs (+), and underscores (_). However, the task terminates abnormally if the specified name begins or ends with a period (.) or hyphen (-), or includes non-specifiable characters.
(3) For other notes on the command, see the JP1/VERITAS NetBackup manual.
Execution privilege
The user who executes this plug-in must be a member of the Administrators group.
Version
02.01.00
Plug-in tags
Control JP1,VERITAS,Windows
Plug-in name displayed in the task log
jp1veritasUppdatePolicy_VMware
Return code
0: Normal
21: Error (invalid environment) Command cannot be found (error detected in the plug-in script)
27: Error (check task logs for the nature of error)
41: Error (error detected in plug-in) Missing property (error detected in 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.backupPolicyName |
Backup Policy Name |
Specifies the name of the backup policy. |
-- |
Input |
R |
|
JP1VERITAS.altClientName |
Alternate Client Name |
Specifies the VMware backup host (NetBackup access host). You can specify any backup host or the constant MEDIA_SERVER. |
-- |
Input |
R |
|
JP1VERITAS.fileSystemOpt |
Whether to Exclude Deleted Blocks |
To enable the [Exclude deleted blocks] option of [VMware] in the policy GUI, specify 1. To disable the option, specify 0. |
-- |
Input |
O |
|
JP1VERITAS.snapAct |
Orphaned Snapshot Handling |
Specifies the value for the [Orphaned snapshot handling] option of [VMware] in the policy GUI. You can specify 0 (ignore), 1 (cancel), or 2 (delete NetBackup). |
-- |
Input |
O |
|
JP1VERITAS.vmBackup |
Whether to Enable Recovery from a VM Backup |
Specifies the value for the [Enable file recovery from VM backup] option of [VMware] in the policy GUI. You can specify 1 (disable) or 2 (enable). |
-- |
Input |
O |
|
JP1VERITAS.nameUse |
Primary VM Identifier |
Specifies the value for the [Primary VM identifier] option of [VMware] in the policy GUI. You can specify 0 (VM host name), 1 (VM display name), 2 (VM BIOS UUID), 3 (VM DNS name), or 4 (VM instance UUID). |
-- |
Input |
O |
|
JP1VERITAS.excludeSwap |
Whether to Exclude Swap and Paging Files |
Specifies the value for the [Exclude swap and paging files] option of [VMware] in the policy GUI. To enable the option, specify 1. To disable the option, specify 0. |
-- |
Input |
O |
|
JP1VERITAS.tranType |
Transport Mode |
Specifies the value for the [Transport modes] option of [VMware] in the policy GUI. You can specify "san", "hotadd", "nbd", or "nbdssl". To specify multiple values, use a colon (:) as a separator. |
-- |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |