bpplsched

bpplsched — add, delete, or list NetBackup schedules

SYNOPSIS

<admin_dir_path>bpplsched policy_name [-v] [-M master_server,...] [-L | -l | -U] [-label sched_label] [-generation generation]

<admin_dir_path>bpplsched policy_name [-v] [-M master_server,...] -delete sched_label,... [-generation generation]

<admin_dir_path>bpplsched policy_name [-v] [-M master_server,...] -deleteall [-generation generation]

<admin_dir_path>bpplsched policy_name [-v] [-M master_server,...] -add sched_label [-st sched_type] [-freq frequency] [-mpxmax mpx_factor] [-number_copies number] [-synthetic 0|1] [-pfi_fast_recovery 0|1] [-rl retention_level [,rl_copy,...]] [-residence storage_unit_label [,stunit_copy,...]] [-pool volume_pool_label [,pool_copy,...] [-res_is_stl 0|1] [-fail_on_error 0|1[,0|1,...,0|1]] [-sg share_group [,share_copy,...] [-window start_duration] [-cal 0|1|2] [-ut] [-incl mm/dd/yyyy] [-excl mm/dd/yyyy] [-weekday day_name week] [-dayomonth value | l] [-generation generation]

On Windows systems, <admin_dir_path> is <install_path>\NetBackup\bin\admincmd\

DESCRIPTION

bpplsched does one of the following:

  • Add a new schedule to a policy.

  • Delete one or more schedules from a policy.

  • Delete all the schedules from a policy.

  • List one or all schedules in a policy.

For the -add and -delete options, bpplsched returns to the system prompt immediately after it submits the schedule change request to NetBackup. To determine whether the change was successful, run bpplsched again to list the updated schedule information.

When the listing option is used, a single entry for each schedule appears 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, which expresses the start and duration of the window for each day of the week. It 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, bpplsched performs the operation on each of the master servers that are listed. For instance, if bpplsched adds a schedule, bpplsched adds the schedule to the policy on each of the master servers that is listed for -M. If -M is used on a listing request, the listing is composed of returned information from all of 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 bpplschedrep.

Authorized users can initiate this command.

For more information about NetBackup authorization, refer to the NetBackup Security and Encryption Guide.

OPTIONS

These options are common to all forms of bpplsched:

policy_name

The name of the policy that contains the schedules. The policy must exist before you run this command. This option is required, and must be the first one on the command line.

-M master_server,...

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 bpplsched command. Each master server in the list must allow access by the system that issues the bpplsched 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 bpplsched produces a listing, the listing is the composite of the returned information from all the master servers in this list.

If bpplsched adds or deletes a schedule, all master servers in this list receive the change.

-v

Selects the verbose mode. This option causes bpplsched to log 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):

Windows systems: install_path\NetBackup\logs\admin

The remaining options depend on the form of bpplsched. The first form of bpplsched adds a schedule to the named policy. The following options apply to this form of bpplsched:

-add sched_label [suboptions]

Add a single schedule to the named policy.

The sub-options for the -add option are explained later in this description. These are attributes of the schedule being added.

Refer to the NetBackup Administrator's Guide for details on schedules and their attributes.

-cal 0 | 1 | 2

Indicates whether bpplschred 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 value | l

Specifies the day 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 schedule the 15th day of every month, enter:

-dayomonth 15

To run the last day of every month, enter:

-dayomonth l
-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. When it is omitted on the command line, the default value is 604800 (duration of one week in seconds).

-generation generation

Ensures that the command acts on a specific generation or version of a policy. The generation value increments each time a policy is saved. Use bpplinfo or bppllist to list the current generation value. If no generation is indicated, the command acts on the current version.

-incl mm/dd/yyyy

Indicates to include this single date.

-mpxmax mpx_factor

The maximum number of jobs for this schedule that NetBackup multiplexes on any one drive. mpx_factor is an integer that can range from 1 through 8 for NetBackup Server and 1 through 32 for NetBackup Enterprise Server. A value of one (1) means that backups for this schedule are not multiplexed. The default is no multiplexing.

-number_copies number

Specify the number of simultaneous backup copies. The minimum value is 1. The maximum value is 4 or the Maximum backup copies global parameter, whichever is smaller. The default is 1.

-pfi_fast_recovery 0|1

Enables the user to turn on the feature to retain snapshots for instant recovery. The default value is 0, which means this feature is disabled. A value of 1, enables this feature.

-pool volume_pool_label[,pool-copy,...]

The name of the volume pool. This choice overrides the policy-level volume pool. If you enter "*NULL*", NetBackup uses 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. If the storage unit is a disk enter "*NULL" for that copy.

-res_is_stl

Identifies that the data in the storage unit is storage lifecycle.

-residence storage_unit_label[,stunit-copy,...]

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.

-rl retention_level[,rl-copy,...]

The retention level determines how long to retain backups and archives. The retention_level is an integer between 0 and 24. The default retention level is 1. Valid retention levels and their corresponding default retention times are listed later in this description.

When you specify -number_copies greater than 1, specify a retention level for each copy.

Caution:

You can change the retention period that is associated with each level by using the NetBackup administration interface. Therefore, your configuration may have different values for each level than those shown here. Use the NetBackup administration interface to determine the actual retention periods before you make any changes with this command.

Otherwise, backups can expire sooner than you expect, which results in loss of data.

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 - 24

infinite
-sg share_group [,share_copy,...]

Specifies the share group(s) for the schedule. Do not use this option if the schedule resides on a disk storage unit. If *NONE* is specified, the writing media server owns the media that this policy writes. If *ANY* is specified, EMM chooses the media owner. *ANY* is the default value. Otherwise, the named share group owns the media. Specify a share group for each copy to display the configured share groups. Enter the following:

Windows systems: install_path\NetBackup\bin\admincmd\nbsvrgrp 
-list -summary
-st sched_type

The type of the schedule. The default schedule type is FULL. The following list contains the possible values for this attribute with their meanings:

FULL - full

INCR - differential incremental

CINC - cumulative incremental

UBAK - user backup

UARC - user archive

-synthetic 0|1

Enables the user to determine which schedule occurs. A value of zero (0)means the schedule is a real (non-synthetic) backup schedule. (0 is the default.) A value of one (1) means the schedule is a synthetic backup schedule.

-ut

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

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.

For example, to instruct the policy to run the second Monday of the month, enter:

-weekday Monday 2
-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 time 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 unit is a non-negative integer.

The second form of bpplsched deletes one or more schedules from the named policy. The following option applies to this form of bpplsched:

-delete sched_label

Delete 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 bpplsched deletes all schedule from the named policy. The following option applies to this form of bpplsched:

-deleteall

Delete all schedules from the named policy.

The fourth form of bpplsched produces a listing of information about the schedules for the named policy. The following options apply to this form of bpplsched:

-l

The list type is short (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.

-L

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.

-U

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.

EXAMPLES

EXAMPLE 1

In this example, bpplsched lists the information for schedule user within policy tstpolicy in two different ways. The first display is in long mode. The second is in User mode, which shows fewer entries than the Long mode display.

# bpplsched tstpolicy -L -label user
	Schedule:		user
		Type:			UBAK (2)
		Frequency:	 1 day(s) (86400 seconds)
		Retention Level: 0 (1 week)
		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  024:00:00   000:00:00  024:00:00
		 Monday	000:00:00  024:00:00   024:00:00  048:00:00
		 Tuesday	 000:00:00  024:00:00   048:00:00  072:00:00
		 Wednesday   000:00:00  024:00:00   072:00:00  096:00:00
		 Thursday	000:00:00  024:00:00   096:00:00  120:00:00
		 Friday	000:00:00  024:00:00   120:00:00  144:00:00
	 Saturday	000:00:00  024:00:00   144:00:00  168:00:00

# bpplsched tstpolicy -U -label user
	Schedule:		user
		Type:			User Backup
		Retention Level: 0 (1 week)
		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:
		 Sunday	 00:00:00  -->  Sunday	 24:00:00
		 Monday	 00:00:00  -->  Monday	 24:00:00
		 Tuesday	00:00:00  -->  Tuesday	24:00:00
		 Wednesday  00:00:00  -->  Wednesday  24:00:00
		 Thursday   00:00:00  -->  Thursday   24:00:00
		 Friday	 00:00:00  -->  Friday	 24:00:00
		 Saturday   00:00:00  -->  Saturday   24:00:00

EXAMPLE 2

While in operation on the system hatt, list information for the schedule named full in policy tstpolicy, as defined on the master server beaver:

# bpplsched tstpolicy -M beaver -L -label full
	Schedule:		full
	 Type:			FULL (0)
	 Frequency:	 0+ day(s) (14400 seconds)
	 Retention Level: 0 (1 week)
	 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  024:00:00   000:00:00  024:00:00
	 Monday	000:00:00  024:00:00   024:00:00  048:00:00
	 Tuesday	 000:00:00  024:00:00   048:00:00  072:00:00
	 Wednesday   000:00:00  024:00:00   072:00:00  096:00:00
	 Thursday	000:00:00  024:00:00   096:00:00  120:00:00
	 Friday	000:00:00  024:00:00   120:00:00  144:00:00
	 Saturday	000:00:00  024:00:00   144:00:00  168:00:00

EXAMPLE 3

The following example adds a new schedule, full_2, to the policy tstpolicy on beaver, and then lists the new schedule in Long mode. These commands run on the system hatt.

# bpplsched tstpolicy -M beaver -add full_2
# bpplsched tstpolicy -M beaver -label full_2 -L
	Schedule:		full_2
	 Type:			FULL (0)
	 Frequency:	 7 day(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

EXAMPLE 4

In this example, bpplsched deletes the schedules, full_3, user, user_2, and user_3 from policy tstpolicy:

# bpplsched tstpolicy -delete full_3 user user_2 user_3

EXAMPLE 5

In this example, bpplsched lists the schedule information for policy tstpolicy:

# bpplsched tstpolicy -L
	Schedule:		full
	 Type:			FULL (0)
	 Frequency:	 1 day(s) (86400 seconds)
	 Retention Level: 0 (1 week)
	 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  024:00:00   000:00:00  024:00:00
	 Monday	000:00:00  024:00:00   024:00:00  048:00:00
	 Tuesday	 000:00:00  024:00:00   048:00:00  072:00:00
	 Wednesday   000:00:00  024:00:00   072:00:00  096:00:00
	 Thursday	000:00:00  024:00:00   096:00:00  120:00:00
	 Friday	000:00:00  024:00:00   120:00:00  144:00:00
	 Saturday	000:00:00  024:00:00   144:00:00  168:00:00


	Schedule:		user
	 Type:			UBAK (2)
	 Frequency:	 1 day(s) (86400 seconds)
	 Retention Level: 0 (1 week)
	 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  024:00:00   000:00:00  024:00:00
	 Monday	000:00:00  024:00:00   024:00:00  048:00:00
	 Tuesday	 000:00:00  024:00:00   048:00:00  072:00:00
	 Wednesday   000:00:00  024:00:00   072:00:00  096:00:00
	 Thursday	000:00:00  024:00:00   096:00:00  120:00:00
	 Friday	000:00:00  024:00:00   120:00:00  144:00:00
	 Saturday	000:00:00  024:00:00   144:00:00  168:00:00

EXAMPLE 6

In this example, bpplsched adds a new schedule, full, with a window from 11 p.m. to midnight. The second bpplsched lists the information for schedule full:

  bpplsched elevenpm -add full -window 82800 3600
	bpplsched elevenpm -U -label full
	Schedule:		FULL (0)
	 Type:			Full Backup
	 Frequency:	 every 7 days (604800 seconds)
	 Retention Level: 1 (2 weeks)
	 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:
		Sunday	 23:00:00  -->  Sunday	 24:00:00
		Monday	 23:00:00  -->  Monday	 24:00:00
		Tuesday	23:00:00  -->  Tuesday	24:00:00
		Wednesday  23:00:00  -->  Wednesday  24:00:00
		Thursday   23:00:00  -->  Thursday   24:00:00
		Friday	 23:00:00  -->  Friday	 24:00:00
		Saturday   23:00:00  -->  Saturday   24:00:00

FILES

Windows systems:

install_path\NetBackup\logs\admin\*
install_path\NetBackup\db\policy\policy_name\schedule

SEE ALSO

bpplschedrep