Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.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
  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.  
      configureCertsForPlugins
    85.  
      configureMQ
    86.  
      configurePorts
    87.  
      configureWebServerCerts
    88.  
      create_nbdb
    89.  
      csconfig cldinstance
    90.  
      csconfig cldprovider
    91.  
      csconfig meter
    92.  
      csconfig throttle
    93.  
      csconfig reinitialize
    94.  
      duplicatetrace
    95.  
      importtrace
    96.  
      jbpSA
    97.  
      jnbSA
    98.  
      ltid
    99.  
      manageClientCerts
    100.  
      mklogdir
    101.  
      nbauditreport
    102.  
      nbcatsync
    103.  
      NBCC
    104.  
      NBCCR
    105.  
      nbcertcmd
    106.  
      nbcertupdater
    107.  
      nbcldutil
    108.  
      nbcloudrestore
    109.  
      nbcomponentupdate
    110.  
      nbcplogs
    111.  
      nbdb_admin
    112.  
      nbdb_backup
    113.  
      nbdb_move
    114.  
      nbdb_ping
    115.  
      nbdb_restore
    116.  
      nbdb_unload
    117.  
      nbdbms_start_server
    118.  
      nbdbms_start_stop
    119.  
      nbdc
    120.  
      nbdecommission
    121.  
      nbdelete
    122.  
      nbdeployutil
    123.  
      nbdevconfig
    124.  
      nbdevquery
    125.  
      nbdiscover
    126.  
      nbdna
    127.  
      nbemm
    128.  
      nbemmcmd
    129.  
      nbfindfile
    130.  
      nbfirescan
    131.  
      nbftadm
    132.  
      nbftconfig
    133.  
      nbgetconfig
    134.  
      nbhba
    135.  
      nbholdutil
    136.  
      nbhostidentity
    137.  
      nbhostmgmt
    138.  
      nbhypervtool
    139.  
      nbimageshare
    140.  
      nbinstallcmd
    141.  
      nbjm
    142.  
      nbkmsutil
    143.  
      nboraadm
    144.  
      nborair
    145.  
      nbpem
    146.  
      nbpemreq
    147.  
      nbperfchk
    148.  
      nbplupgrade
    149.  
      nbrb
    150.  
      nbrbutil
    151.  
      nbregopsc
    152.  
      nbreplicate
    153.  
      nbrepo
    154.  
      nbrestorevm
    155.  
      nbseccmd
    156.  
      nbsetconfig
    157.  
      nbsnapimport
    158.  
      nbsnapreplicate
    159.  
      nbsqladm
    160.  
      nbstl
    161.  
      nbstlutil
    162.  
      nbstop
    163.  
      nbsu
    164.  
      nbsvrgrp
    165.  
      resilient_clients
    166.  
      restoretrace
    167.  
      stopltid
    168.  
      tl4d
    169.  
      tl8d
    170.  
      tl8cd
    171.  
      tldd
    172.  
      tldcd
    173.  
      tlhd
    174.  
      tlhcd
    175.  
      tlmd
    176.  
      tpautoconf
    177.  
      tpclean
    178.  
      tpconfig
    179.  
      tpext
    180.  
      tpreq
    181.  
      tpunmount
    182.  
      verifytrace
    183.  
      vltadm
    184.  
      vltcontainers
    185.  
      vlteject
    186.  
      vltinject
    187.  
      vltoffsitemedia
    188.  
      vltopmenu
    189.  
      vltrun
    190.  
      vmadd
    191.  
      vmchange
    192.  
      vmcheckxxx
    193.  
      vmd
    194.  
      vmdelete
    195.  
      vmoprcmd
    196.  
      vmphyinv
    197.  
      vmpool
    198.  
      vmquery
    199.  
      vmrule
    200.  
      vmupdate
    201.  
      vnetd
    202.  
      vssat
    203.  
      vwcp_manage
    204.  
      vxlogcfg
    205.  
      vxlogmgr
    206.  
      vxlogview
    207.  
      W2KOption

Name

bpdbjobs — interact with NetBackup jobs database

SYNOPSIS

bpdbjobs [-report] [-M master_servers] [-ignore_parent_jobs] [ -vault | -lvault | -all_columns | -most_columns | -gdm ] [-file pathname] [-append] [-noheader] [-mastertime] [-t timestamp] [-jobid job1,job2,...jobn] [verbose]

