Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.1.2)
  1. Introduction
    1.  
      About NetBackup commands
    2.  
      Navigating multiple menu levels
    3.  
      NetBackup command conventions
    4.  
      NetBackup Media Manager command notes
    5.  
      IPV6 updates
    6.  
      Removal of nbexecute command
  2. Appendix A. NetBackup Commands
    1.  
      acsd
    2.  
      add_media_server_on_clients
    3.  
      backupdbtrace
    4.  
      backuptrace
    5.  
      bmrc
    6.  
      bmrconfig
    7.  
      bmrepadm
    8.  
      bmrprep
    9.  
      bmrs
    10.  
      bmrsrtadm
    11.  
      bp
    12.  
      bparchive
    13.  
      bpbackup
    14.  
      bpbackupdb
    15.  
      bpcatarc
    16.  
      bpcatlist
    17.  
      bpcatres
    18.  
      bpcatrm
    19.  
      bpcd
    20.  
      bpchangeprimary
    21.  
      bpclient
    22.  
      bpclimagelist
    23.  
      bpclntcmd
    24.  
      bpclusterutil
    25.  
      bpcompatd
    26.  
      bpconfig
    27.  
      bpdbjobs
    28.  
      bpdbm
    29.  
      bpdgclone
    30.  
      bpdown
    31.  
      bpduplicate
    32.  
      bperror
    33.  
      bpexpdate
    34.  
      bpfis
    35.  
      bpflist
    36.  
      bpgetconfig
    37.  
      bpgetdebuglog
    38.  
      bpimage
    39.  
      bpimagelist
    40.  
      bpimmedia
    41.  
      bpimport
    42.  
      bpinst
    43.  
      bpkeyfile
    44.  
      bpkeyutil
    45.  
      bplabel
    46.  
      bplist
    47.  
      bpmedia
    48.  
      bpmedialist
    49.  
      bpminlicense
    50.  
      bpnbat
    51.  
      bpnbaz
    52.  
      bppficorr
    53.  
      bpplcatdrinfo
    54.  
      bpplclients
    55.  
      bppldelete
    56.  
      bpplinclude
    57.  
      bpplinfo
    58.  
      bppllist
    59.  
      bpplsched
    60.  
      bpplschedrep
    61.  
      bpplschedwin
    62.  
      bppolicynew
    63.  
      bpps
    64.  
      bprd
    65.  
      bprecover
    66.  
      bprestore
    67.  
      bpretlevel
    68.  
      bpschedule
    69.  
      bpschedulerep
    70.  
      bpsetconfig
    71.  
      bpstsinfo
    72.  
      bpstuadd
    73.  
      bpstudel
    74.  
      bpstulist
    75.  
      bpsturep
    76.  
      bptestbpcd
    77.  
      bptestnetconn
    78.  
      bptpcinfo
    79.  
      bpup
    80.  
      bpverify
    81.  
      cat_convert
    82.  
      cat_export
    83.  
      cat_import
    84.  
      configurePorts
    85.  
      configureTPCerts
    86.  
      create_nbdb
    87.  
      csconfig cldinstance
    88.  
      csconfig cldprovider
    89.  
      csconfig meter
    90.  
      csconfig throttle
    91.  
      duplicatetrace
    92.  
      importtrace
    93.  
      jbpSA
    94.  
      jnbSA
    95.  
      ltid
    96.  
      manageClientCerts
    97.  
      mklogdir
    98.  
      nbauditreport
    99.  
      nbcatsync
    100.  
      NBCC
    101.  
      NBCCR
    102.  
      nbcertcmd
    103.  
      nbcertupdater
    104.  
      nbcldutil
    105.  
      nbcloudrestore
    106.  
      nbcomponentupdate
    107.  
      nbcplogs
    108.  
      nbdb_admin
    109.  
      nbdb_backup
    110.  
      nbdb_move
    111.  
      nbdb_ping
    112.  
      nbdb_restore
    113.  
      nbdb_unload
    114.  
      nbdbms_start_server
    115.  
      nbdbms_start_stop
    116.  
      nbdc
    117.  
      nbdecommission
    118.  
      nbdelete
    119.  
      nbdeployutil
    120.  
      nbdevconfig
    121.  
      nbdevquery
    122.  
      nbdiscover
    123.  
      nbdna
    124.  
      nbemm
    125.  
      nbemmcmd
    126.  
      nbfindfile
    127.  
      nbfirescan
    128.  
      nbftadm
    129.  
      nbftconfig
    130.  
      nbgetconfig
    131.  
      nbhba
    132.  
      nbholdutil
    133.  
      nbhostidentity
    134.  
      nbhostmgmt
    135.  
      nbhypervtool
    136.  
      nbinstallcmd
    137.  
      nbjm
    138.  
      nbkmsutil
    139.  
      nboraadm
    140.  
      nborair
    141.  
      nbpem
    142.  
      nbpemreq
    143.  
      nbperfchk
    144.  
      nbplupgrade
    145.  
      nbrb
    146.  
      nbrbutil
    147.  
      nbregopsc
    148.  
      nbreplicate
    149.  
      nbrepo
    150.  
      nbrestorevm
    151.  
      nbseccmd
    152.  
      nbsetconfig
    153.  
      nbsnapimport
    154.  
      nbsnapreplicate
    155.  
      nbsqladm
    156.  
      nbstl
    157.  
      nbstlutil
    158.  
      nbstop
    159.  
      nbsu
    160.  
      nbsvrgrp
    161.  
      resilient_clients
    162.  
      restoretrace
    163.  
      stopltid
    164.  
      tl4d
    165.  
      tl8d
    166.  
      tl8cd
    167.  
      tldd
    168.  
      tldcd
    169.  
      tlhd
    170.  
      tlhcd
    171.  
      tlmd
    172.  
      tpautoconf
    173.  
      tpclean
    174.  
      tpconfig
    175.  
      tpext
    176.  
      tpreq
    177.  
      tpunmount
    178.  
      verifytrace
    179.  
      vltadm
    180.  
      vltcontainers
    181.  
      vlteject
    182.  
      vltinject
    183.  
      vltoffsitemedia
    184.  
      vltopmenu
    185.  
      vltrun
    186.  
      vmadd
    187.  
      vmchange
    188.  
      vmcheckxxx
    189.  
      vmd
    190.  
      vmdelete
    191.  
      vmoprcmd
    192.  
      vmphyinv
    193.  
      vmpool
    194.  
      vmquery
    195.  
      vmrule
    196.  
      vmupdate
    197.  
      vnetd
    198.  
      vssat
    199.  
      vwcp_manage
    200.  
      vxlogcfg
    201.  
      vxlogmgr
    202.  
      vxlogview
    203.  
      W2KOption

