Veritas NetBackup™ Commands Reference Guide
- Appendix A. NetBackup Commands
bpschedule — add, delete, or list disk staging storage unit (DSSU) schedules
[-v] [-M master_server,...] -add sched_label [-freq frequency] [-stage_priority number] [-altreadhost hostname] [-number_copies number] [-residence storage_unit_label [,stunit-copy2,...]] [-pool volume_pool_label [,pool-copy2,...]] [-fail_on_error 0|1[,0|1,...0|1] [-window start_duration]] [-cal 0|1|2] [-ut] [-incl mm/dd/yyyy] [-excl mm/dd/yyyy] [-weekday day_name week [day_name week]...] [-dayomonth 1-31 [1-31]... | l] [-xweekday day_name week [day_name week]...] [-xdayomonth 1-31 [1-31]... | l]
[-v] [-M master_server,...] -delete sched_label...
[-v] [-M master_server,...] -deleteall
[-v] [-M master_server,...] [-L | -l | -U] [-label sched_label]
On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/admincmd/
On Windows systems, the directory path to this command is <install_path>\NetBackup\bin\admincmd\
The bpschedule command does the following:
Adds a new disk staging storage unit (DSSU) schedule.
Deletes one or more DSSU schedules.
Deletes all the DSSU schedules.
Lists one or all DSSU schedules (default is list all DSSU schedules).
For the -add and -delete options, bpschedule returns to the system prompt immediately after it submits the DSSU schedule change request to NetBackup. To determine whether the change was successful, run bpschedule again to list the updated schedule information.
The list option displays a single entry for each schedule, even if the -M option is used. The -l form lists the information for each schedule on several lines. -l does not identify the attributes by name; these are as follows (where the names are not described, they are reserved for internal NetBackup use):
Line 1: SCHED, schedule name, type, max_mpx, frequency, retention level, u_wind/o/d, two internal attributes, maximum fragment size, calendar, number of copies, and fail on error. Note that u_wind/o/d is a field reserved for future use. The u_wind entry in the -L display is also reserved for future use.
Line 2: SCHEDWIN, seven pairs of the form start,duration, expresses the start and duration of the window for each day of the week. The week starts with Sunday.
Line 3: SCHEDRES, residence (a value for each copy).
Line 4: SCHEDPOOL, pool (a value for each copy).
Line 5: SCHEDRL, retention level (a value for each copy).
Line 6: SCHEDFOE, fail on error (a value for each copy).
If the -M option is used, bpschedule performs the operation on each of the listed master servers. For instance, if bpschedule adds a schedule, bpschedule adds the schedule to the policy on each of the listed master servers for -M. If -M is used on a listing request, the listing is composed of the returned information from all the master servers in the -M list. If the command fails for any of the master servers, activity stops at that point.
To modify an existing NetBackup schedule, use the NetBackup command bpschedulerep.
Any authorized user can initiate this command.
For more about NetBackup authorization, see the NetBackup Security and Encryption Guide.
These options are common to all forms of bpschedule:
- -M master_server,...
Specifies a list of alternative master servers. This list is a comma-separated list of host names. If this option is present, each master server in the list runs the bpschedule command. Each master server in the list must allow access by the system that issues the bpschedule command.
If this option is present, the command is run on each master server in the list. If an error occurs for any master server, the process terminates at that point.
If bpschedule produces a listing, the listing is the composite of the returned information from all the master servers in this list.
If bpschedule adds or deletes a schedule, all master servers in this list receive the change.
Selects the verbose mode where bpschedule logs additional information for debugging purposes. The information goes into the NetBackup administration debug log. This option is meaningful only when NetBackup enables the debug log function (that is, when the following directory is defined):
The remaining options depend on the form of bpschedule. The first form of bpschedule adds a schedule to the specified storage unit name. The following options apply to this form of bpschedule:
- -add sched_label [suboptions]
Adds a single schedule to the specified storage unit name. The following describes the suboptions for the -add option. These are attributes of the schedule being added.
- -cal 0|1|2
Indicates whether bpschedule follows a calendar-based schedule or a frequency-based schedule.
0 = frequency-based schedule
1 = calendar-based schedule with no retries after run day
2 = calendar-based schedule with retires after run day
- -dayomonth 1-31 [1-31]... | l
Specifies the day or days of every month to run the schedule. Enter l (lowercase L) to run the last day of every month, whether the month contains 28, 29, 30, or 31 days.
For example, to run the policy backup on the 14th day and the 28th day of every month, enter the following:
-dayomonth 14 28
To run the last day of every month, enter:
- -excl mm/dd/yyyy
Indicates to exclude this single date.
- -fail_on_error 0|1[,0|1,...,0|1]
Specifies whether to fail all other copies if one copy fails. If no parameter is specified, 0 is default for all copies. Specify a value for each copy.
0 = Do not fail the other copies
1 = Fail other copies
- -freq frequency
Determines how often backups run. Represents the number of seconds between the backups that are initiated according to this schedule. Valid range for this option is 0 through 2419200 (number of seconds in four weeks). When this value is omitted on the command line, the default value is 604800 (duration of one week in seconds).
- -incl mm/dd/yyyy
Indicates to include this single date.
- -number_copies number
Specify the number of simultaneous backup copies. The valid value range is 1-4. The default is 1.
- -pool volume_pool_label[,pool-copy2,...]
The name of the volume pool. This choice overrides the policy-level volume pool. The value "*NULL*" causes NetBackup to use the volume pool that is specified at the policy level. The default is to use the volume pool that is specified at the policy level. The volume pool label cannot be None. If you do not specify a volume pool at either the schedule level or the policy level, NetBackup uses a default value of NetBackup.
When you specify -number_copies greater than 1, specify a pool for each copy.
- -residence storage_unit_label [,stunit-copy2,...]
The name of the storage unit, which specifies the location of the backup images. The value "*NULL*" causes NetBackup to use the storage unit that is specified at the policy level. The default is for NetBackup to use the storage unit that is specified at the policy level. If you do not specify a storage unit at either the schedule level or the policy level, NetBackup uses the next storage unit available.
When you specify -number_copies greater than 1, specify a residence for each copy.
- -stage_priority number
The order in which storage units are to be selected within a storage unit group:
1 = Use the storage units in the order that appears in the storage unit group dialog box (default).
2 = Use the storage unit least recently used. (The storage units take turns.)
3 = Use the first storage unit in the list that is not full or down. If the storage unit is only busy, the policy waits to write to it.
- -altreadhost hostname
The server to be used to read a backup image that a different media server originally wrote.
If any of the date or the time arguments follow -ut, they are accepted as UNIX time, instead of the standard time format. The -ut option is used primarily for Java.
- -weekday day_name week [day_name week]...
Specifies a day of the week, and the week of the month, as a run day in the schedule.
The day_name is: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday.
The week is the number of the week in the month. A week begins on Sunday and ends on Saturday. Valid values are 1-5.
For example, to instruct the policy to run every Sunday of the month, enter:
-weekday Sunday 1 Sunday 2 Sunday 3 Sunday 4 Sunday 5
- -window start_duration
Specifies when NetBackup can run the backups for this schedule. Every day of the week has the same window.
start is the time at which the backup window opens for this schedule. This number is the number of seconds since midnight. This number is an integer between 0 and 86399 (86400 seconds in a day).
duration is the length of time that the window remains open. The time unit is seconds. This number is a non-negative integer.
- -xdayomonth 1-31 [1-31]... | l
Specifies the day or days of the month that you want to exclude as run days in the schedule. Use l (lowercase L) to indicate the last day of the month.
For example, to instruct the policy to not run on the 14th and 15th of the month, enter:
-xdayomonth 14 15
- -xweekday day_name week [day_name week]...
Specifies the day of the week and week of the month, to exclude as a run day in the schedule.
The day_name is: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday.
The week is the number of the week in the month.
Use l to indicate the last week of the month. The week of the month starts on Sunday and ends on Monday. Valid values are 1-5.
For example, to instruct the policy to not run on the first and third Mondays of the month, enter:
-xweekday Monday 1 Monday 3
The second form of bpschedule deletes one or more schedules from the named policy. The following option applies to this form of bpschedule:
- -delete sched_label
Deletes the listed schedules from the named policy. Separate the elements of the sched_label list with spaces. There can be up to 25 labels in the list.
The third form of bpschedule deletes all schedule from the named policy. The following option applies to this form of bpschedule:
Deletes all schedules from the named policy.
The fourth form of bpschedule produces a listing of information about the schedules for the named policy. The following options apply to this form of bpschedule:
The list type is short. This list is the default list type. This option produces a terse listing that includes all attributes for the schedule. Each schedule occupies one line of the listing. Most attribute values are expressed numerically. This option is useful for scripts or the programs that rework the listing contents into a customized report format.
The list type is long. This listing includes all attributes for the schedule. Some attribute values are descriptive terms, rather than numbers.
- -label sched_label
List the attributes for this schedule in the named policy. The default is to list information for all schedules for the named policy.
The list type is user. This listing is similar to the long-type list, but it has fewer entries. Most attribute values are descriptive terms, rather than numbers.
List the information for schedule test in long form.
# bpschedule -L -label test Schedule: test Type: FULL (0) Frequency: 7day(s) (604800 seconds) Retention Level: 1(2 weeks) u-wind/o/d: 0 0 Incr Type: DELTA (0) Incr Depends: (none defined) Max Frag Size: 0 MB (1048576 MB) Maximum MPX: 1 Number copies: 1 Fail on Error: 0 Residence: (specific storage unit not required) Volume Pool: (same as policy volume pool) Daily Windows: Day Open Close W-Open W-Close Sunday 000:00:00 000:00:00 Monday 000:00:00 000:00:00 Tuesday 000:00:00 000:00:00 Wednesday 000:00:00 000:00:00 Thursday 000:00:00 000:00:00 Friday 000:00:00 000:00:00 Saturday 000:00:00 000:00:00
/usr/openv/netbackup/logs/admin/* /usr/openv/netbackup/db/sched/schedule name
install_path\NetBackup\logs\admin\* install_path\NetBackup\db\sched\schedule name