bpdbjobs -summary [-M master_servers] [-ignore_parent_jobs] [ -U | -L | -all_columns ] [-file pathname] [-append] [verbose]

bpdbjobs -resume | -suspend | -delete | -cancel | -restart job1,job2,...jobn | type=jobtype | type=all [-M master_servers] [-quiet] [-reason "string"]

bpdbjobs -cancel_all [-M master_servers] [-reason "string"]

bpdbjobs -clean [-M master_servers] [ -keep_hours hours | -keep_days days ] [ -keep_successful_hours hours | -keep_successful_days days ] [verbose]

bpdbjobs -version

bpdbjobs -change_priority_by [-M master_servers] -priority number -jobid job1,job2,...jobn

bpdbjobs -set_priority [-M master_servers] -priority number -jobid job1,job2,...jobn

bpdbjobs -fast

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

bpdbjobs interacts with the jobs database and is useful in scripts or as a command-line administration tool. It prints the entire jobs database, prints a summary of the database, deletes done jobs, cancels incompleted jobs, and cleans old jobs.

To customize the output of bpdbjobs, add column definition entries (BPDBJOBS_COLDEFS) in the bp.conf file.

See the NetBackup Administrator's Guide, Volume I for more information about the following: the bp.conf file, a complete list of the definitions, and the BPDBJOBS_COLDEFS entries.

The -cancel, -delete, -jobid, -resume, and -suspend options all use the jobtype as a suboption. Enter one of the following as jobtype. (Letters following the capitalized letters are ignored.)

 ALL | *
  REStore
  BACkup
  ARChive
  VERify
  DUPlicate
  IMPort
  LABel
  ERAse
  VAUlt
  TPReq
  CLEan
  FORmat
  INVentory
  QUAlification
  DBbackup | CATalogbackup

Note:

For the NetBackup Accelerator feature, bpdbjobs reports the amount of data that was transferred over the network for each backup. You can also configure the command to show the transferred data in the field that normally shows the Accelerator backup image size. For details, see the Accelerator topics in the NetBackup Administrator's Guide Volume I, the NetBackup for VMware Administrator's Guide and the NetBackup for NDMP Administrator's Guide.

OPTIONS

-all_columns

Displays all columns of a report or summary. The output of this command consists of a single line per backup job. Each line of the output is a comma-delimited list. Information such as job ID, field 1, and client name, field 7, are included in the output.

Note:

The field values in the -all_columns options are not stable. They can change from release to release. Any information about the fields is subject to change without notice.

-append

Appends the output to the file that the -file option specifies. If no -file option is provided, the output goes to stdout.

-cancel job1,job2,...jobn |type=jobtype | type=all

Causes bpdbjobs to cancel active jobs cleanly that appear with a status code of 150 in the Activity Monitor. For example:

bpdbjobs -cancel 11328
bpdbjobs -cancel 11328,11329,11330

Possible jobtype values are listed in the Description section.

-cancel_all

Causes bpdbjobs to cleanly cancel all incomplete jobs that appear with a Status 150 in the Activity Monitor. For example:

bpdbjobs -cancel_all
-change_priority_by [-M master_servers] -priority number -jobid job1,job2,...jobn

Changes the priority of the specified job or jobs.

-clean

Causes bpdbjobs to delete the completed jobs that are older than a specified time period. Use with the -keep_hours or -keep_days, or -keep_successful_hours or -keep_successful_days parameters to specify a retention period. For example:

bpdbjobs -clean -keep_hours 30
-delete job1,job2,...jobn | type=jobtype | type=all

Deletes the completed jobs that appear in the Activity Monitor. Multiple job IDs can be deleted in one command. For example:

bpdbjobs -delete 11328,11329,11330

This option deletes one of the following:

  • The jobs that job1,job2,...jobn specify

  • All the eligible jobs that jobtype indicates

  • All eligible jobs if type=all is specified

Possible jobtype values are listed in the Description section.

-fast

Retrieves the job metadata from bpjobd, but the try file and files file is read directly from the file system. This option is ignored if bpdbjobs is started from a remote host (a host that is not the master).

-file pathname

Names a file to which the output of bpdbjobs is written. If no -file option is provided, the output goes to stdout.

-gdm

Displays less of the information in a report than -most_columns.

-ignore_parent_jobs

