Important Update: Cohesity Products Documentation
All Cohesity product documentation are now managed via the Cohesity Docs Portal: https://docs.cohesity.com/HomePage/Content/home.htm. Some documentation available here may not reflect the latest information or may no longer be accessible.
NetBackup™ Commands Reference Guide
- Introduction
- Appendix A. NetBackup Commands
- acsd
- backupdbtrace
- backuptrace
- bmrc
- bmrconfig
- bmrepadm
- bmrprep
- bmrs
- bmrsrtadm
- bp
- bparchive
- bpbackup
- bpbackupdb
- bpcatarc
- bpcatlist
- bpcatres
- bpcatrm
- bpcd
- bpchangeprimary
- bpcleanrestore
- bpclient
- bpclimagelist
- bpclntcmd
- bpclusterutil
- bpcompatd
- bpconfig
- bpdbjobs
- bpdbm
- bpdgclone
- bpdown
- bpduplicate
- bperror
- bpexpdate
- bpfis
- bpflist
- bpgetconfig
- bpgetdebuglog
- bpimage
- bpimagelist
- bpimmedia
- bpimport
- bpinst
- bpkeyfile
- bpkeyutil
- bplabel
- bplist
- bpmedia
- bpmedialist
- bpminlicense
- bpnbat
- bpnbaz
- bppficorr
- bpplcatdrinfo
- bpplclients
- bppldelete
- bpplinclude
- bpplinfo
- bppllist
- bpplsched
- bpplschedrep
- bpplschedwin
- bppolicynew
- bpps
- bprd
- bprecover
- bprestore
- bpretlevel
- bpschedule
- bpschedulerep
- bpsetconfig
- bpstsinfo
- bpstuadd
- bpstudel
- bpstulist
- bpsturep
- bptestbpcd
- bptestnetconn
- bpup
- bpverify
- cat_convert
- cat_export
- cat_import
- configureCerts
- configureMQ
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig reinitialize
- csconfig throttle
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- mklogdir
- msdpcldutil
- msdpimgutil
- nbauditreport
- nbcallhomeproxyconfig
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcmdrun
- nbcomponentupdate
- nbcplogs
- nbcredkeyutil
- nbdb_admin
- nbdb_backup
- nbdb_move
- nbdb_ping
- nbdb_restore
- nbdb_unload
- nbdb2adutl
- nbdbms_start_server
- nbdbms_start_stop
- nbdc
- nbdecommission
- nbdelete
- nbdeployutil
- nbdevconfig
- nbdevquery
- nbdiscover
- nbdna
- nbemm
- nbemmcmd
- nbepicfile
- nbfindfile
- nbfirescan
- nbfp
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhsmcmd
- nbhypervtool
- nbidpcmd
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmiputil
- nbkmscmd
- nbkmsutil
- nblogparser
- nbmariadb
- nbmysql
- nbmlb
- nborair
- nboracmd
- nbpem
- nbpemreq
- nbmariadb
- nbmlb
- nbperfchk
- nbpgsql
- nbplupgrade
- nbrb
- nbrbutil
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbserviceusercmd
- nbsetconfig
- nbshvault
- nbsmartdiag
- nbsnapimport
- nbsnapreplicate
- nbsqlcmd
- nbsqlite
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- netbackup_deployment_insights
- resilient_clients
- restoretrace
- stopltid
- tiermover
- tldd
- tldcd
- tpautoconf
- tpclean
- tpconfig
- tpext
- tpreq
- tpunmount
- verifytrace
- vltadm
- vltcontainers
- vlteject
- vltinject
- vltoffsitemedia
- vltopmenu
- vltrun
- vmadd
- vmchange
- vmcheckxxx
- vmd
- vmdelete
- vmoprcmd
- vmphyinv
- vmpool
- vmquery
- vmrule
- vmupdate
- vnetd
- vssat
- vwcp_manage
- vxlogcfg
- vxlogmgr
- vxlogview
- W2KOption
Name
bpdbjobs — interact with NetBackup jobs database
SYNOPSIS
[-report] [-M master_servers] [-ignore_parent_jobs] [ -vault | -lvault | -all_columns | -most_columns | -gdm ] [-file pathname] [-append] [-noheader] [-mastertime] [-utc] [-t timestamp] [-jobid job1,job2,...jobn | -dtemode Off|On] [verbose]
-summary [-M master_servers] [-ignore_parent_jobs] [ -U | -L | -all_columns ] [-file pathname] [-append] [verbose]
-resume | -suspend | -delete | -cancel | -restart job1,job2,...jobn | type=jobtype | type=all [-M master_servers] [-quiet] [-reason "string"]
-cancel_all [-M master_servers] [-reason "string"]
-clean [-M master_servers] [ -keep_hours hours | -keep_days days ] [ -keep_successful_hours hours | -keep_successful_days days ] [verbose]
-version
-change_priority_by [-M master_servers] -priority number -jobid job1,job2,...jobn
-set_priority [-M master_servers] -priority number -jobid job1,job2,...jobn
-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 NAS 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.
- -dtemode Off|On
Lists the jobs according to the data-in-transit encryption (DTE) mode that is set: On or Off.
- -fast
Retrieves the job metadata from bpjobd, but the
tryfile andfilesfile 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. See the -utc option for normalizing to UTC instead of the local clock.
- -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/.conffile (UNIX) and theinstall_path\msg\LC.CONFfile (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.
- -utc
Print start and end times in Coordinated Universal Time (UTC) instead of relative to the local clock. Times that this switch translates have +0000 in the time signature to represent UTC. A full example is: 01/01/19 12:00:00+0000. Various reports pass through raw timestamps and they are not subject to translation.
- -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.