Name

bpschedulerep — modify attributes of disk staging storage unit (DSSU) schedule

SYNOPSIS

bpschedulerep sched_label [ -M master_server,...] [-v] [-freq backup_frequency] [-stage_priority number] [-altreadhost hostname] [-cal 0|1|2] [-incl mm/dd/yyyy] [-excl mm/dd/yyyy] [-delincl mm/dd/yyyy] [-delexcl 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] [-deldayomonth 1-31 [1-31]... | l] [-delweekday day_name week [day_name week]...] [-ci] [-ce] [-cw] [-cd] [-number_copies number] [-fail_on_error 0|1[,0|1,...,0|1]] [-residence storage_unit_label [,stunit-copy2,...]] [-pool volume_pool_label [,pool-copy2,...]] [-(0..6) start duration]

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\

DESCRIPTION

bpschedulerep changes the attributes of a NetBackup disk staging storage unit (DSSU) schedule. The schedule that bpschedulerep named should already exist when this command is run. bpschedulerep changes the schedule on each of the master servers that are listed, if the -M option is used.

Any authorized user can initiate this command.

For more about NetBackup authorization, see the NetBackup Security and Encryption Guide.

OPTIONS

-(0..6) start duration

Specifies the window during which NetBackup can run the backups for this schedule. This window applies to a specific day of the week. 0 corresponds to Sunday, 1 to Monday, and so on.

start is the time at which the backup window opens for this schedule. This number is the number of seconds since midnight. It is an integer between 0 and 86400 (the number of seconds in a day).

duration is the length of time that the window remains open. The time unit is seconds. It is a non-negative integer.

-cal 0|1|2

Indicates whether bpschedulerep 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:

-dayomonth l
-deldayomonth 1-31 [1-31]... | l

Specifies a day of every month to exclude as a run day. Enter 1 (lowercase L) to exclude the last day of every month, whether the month contains 28, 29, 30, or 31 days. This command can only remove the dates that were added by using the -dayomonth command.

For example, to exclude from the schedule the 20th day and 21st day of every month that you originally specified as run days, enter:

-deldayomonth 20 21
-delweekday day_name week [day_name week]...

Specifies a day of the week and the week of the month to exclude as a run day from the schedule. This command can only remove the dates that were added by using the -weekday command.

  • 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 delete the second Monday of the month that you originally specified as a run day, enter:

-delweekday Monday 2
-excl mm/dd/yyyy

Indicates to exclude this single date.

-delincl mm/dd/yyyy

Indicates to delete this single date.

-delexcl mm/dd/yyyy

Indicates to delete this single date.

-ci

Clears all specific include dates.

-ce

Clears all specific exclude dates.

-cw

Clears all week days.

-cd

Clears all days of a month.

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

Specifies how much time can elapse between successful automatic backups for clients on this schedule. Frequency does not apply to user schedules because the user can perform a backup or archive any time the backup window is open. This value is a positive integer that represents the number of seconds between successful automatic backups for this schedule.

-help

Prints a command-line usage message.

-incl mm/dd/yyyy

Indicates to include this single date.

-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 bpschedulerep command. Each master server in the list must allow access by the system that issued the bpschedulerep command. If an error occurs for any master server, the process terminates at that point.

The schedule attributes are modified on all the master servers in this list.

-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,...]

Specifies the volume pool(s) for the schedule. Do not use this option if a disk storage unit is the residence for the schedule. If "*NULL*" is specified, the volume pool for the schedule is the volume pool of the policy that contains this schedule.

Specify a pool for each copy.

To display the configured volume pools, run the following command:

UNIX systems:

/usr/openv/volmgr/bin/vmpool -listall

Windows systems:

install_path\Volmgr\bin\vmpool -listall
-residence storage_unit_label[,stunit-copy2,...]

Specifies the label(s) of the storage unit to be used for storing the backups that were created according to this schedule. If "*NULL*" is specified, the residence for the schedule defaults to the residence of the policy that contains this schedule. If the residence value is a storage unit label, the residence for the schedule becomes that storage unit; it overrides the residence for the policy.

Specify a storage unit for each copy.

Run bpstulist to display the set of defined storage units.

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

sched_label

The name of the previously created schedule to be changed.

-weekday day_name week [day_name week]...

Specifies a day of the week and a 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
-v

Selects the verbose mode. This option causes bpschedulerep to log additional information for debugging purposes. The information goes into the NetBackup administration daily debug log. This option is meaningful only when NetBackup enables the debug log function (that is, when the following directory is defined):

UNIX systems:

/usr/openv/netbackup/logs/admin

Windows systems:

install_path\NetBackup\logs\admin
-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 the backup on the 6th of the month, enter:

-xdayomonth 6
-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 third Monday and Wednesday of the month, enter:

-xweekday Monday 3 Wednesday 3

EXAMPLES

Example 1 - Change and schedule named test.

# bpschedulerep test -cal 2

The following is received after the change and a bpschedule -label test listing.

SCHED test 0 1 604800 1 0 0 0 *NULL* 0 2 0 0 0 
SCHEDWIN 0 0 0 0 0 0 0 0 0 0 0 0 0 0
SCHEDRES *NULL* *NULL* *NULL* *NULL* *NULL* *NULL* *NULL* *NULL*
SCHEDPOOL *NULL* *NULL* *NULL* *NULL* *NULL* *NULL* *NULL* *NULL*
SCHEDRL 1 1 1 1 1 1 1 1 
SCHEDFOE 0 0 0 0 0 0 0 0

Example 2 - For Saturday and Sunday of each week, have the window for schedule test open at 10 p.m. instead of 11 p.m. Also, set the window duration to two (2) hours instead of one (1) hour. bpschedulerep resets the windows, and bpschedule lists the new schedule values.

# bpschedulerep test -0 79200 7200 -6 79200 7200
bpschedule -U -label test
Schedule:          test
  Type:            Full Backup
  Frequency:       every 7 days
  Retention Level: 1 (2 weeks)
  Maximum MPX:     1
  Residence:       (specific storage unit not required)
  Volume Pool:     (same as policy volume pool)
  Daily Windows:
        Sunday     22: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   22:00:00  -->  Saturday   24:00:00

FILES

UNIX systems:

/usr/openv/netbackup/logs/admin/*
/usr/openv/netbackup/db/sched/schedule name

Windows systems:

install_path\NetBackup\logs\admin\*
install_path\NetBackup\db\sched\schedule name

SEE ALSO

See bpschedule.