Ignores the parent jobs for the -report and -summary options.

-jobid job1,job2,...jobn | type=jobtype | type=all

Reports on multiple job IDs.

Possible jobtype values are listed in the Description section.

-keep_days days

Used with the -clean option to specify how many days bpdbjobs keeps completed jobs. Default is three (3) days.

-keep_hours hours

Used with the -clean option to specify how many hours bpdbjobs keeps completed jobs. Default is 72 hours.

-keep_successful_days days

Used with the -clean option to specify how many days bpdbjobs keeps successful completed jobs. Default is three (3) days.

This value must be less than the -keep_days value.

-keep_successful_hours hours

Used with the -clean option to specify how many hours bpdbjobs keeps successful completed jobs. Default is 72 hours.

This value must be less than the -keep_hours value.

-L

Reports in long format.

-lvault

Displays the additional columns specific to Vault jobs.

-M master_servers

Applies to an environment with multiple master servers. Use the -M option to summarize jobs, delete jobid(s), cancel jobid(s), and cancel all active job IDs for a specific master server:

-mastertime

By default, bpdbjobs translates the start or the end times to be relative to the local clock. A job that starts 10 minutes ago looks like it starts 10 minutes ago regardless of time zone and clock differences with the master server. This option, however, circumvents that translation so that time values are consistent between admin clients.

-most_columns

Behaves similarly to -all_columns but does not include the file list or any information on previous attempts. The -most_columns option is significantly faster than -all_columns.

Note:

The field values in the -most_columns options are not stable. They can change from release to release. Any information about the fields is subject to change without notice.

-noheader

Prevents the header from being printed in the report.

-quiet

Cancels the reporting of the number of jobs resumed, suspended,deleted, and canceled.

-reason "string"

Indicates the reason why you are performing this command action. The reason text string that you enter is captured and appears in the audit report. The string must be enclosed by double quotes ("...") and cannot exceed 512 characters. It cannot begin with a dash character (-) nor contain a single quotation mark (').

-report

Provides a report of data that is stored in the Activity Monitor. If no option is specified with bpdbjobs, -report is the default option.

-restart job1,job2,...jobn | type=jobtype | type=all

Cleanly restarts a job that jobtype indicates. This option supports backups and enables you to restart a job by typing the word BACkup in the Activity Monitor.

-resume job1,job2,...jobn | type=jobtype | type=all

Resumes the jobs that job1,job2,...jobn specify, all eligible checkpoint backups or restore the jobs that jobtype indicates, or all eligible jobs if type=all is specified.

Possible jobtype values are listed in the Description section.

-set_priority [-M master_servers] -priority number -jobid job1,job2,...jobn

Sets the priority of the specified job or jobs to the specified priority number.

-summary [-U | -L | -all_columns]

Prints a summary line to stdout for all the jobs that are stored in NBU/jobs. Parameters -U and -L format the output of the command. Use the -file option to write the output to a given directory or file name. For example:

bpdbjobs -summary -U -file /tmp/summary.out
-suspend job1,job2,...jobn | type=jobtype | type=all

Suspends the jobs that job1,job2,...jobn specifies or all eligible checkpoint backups or restore the jobs that jobtype indicates, or all eligible jobs if type=all is specified.

Possible jobtype values are listed in the Description section.

-t timestamp

Fetches the job records which have modified after the specified timestamp. The timestamp is specified in the following format:

mm/dd/yyyy hh:mm:ss

The required date and time values format in NetBackup commands varies according to your locale. The /usr/openv/msg/.conf file (UNIX) and the install_path\VERITAS\msg\LC.CONF file (Windows) contain information such as the date-time formats for each supported locale. The files contain specific instructions on how to add or modify the list of supported locales and formats.

For more information about the locale of your system, see "About specifying the locale of the NetBackup installation" in the NetBackup Administrator's Guide, Volume II.

-U

Reports in user format. NetBackup report-generating tools such as the NetBackup-Java Reports application uses this report format.

-vault

Displays the additional columns specific to Vault jobs.

-verbose

Causes bpdbjobs to log additional information in the debug log in the following directory, if the directory exists:

On UNIX systems:

/usr/openv/netbackup/logs/bpdbjobs/*

On Windows systems:

install_path\NetBackup\logs\bpdbjobs\*

-version

Prints the version string, then halts. Any other switches are ignored.