4.12.7 Change Backup Policy Schedule Attributes
Function
This plug-in changes the schedule attributes of the specified backup policy 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:
- bpplschedrep <policy-name> Note: This is the value of the JP1VERITAS.backupPolicyName property.
<schedule-label> Note: This is the value of the JP1VERITAS.scheduleLabel property.
[-freq <backup-interval>] Note: This is the value of the JP1VERITAS.backupFrequency property.
[-checksum_change_detection <whether-to-enable-forced-rescan-of-accelerator>]
Note: This is the value of the JP1VERITAS.accelForceRescan property.
[-0 <Sunday-backup-period-start-time> Note: This is the value of the JP1VERITAS.sunStart property.
<Sunday-backup-period-duration>] Note: This is the value of the JP1VERITAS.sunDuration property.
[-1 <Monday-backup-period-start-time> Note: This is the value of the JP1VERITAS.monStart property.
<Monday-backup-period-duration>] Note: This is the value of the JP1VERITAS.monDuration property.
[-2 <Tuesday-backup-period-start-time> Note: This is the value of the JP1VERITAS.tueStart property.
<Tuesday-backup-period-duration>] Note: This is the value of the JP1VERITAS.tueDuration property.
[-3 <Wednesday-backup-period-start-time> Note: This is the value of the JP1VERITAS.wedStart property.
<Wednesday-backup-period-duration>] Note: This is the value of the JP1VERITAS.wedDuration property.
[-4 <Thursday-backup-period-start-time> Note: This is the value of the JP1VERITAS.thuStart property.
<Thursday-backup-period-duration>] Note: This is the value of the JP1VERITAS.thuDuration property.
[-5 <Friday-backup-period-start-time> Note: This is the value of the JP1VERITAS.friStart property.
<Friday-backup-period-duration>] Note: This is the value of the JP1VERITAS.friDuration property.
[-6 <Saturday-backup-period-start-time> Note: This is the value of the JP1VERITAS.satStart property.
<Saturday-backup-period-duration>] Note: This is the value of the JP1VERITAS.satDuration property.
[-rl <backup-retention>] Note: This is the value of the JP1VERITAS.retention property.
For details about the bpplschedrep command of JP1/VERITAS NetBackup, see the JP1/VERITAS NetBackup manual.
Note on property specification:
- For the -0 to -6 options, specify both the backup period start time and backup period duration (JP1VERITAS.xxxStart and JP1VERITAS.xxxDuration properties). If only one of these values is specified for a day of the week, the specification is ignored, and no backup period is set for the day.
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
jp1veritasModifySchedule
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.scheduleLabel |
Schedule Label |
Specifies the label of the schedule. |
-- |
Input |
R |
|
JP1VERITAS.backupFrequency |
Backup Interval |
Specifies in seconds the interval of automatic backup. |
-- |
Input |
O |
|
JP1VERITAS.accelForceRescan |
Forced Rescan of Accelerator |
To enable forced rescan of the accelerator, specify 1. To disable it, specify 0. |
-- |
Input |
O |
|
JP1VERITAS.sunStart |
Backup Period Start Time (Sunday) |
Specifies the start time of a backup to be performed on Sundays. The start time is specified in seconds from 0:00. |
-- |
Input |
O |
|
JP1VERITAS.sunDuration |
Backup Period Duration (Sunday) |
Specifies (in seconds) the duration of a backup to be performed on Sundays. |
-- |
Input |
O |
|
JP1VERITAS.monStart |
Backup Period Start Time (Monday) |
Specifies the start time of a backup to be performed on Mondays. The start time is specified in seconds from 0:00. |
-- |
Input |
O |
|
JP1VERITAS.monDuration |
Backup Period Duration (Monday) |
Specifies (in seconds) the duration of a backup to be performed on Mondays. |
-- |
Input |
O |
|
JP1VERITAS.tueStart |
Backup Period Start Time (Tuesday) |
Specifies the start time of a backup to be performed on Tuesdays. The start time is specified in seconds from 0:00. |
-- |
Input |
O |
|
JP1VERITAS.tueDuration |
Backup Period Duration (Tuesday) |
Specifies (in seconds) the duration of a backup to be performed on Tuesdays. |
-- |
Input |
O |
|
JP1VERITAS.wedStart |
Backup Period Start Time (Wednesday) |
Specifies the start time of a backup to be performed on Wednesdays. The start time is specified in seconds from 0:00. |
-- |
Input |
O |
|
JP1VERITAS.wedDuration |
Backup Period Duration (Wednesday) |
Specifies (in seconds) the duration of a backup to be performed on Wednesdays. |
-- |
Input |
O |
|
JP1VERITAS.thuStart |
Backup Period Start Time (Thursday) |
Specifies the start time of a backup to be performed on Thursdays. The start time is specified in seconds from 0:00. |
-- |
Input |
O |
|
JP1VERITAS.thuDuration |
Backup Period Duration (Thursday) |
Specifies (in seconds) the duration of a backup to be performed on Thursdays. |
-- |
Input |
O |
|
JP1VERITAS.friStart |
Backup Period Start Time (Friday) |
Specifies the start time of a backup to be performed on Fridays. The start time is specified in seconds from 0:00. |
-- |
Input |
O |
|
JP1VERITAS.friDuration |
Backup Period Duration (Friday) |
Specifies (in seconds) the duration of a backup to be performed on Fridays. |
-- |
Input |
O |
|
JP1VERITAS.satStart |
Backup Period Start Time (Saturday) |
Specifies the start time of a backup to be performed on Saturdays. The start time is specified in seconds from 0:00. |
-- |
Input |
O |
|
JP1VERITAS.satDuration |
Backup Period Duration (Saturday) |
Specifies (in seconds) the duration of a backup to be performed on Saturdays. |
-- |
Input |
O |
|
JP1VERITAS.retention |
Backup Retention |
Specifies the retention period of the obtained backup data. The specifiable values are as follows: 0 (1 week), 1 (2 weeks), 2 (3 weeks), 3 (1 month), 4 (2 months), 5 (3 months), 6 (6 months), 7 (9 months), 8 (1 year), 9 to 24 (indefinite) |
-- |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |