Symantec NetBackup ™

Commands

UNIX, Windows, and Linux

Release 7.0

20654095
 Contents

Chapter 1 Introduction ........................................................................... 5

About NetBackup commands ........................................................... 5

Navigating multiple menu levels ....................................................... 6
NetBackup command conventions .................................................... 6
NetBackup Media Manager command notes ........................................ 7

Appendix A NetBackup Commands ........................................................ 9

Index ................................................................................................................... 667
4 Contents
 Chapter 1
Introduction
This chapter includes the following topics:

■ About NetBackup commands

■ Navigating multiple menu levels

■ NetBackup command conventions

■ NetBackup Media Manager command notes

About NetBackup commands

This document contains all of the NetBackup "man page" commands. You can
find a printable version of the command quickly and easily without searching
through multiple books in the NetBackup Library.
This document contains detailed information on commands that run on UNIX
and Linux systems as well as on Windows systems. Information that is pertinent
only for UNIX and Linux systems versus Windows system is noted accordingly.
Each command contains a brief description of the primary function of the
command, a synopsis, and descriptions of each of the options listed in the synopsis.
Some commands also contain notes and usage examples.
Included in this document are the NetBackup Server and NetBackup Enterprise
Server commands. In most cases, a command pertains to both NetBackup products.
However, there are instances where portions or options within a command apply
specifically to one product such as NetBackup Enterprise Server. In these
situations, a note has been inserted in the text to identify the information as
information that only applies to one NetBackup product.
6 Introduction
Navigating multiple menu levels

Navigating multiple menu levels

When navigating multiple menu levels, a greater-than sign (>) is used to indicate
a continued action. The following example shows how the > is used to condense
a series of menu selections into one step:
Start > Programs > Symantec NetBackup > NetBackup Administration Console.
The corresponding actions can be described in more steps as follows:
1 Click Start in the task bar.
2 Move your cursor to Programs.
3 Move your cursor to the right and highlight Symantec NetBackup.
4 Move your cursor to the right. First highlight and then click NetBackup
Administration Console.

NetBackup command conventions

This document uses the following conventions when describing commands that
are specific to NetBackup.
Run the following commands in the "Command Prompt" to see the results.
■ The -help (-h) option prints a command line usage message when it is the
only option on the command line. For example:

bpclient -help

■ Brackets [ ] indicate that the enclosed component of the command line is

optional.
■ Curly braces {} indicate an association between the enclosed options. For
example, {opt1 [opt2 ... optn]} means that if the command contains opt1, then
the command may optionally contain opt2 ... optn.
■ A vertical bar (or the pipe symbol) | separates optional arguments from which
the user can choose. For example, if a command has the following format, you
can choose arg1 or arg2 (but not both):

command [ arg1 | arg2 ]

■ Italics indicate that the information is user supplied. For example, the user
supplies policy, schedule, and filename in the following command:

bpbackup -p policy -s schedule filename

 Introduction 7
NetBackup Media Manager command notes

■ An ellipsis (...) means that you can repeat the previous parameter. For example,
consider the following command:

bpbackup [-S master_server [,master_server,...]] filename

Here, the -S option requires the first master server name. Additional names
can be added, separated by commas and followed by a file name as in:

bpbackup -S mars,coyote,shark,minnow memofile.doc

NetBackup Media Manager command notes

In addition, Media Manager supports the following sets of commands that are
used for device management; the NetBackup Device Manager service (ltid) starts
or stops these commands as needed.
■ tpreq and tpunmount are user commands for requesting tape mounts and
unmounts for configured drives.
■ tpautoconf, tpclean, tpconfig, and vmoprcmd are administrative commands
for device management.
■ vmadd, vmchange, vmcheckxxx, vmdelete, vmpool, vmquery, vmrule, and
vmupdate are administrative commands for media management.
8 Introduction
NetBackup Media Manager command notes
 Appendix A
NetBackup Commands
10 NetBackup Commands
acsd

acsd
acsd – Automated Cartridge System (ACS) daemon (UNIX) or process (Windows)

SYNOPSIS
<volmgr_dir_path>acsd [-v]
On UNIX and Linux systems, <volmgr_dir_path> is /usr/openv/volmgr/bin/
On Windows systems, <volmgr_dir_path> is <install_path>\Volmgr\bin\

DESCRIPTION
acsd interfaces with Media Manager to mount and unmount tapes automatically
that are under Automated Cartridge System (ACS) control. If the Media and Device
Management of the Administration Console shows drives in an ACS robot, the
ltid NetBackup Device Manager daemon or service (Windows) runs acsd. Stopping
ltid stops acsd.

On UNIX and Linux systems, start or stop acsd independently of ltid by using
/usr/openv/volmgr/bin/vmps or your server’s ps command to identify the acsd
process ID. Then enter the following commands:

kill acsd_pid
/usr/openv/volmgr/bin/acsd [-v] &

acsd performs its tasks by sending requests to the ACS storage server Interface
process (acsssi). It communicates with the server that controls the ACS.
On Windows systems, acsd performs its tasks by sending requests to the STK
LibAttach service, which communicates with the server that controls the ACS.
When the connection is established, acsd puts the ACS robot in the UP state and
can mount and unmount tapes. If the connection cannot be established or ACS
errors exist, acsd changes the robot to the DOWN state. In this state, acsd still
runs and returns the robot to the UP state when the problem no longer exists.
Use the following to address and define drives in the Media Manager: ACS number,
LSM number, Panel number, and Drive number.
Configure drive cleaning for ACS robots by using ACS library software. You cannot
define the cleaning volumes by using Media Manager. In addition, you cannot use
the tpclean command for cleaning operations on drives under ACS robotic control.
On UNIX and Linux systems, the Internet service port number for acsd must be
in /etc/services. If you use NIS (Network Information Service), place the entry
in this host’s /etc/services file in the master NIS server database for services.
 NetBackup Commands 11
acsd

To override the services file, create the file

/usr/openv/volmgr/database/ports/acsd with a single line that contains the
service port number for acsd. The default service port number is 13702.
On Windows systems, the Internet service port number for acsd must be in
%SystemRoot%\system32\drivers\etc\services. To override the services file,
create the file install_path\Volmgr\database\ports\acsd with a single line
that contains the service port number for acsd. The default service port number
is 13702.

Note: This command applies only to the NetBackup Enterprise Server.

OPTIONS
-v This option is used on UNIX and Linux systems only. It logs debug information
using syslogd. If you start ltid with -v, acsd also starts with -v.

ERRORS
On UNIX and Linux systems, acsd returns an error message if a copy of acsd is
in operation. Media Manager logs ACS and network errors to syslogd. Log entries
are also made when the state changes between UP and DOWN. acsssi logs to a
log file in the /usr/openv/volmgr/debug/acsssi directory.
On Windows systems, Media Manager logs ACS and network errors to the Windows
application event log. Log entries are also made when the state changes between
UP and DOWN.

SEE ALSO
ltid, tpconfig, vmadm
12 NetBackup Commands
add_media_server_on_clients

add_media_server_on_clients
add_media_server_on_clients – add media server on clients

SYNOPSIS
<nbu_dir_path>add_media_server_on_clients
On UNIX and Linux systems, <nbu_dir_path> is /usr/openv/netbackup/bin/
On Windows systems, <nbu_dir_path> is <install_path>\NetBackup\bin\

DESCRIPTION
Run the add_media_server_on_clients command from a NetBackup server to
synchronize the server list from the server’s configuration with the server lists
on the known clients.
The add_media_server_on_clients command tries to connect to all configured
clients (clients that are listed in backup policies).
For each client to which it can connect, add_media_server_on_clients updates
the client’s configuration (if necessary) to include all the servers from the server’s
configuration.
 NetBackup Commands 13
backupdbtrace

backupdbtrace
backupdbtrace – trace debug logs of backupdb (image catalog backup) jobs

SYNOPSIS
<admin_dir_path>backupdbtrace [-server name] [-job_id number]
[-start_time hh:mm:ss] [-end_time hh:mm:ss] mmddyy [mmddyy ...]
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

DESCRIPTION
The backupdbtrace utility consolidates the debug log messages for the specified
backup database jobs and writes them to standard output. It then sorts them by
time. backupdbtrace tries to compensate for time zone changes and the clock
drift between remote servers and clients.
At a minimum, you must enable debug logging for the administrator on the master
server and for bptm and bpbkar on the media server. For best results, set the
verbose logging level to 5. Then enable the debug logging for the following in
addition to the processes already identified:
■ bpdbm on the master server

■ bpcd on all servers

backupdbtrace uses the -job_id option as the sole criterion for selecting the
backupdb job to trace. If -job_id is not used, then backupdbtrace selects all the
backupdb jobs that started on the days that the day stamps (mmddyy) specified.
Use the -start_time and -end_time options to examine the debug logs on the
specified time interval.
backupdbtrace writes error messages to standard error.

OPTIONS
-server
Name of the media server where the backupdb command is initiated. The
default is the local host name.
-job_id
Job ID number of the backupdb job to analyze. Default is any job ID.
14 NetBackup Commands
backupdbtrace

-start_time
Earliest timestamp to start analyzing the logs. Default is 00:00:00.
-end_time
Latest timestamp to finish analyzing the logs. Default is 23:59:59.
mmddyy
One or more day stamps. This option identifies the log file names (log.mmddyy
for UNIX, mmddyy.log for Windows) to analyze.

OUTPUT FORMAT
The following is the format of an output line:
<daystamp>.<millisecs>.<program>.<sequence> <computer> <log_line>
daystamp
The day that the log is generated in yyyymmdd format.
millisecs
The number of milliseconds since midnight on the local computer.
program
The name of the program (for example, BPBKAR) being logged.
sequence
Line number within the debug log file.
computer
The name of the NetBackup server or client.
log_line
The line that appears in the debug log file.

EXAMPLES
EXAMPLE 1
This example analyzes the log of a backupdb job with job ID 5 run on May 6, 2009.

# backupdbtrace -job_id 5 050609

EXAMPLE 2
This example analyzes the log of all the backupdb jobs that were run on August
5, 2009 and August 17, 2009.

# backupdbtrace 080507 081709

 NetBackup Commands 15
backuptrace

backuptrace
backuptrace – consolidate the debug logs for a NetBackup job

SYNOPSIS
<admin_dir_path>backuptrace [-master_server name] [-job_id number]
[-birth_time number] [-policy_name name] [-client_name name]
[-start_time hh:mm:ss] [-end_time hh:mm:ss] mmddyy [mmddyy...]
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

DESCRIPTION
The backuptrace utility consolidates the debug logs for specified NetBackup job
or jobs. The debug log messages relevant to the specified backup jobs are written
to standard output. Then the messages sort by time. The backuptrace utility tries
to compensate for time zone changes and the clock drift between remote servers
and clients. The output is formatted so that you can more easily sort or group by
timestamp, program name, server name, or client name.
At a minimum, you must enable debug logging for the following:
■ nbjm on the master server

■ bpbrm, bptm, and bpdm on the media server

■ bpbkar on the client

For best results, set the verbose logging level to 5 and enable debug logging for
the following in addition to the processes already identified:
■ bpdbm and bprd on the master server

■ bpcd on all servers and clients

Use the backuptrace utility for regular file system, database extension, and
alternate backup method backup jobs.

OPTIONS
-master_server name
Name of the master server. Default is the local host name.
16 NetBackup Commands
backuptrace

-job_id number
Job ID number of the backup job to analyze.
-birth_time number
Birth time (seconds since 1970) of the backup job to analyze.
-policy_name name
Policy name of the jobs to analyze.
-client_name name
Client name of the jobs to analyze.
-start_time hh:mm:ss
Earliest timestamp to start analyzing the logs.
-end_time hh:mm:ss
Latest timestamp to finish analyzing the logs.
mmddyy [mmddyy]
One or more day stamps. This option identifies the log file names (log.mmddyy
for UNIX, mmddyy.log for Windows) to analyze.

NOTES
Media Manager logs are not analyzed.

EXAMPLES
/usr/openv/netbackup/bin/admincmd/backuptrace -job_id 289
041105 > /tmp/job.log.289

C:\Program Files\VERITAS\NetBackup\bin\admincmd\backuptrace
policy weekly_bkups 051205 >/tmp/jobs.weekly_bkups

Use this utility to consolidate logs for all jobs that are started for the policy
weekly_bkups on the specified date. Use the -start_time/-end_time arguments
to limit the window for which the jobs are to be evaluated.
 NetBackup Commands 17
bmrc

bmrc
bmrc – submit requests to the Bare Metal Restore server daemon

SYNOPSIS
<nbu_dir_path>bmrc -operation change -resource { restoretask |
discovertask } [-client clientName] -state numericCode -progress
numericCode
<nbu_dir_path>bmrc -operation complete -resource { restoretask |
discovertask } [-client clientName] -state numericStateCode
<nbu_dir_path>bmrc -operation create -resource log [-client
clientName]
<nbu_dir_path>bmrc -operation create -resource message [-client
clientName] -msg messageText
<nbu_dir_path>bmrc -operation pull -resource { info | procedure }
[-client clientName] -source sourceFileName -destination
destinationFileName
On UNIX and Linux systems, <nbu_dir_path> is /usr/openv/netbackup/bin/
On Windows systems, <nbu_dir_path> is <install_path>\NetBackup\bin\

DESCRIPTION
The bmrc client program runs on a Bare Metal Restore (BMR) client and submits
requests to the BMR server daemon. The operation and resource are specified as
arguments.
When you initiate bmrc from an external procedure in the repair environment on
a restoring client, specify the path to the bmrc command as follows:
On UNIX and Linux systems, /usr/openv/netbackup/bin
On Windows systems, %SystemDrive%\BMR\NBU\bin
At the first boot external procedure point, bmrc is in install_path\NetBackup\bin.

OPTIONS
-client clientName
Name of the Bare Metal Restore client.
On UNIX and Linux systems, -client is optional if CLIENT_NAME is defined in
/usr/openv/netbackup/bp.conf on the client system.
18 NetBackup Commands
bmrc

-destination destinationFileName
On pull operation, the pathname of the file to be created on the local host.
-msg messageText
Text message to be added to the log on the server.
-operation operationName
An operation to perform:

change
complete
create
pull

-progress numericCode
A numeric progress code that is used internally by Bare Metal Restore.
-resource resourceName
A resource on which to perform the operation:

discovertask
info
log
message
procedure
restoretask

-source sourceFileName
On pull operation, name of file to retrieve from database.
-state numericCode
A numeric state code that is used internally by Bare Metal Restore.

EXAMPLES
EXAMPLE 1
Change the status of a discovery task:

# bmrc -operation change -resource discovertask -client clientName

-state numericCode -progress numericCode

EXAMPLE 2
Change the status of a restore task:

# bmrc -operation change -resource restoretask -client clientName

-state numericCode -progress numericCode
 NetBackup Commands 19
bmrc

EXAMPLE 3
Complete a discovery task and set a final status code:

# bmrc -operation complete -resource discovertask -client clientName

-status numericStatus

EXAMPLE 4
Complete a restore task and set a final status code:

# bmrc -operation complete -resource restoretask -client clientName

-status numericStatus

EXAMPLE 5
Create a log on the server from standard input to this command:

# bmrc -operation create -resource log -client clientName

EXAMPLE 6
Create a message, which is added to a log on the server:

# bmrc -operation create -resource message -client clientName -msg

message text

EXAMPLE 7
Pull a file from the server:

# bmrc -operation pull -resource info -client clientName -source

sourceFileName -destination destinationFileName

EXAMPLE 8
Pull an external procedure from the server:

# bmrc -operation pull -resource procedure -client clientName

-source sourceFileName -destination destinationFileName

NOTES
If you use NetBackup Access Management and the user credentials and computer
credentials are expired, renew them before you perform prepare-to-restore
operations. Use the bpnbat command and -Login option to renew your user
credentials. Use the bpnbat command and -LoginMachine option to renew the
computer credentials.
Specifying -? displays the command’s usage statement when it is the only option
on the command line.
20 NetBackup Commands
bmrconfig

bmrconfig
bmrconfig – change configuration settings

SYNOPSIS
<nbu_dir_path>bmrconfig [-resource resourceType [-platform win | hp
| aix | solaris | linux] [-manager ldm | lvm | native | sfw | svm |
vxvm] [-operation add | change | clearly | delete | display | list
| map]]
<nbu_dir_path>bmrconfig -operation verify -client clientName
-configuration configName
<nbu_dir_path>bmrconfig -operation initialize -resource disk | network
| all -client clientName -configuration configName
-sourceconfiguration source_configName
<nbu_dir_path>bmrconfig -operation initialize -resource disk | network
| all -client clientName -configuration configName -sourceclient
source_clientName -sourceconfiguration source_configName
<nbu_dir_path>bmrconfig -operation add | change | clearly | delete
| display | list | map -resource resourceType [-name resourceName]
[-manager ldm | lvm | native | sfw | svm | vxvm] -client clientName
-configuration configName [-attributes "key=value" ["key=value" ...]]
On UNIX and Linux systems, <nbu_dir_path> is /usr/openv/netbackup/bin/
On Windows systems, <nbu_dir_path> is <install_path>\NetBackup\bin\

DESCRIPTION
The bmrconfig command changes a configuration’s system, network, volume,
driver, and NetBackup settings. The read-only current configuration and discovered
configuration cannot be changed. Use the bmrs command to create a copy of a
configuration that you can change.

OPTIONS
-attributes
Attributes of the resource are specified as name-value pairs. The name is
always an alphanumeric string. The value is free form but must be double
quoted. To determine the specific set of attributes that apply to a resource,
use bmrconfig -operation list -resource resourceType.
 NetBackup Commands 21
bmrconfig

-client clientName
The NetBackup client name.
-configuration configName
The configuration to operate on.
-force
Forces the removal of a resource and all of its dependent resources.
-manager
The volume manager that controls the resource. Volume managers are as
follows:
ldm - Windows Logical Disk Manager

lvm - AIX or HP-UX Logical Volume Manager

native - the volume manager native to the operating system

sfw - Veritas Storage Foundation for Windows

svm - Solaris Volume Manager

vxvm - Veritas Volume Manager

-name resourceName
The name of the resource to act on. The various volume managers determine
the valid characters in a resource name.
-operation operation_name
The operation to perform. Operations are as follows:
add - adds a resource to the configuration

change - changes specific attributes of a resource

clearly - removes all resources except disks from a disk group

delete - removes a resource from the configuration

display - prints high-level information about the resource

help - prints all the resources that are required and optional attributes and
values
initialize - initializes a configuration’s hardware from a discovered
configuration
list - prints all the instances of the specified resource type

map - maps a resource that includes dependent resources, from the original
configuration to the working configuration
22 NetBackup Commands
bmrconfig

verify - checks that a config has sufficient data for a restore to succeed

-resource resourceType
The type of the resource on which the operation is performed. Resource types
are as follows:
all - all resources

accesspath - a Windows access path

disk - a physical storage device

diskgroup - a logical grouping of disks

diskset - a Solaris Volume Manager disk set

driveletter - a Windows drive letter

esm - backup client identity

filesystem - a file system for UNIX, Linux, and Windows

gateway - a network gateway

host - a network server

hotfix - a Windows hotfix

hotsparepool - a set of the slices that are used for SVM failover

ip - network identity

license - a product license key

logicaldrive - a Windows extended partition; first one implicitly adds

container
logicalvolume - an AIX or HP-UX logical volume

metadb - an SVM database replica slice

mountpoint - a path that serves as an access point to a volume

msd - a mass storage driver

multidevice - a Linux multidevice

nativedisk - Solaris Native disk resource

nativepart - Solaris Native partition resource

network - a sub network

nic - a network interface card

nicpkg - a network interface card driver

 NetBackup Commands 23
bmrconfig

partition - Windows primary partition

physical volume - an AIX or HP-UX physical volume

slice - a Solaris slice; equivalent to volume

softpart - an SVM soft partition

volume - a logical division of a disk or a disk group

volumegroup - an AIX or HP-UX volume group

-sourceconfiguration source_configName
The configuration that is the source in an initialized configuration operation.
-sourceclient source_clientName
The client that serves as the source in an initialized configuration operation.
If a source client is not specified, the configuration comes from the list of
discovered configurations.

EXAMPLES
EXAMPLE 1
List the physical volumes in a configuration for client aixp31:

# bmrconfig -operation list -resource physical volume -configuration

current -client aixp31

EXAMPLE 2
Map Native partitions on Solaris:

# bmrconfig -op map -re nativepart -name /dev/dsk/c1t0d0p1 -client

client1 -config config1 -attributes disk=/dev/dsk/c1t1d0p0
percent=50 partid=191 active=true

EXAMPLE 3
List the volume groups in a configuration for client aixp31:

# bmrconfig -operation list -resource volume group -configuration

current -client aixp31

EXAMPLE 4
Display the attributes of a volume group for client aixp31:

# bmrconfig -operation display -resource volume group -configuration

current -client aixp31 -name rootvg
24 NetBackup Commands
bmrconfig

EXAMPLE 5
Initialize the new configuration with the discovered hardware for client aixp31:

# bmrconfig -operation initialize -resource config -configuration

mynew -client aixp31 -sourceconfiguration discover

EXAMPLE 6
Add a volume group to a configuration for client aixp31:

# bmrconfig -operation add -configuration mynew -client aixp31

-resource volume group -name rootvg -attributes physical
volume=hdisk1

EXAMPLE 7
Add a disk to a volume group for client aixp31 (requires a full list of physical
volumes to be specified):

# bmrconfig -operation modify -configuration my new -client aixp31

-resource volume group -name rootvg -attributes physical
volume=hdisk1 physical volume=hdisk0

EXAMPLE 8
Remove a physical volume from a volume group for client aixp31:

# bmrconfig -operation modify -configuration my new -client aixp31

-resource volume group -name rootvg -attributes physical
volume=hdisk0

EXAMPLE 9
Map a volume group from the original configuration for client aixp31:

# bmrconfig -operation map -configuration my new -client aixp31

-resource volume group -name rootvg

NOTES
If you use NetBackup Access Management, and the user credentials and computer
credentials expire, renew them before you perform prepare-to-restore operations.
Use the bpnbat command and -Login option to renew your user credentials. Use
the bpnbat command and -LoginMachine option to renew the computer
credentials.
Specifying -? displays a synopsis of command usage when it is the only option
on the command line.
 NetBackup Commands 25
bmrconfig

SEE ALSO
bmrs
26 NetBackup Commands
bmrepadm

bmrepadm
bmrepadm – manage external procedures

SYNOPSIS
<nbu_dir_path>bmrepadm [-data] -list [pattern]
<nbu_dir_path>bmrepadm [-data] -delete procedureName
<nbu_dir_path>bmrepadm [-data] -extract procedureName
<nbu_dir_path>bmrepadm [-data] -add fileName
On UNIX and Linux systems, <nbu_dir_path> is /usr/openv/netbackup/bin/
On Windows systems, <nbu_dir_path> is <install_path>\NetBackup\bin\

DESCRIPTION
The bmrepadm command lists, adds, extracts, or deletes external procedures from
the database. The bmrepadm command is installed and run on the NetBackup
master server that is licensed for BMR.
A procedure name (procedure Name) must be in the form type.os or name_type.
type is one of the following strings:
■ prediscover
■ preformat
■ prerestore
■ postrestore
■ firstboot
os is one of following strings:
■ aix
■ hp
■ linux
■ Sol
■ win
name is the name of a Bare Metal Restore client.
 NetBackup Commands 27
bmrepadm

OPTIONS
-add pathName
Adds the external procedure in pathName to the database. The last component
of pathName must be a valid external procedure Name.
-data
Manipulates an arbitrary user-supplied data file instead of an external
procedure. This option also relaxes all of the naming convention rules for
procedure and file name argument values. The names of data files can be
anything except a valid external procedure name.
-delete procedure Name
Deletes the procedure Name external procedure from the database. The
procedure Name must be a valid external procedure name.
-extract procedure Name
Extracts an external procedure from the database and writes it to the current
directory. The procedure name must be a valid external procedure Name.
-list [pattern]
Lists the entries (external procedures or user-supplied data files) in the
database. Only the entries that match the pattern are listed; if no pattern is
specified, all entries in the database are listed. The "*" character may be used
in the pattern to match any sequence of characters.

NOTES
bmrepadm does not validate client names. That is, you can add an external procedure
for a nonexistent client).
If you use NetBackup Access Management and if your user credentials and the
computer credentials expire, renew them before you perform prepare-to-restore
operations. Use the bpnbat command and -Login option to renew your user
credentials. Use the bpnbat command and -LoginMachine option to renew the
computer credentials.
Specifying -? displays a synopsis of command usage when it is the only option
on the command line.

EXAMPLES
EXAMPLE 1
Add a data file:

# bmrepadm -data -add nameNotMatchingEPname

28 NetBackup Commands
bmrepadm

EXAMPLE 2
List the data files:

# bmrepadm -data -list

EXAMPLE 3
Add an external procedure that runs for all Solaris clients after the NetBackup
restore phase of restoration:

bmrepadm -add <pathname>postrestore.sol

EXAMPLE 4
Add an external procedure that runs before the disks are formatted on a client
that is named zanzibar:

bmrepadm -add <pathname>zanzibar_preformat

 NetBackup Commands 29
bmrprep

bmrprep
bmrprep – prepare a client for restore or discovery

SYNOPSIS
<nbu_dir_path>bmrprep -restore -client clientName -config
configurationName -srt srtName [-policy policyName] [-logging]
[-runep] [-systemonly] [-import] [-enddate enddate] [-quickformat]
<nbu_dir_path>bmrprep -discover -newconfig configurationName -srt
srtName [-client clientName -config configurationName] -address
clientAddress -default defaultGateway -netmask netmask -mac
clientMacAddress -server nbuServerAddress -console consoleDeviceName
-architecture architectureName [-gateway serverGateway] [-logging]
[-runep]
On UNIX and Linux systems, <nbu_dir_path> is /usr/openv/netbackup/bin/
On Windows systems, <nbu_dir_path> is <install_path>\NetBackup\bin\

DESCRIPTION
The bmrprep command prepares a Bare Metal Restore client for a restore or for
a hardware discovery process. This command only runs on the Bare Metal Restore
master server.

OPTIONS
-address clientAddress
(UNIX and Linux clients only.) IP address of the client, in dotted decimal
notation. Required only for a -discover operation; optional if -client and
-config options are specified.

-architecture architectureName
(UNIX and Linux clients only.) Architecture of the client to be discovered.
Required only for a -discover operation; optional if -client and -config
options are specified.
-client clientName
Name of the client to restore.
-config configurationName
Name of the configuration to use.
30 NetBackup Commands
bmrprep

-console consoleDeviceName
(UNIX and Linux clients only.) Name of the console device to use during
discovery. Required only for a -discover operation; optional if you specify
the -client and -config options or use media boot.
-default defaultGateway
(UNIX and Linux clients only.) Default gateway address, in dotted decimal
notation. Required only for a -discover operation; optional if you specify
the -client and -config options or use media boot.
-discover
(UNIX and Linux clients only.) Perform a hardware discovery. Cannot be used
with -restore.
-enddate enddate
Date for point-in-time restores.
The required date and time values format in NetBackup commands varies
according to your locale. The /user/openv/msg/.conf file (UNIX and Linux)
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.
More information is available about the locale of your system.
See the "Specifying the locale of the NetBackup installation" topic in the
NetBackup Administrator's Guide, Volume II.
-gateway serverGateway
(UNIX and Linux clients only.) Gateway to a NetBackup server, in dotted
decimal notation. Required only for a -discover operation.
-import
Import non-system volume groups.
For more information about how to use this flag, see "Prepare to Restore
Client dialog box " in the Bare Metal Restore Administrator’s Guide.
-logging
Enable logging.
-mac clientMacAddress
(UNIX and Linux clients only.) MAC address of the client. Required only for
a -discover operation. (Exception: Optional if the IP address is configured
during initial program load (IPL)); optional if you specify the -client and
-config options or use media boot.
 NetBackup Commands 31
bmrprep

-netmask netmask
(UNIX and Linux clients only.) Netmask of the client, in dotted decimal
notation. Required only for a -discover operation; optional if -client and
-config options are specified.

-newconfig configurationName
(UNIX and Linux clients only.) Name to be given to the discovered
configuration.
-policy policyName
Name of the policy to be used.
-quickformat
(Windows clients only.) Quickly formats Windows partitions.
-restore
Performs a normal restore. Cannot be used with -discover.
-runep
Runs external procedures.
-server nbuServerAddress
(UNIX and Linux clients only.) A NetBackup server address, in dotted decimal
notation. Required only for a -discover operation; optional if -client and
-config options are specified.

-srt srtName
Name of the shared resource tree to use.
-systemonly
Restores system volume groups only.
For more information about how to use this option, see "Prepare to Restore
Client dialog box " in the Bare Metal Restore Administrator’s Guide.

NOTES
If you use NetBackup Access Management and your user credentials and the
machine credentials expire, to renew them before you perform prepare-to-restore
operations. Use the bpnbat command and -Login option to renew your user
credentials. Use the bpnbat command and -LoginMachine option to renew the
machine credentials.
You can specify -? to display a synopsis of command usage when it is the only
option on the command line.
32 NetBackup Commands
bmrprep

SEE ALSO
bpnbat
 NetBackup Commands 33
bmrs

bmrs
bmrs – manage resources in the Bare Metal Restore database

SYNOPSIS
<nbu_dir_path>bmrs -operation delete -resource config -name configName
-client clientName -resource client -name clientName -resource package
-name packageName -resource srt -name srtName -resource
discovertasklog -id idvalue -resource restoretasklog -id idvalue
<nbu_dir_path>bmrs -operation complete -resource discovertask -client
clientName -status numericStatus -resource restoretask -client
clientName -status numericStatus
<nbu_dir_path>bmrs -operation verify -resource srt -name srtName
[-client clientName]
<nbu_dir_path>bmrs -operation copy -resource config -name configName
-client clientName -destination newConfigName
<nbu_dir_path>bmrs -operation retrieve -resource config -client
clientName -destination newConfigName [-enddate date] [-epochenddate
eEnddate] [-policy policyName]
<nbu_dir_path>bmrs -operation import -resource config -path bundlePath
[-client clientName] [-destination newConfigName]
<nbu_dir_path>bmrs -operation list -resource resourceName
On UNIX and Linux systems, <nbu_dir_path> is /usr/openv/netbackup/bin/
On Windows systems, <nbu_dir_path> is <install_path>\NetBackup\bin\

DESCRIPTION
The bmrs command manages resources in the Bare Metal Restore database. The
bmrs command runs only on the master server.

OPTIONS
-client clientName
Name of the Bare Metal Restore client.
-destination newConfigName
Name of the destination configuration to create.
-enddate date
The date for point-in-time restore configurations. If both -enddate and
-epochenddate are specified, -epochenddate takes precedence.
34 NetBackup Commands
bmrs

The required date and time values format in NetBackup commands varies
according to your locale. The /user/openv/msg/.conf file (UNIX and Linux)
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.
More information is available about the locale of your system.
See the "Specifying the locale of the NetBackup installation" topic in the
NetBackup Administrator's Guide, Volume II.
-epochenddate eEnddate
The date for the point-in-time restore configurations. This date is specified
in the number of seconds since January 1, 1970. If both -enddate and
-epochenddate are specified, -epochenddate takes precedence.
-id idvalue
Database record ID of the resource to use for this operation. It is either
discoverTaskLogId or restoreTaskLogId.
-name value
Name of the resource to use for this operation: clientName, configName,
packageName, or srtName .
-operation operationName
Possible operations are complete, copy, delete, import, list, retrieve, and
verify.
-path bundlePath
Pathname to a bundle file that the bmrsavecfg command creates.
-policy policyName
Name of the policy to be used.
-resource resourceName
A resource on which to perform the operation. The allowed resources vary
with operation specified. For -operation list, the following resources are
supported:

bootserver
client
config
discovertask
discovertasklog
package
restoretask
 NetBackup Commands 35
bmrs

restoretasklog
srt

-status numericStatus
A numeric completion status code, used internally by Bare Metal Restore.

EXAMPLES
EXAMPLE 1
List the configurations in the BMR database:

bmrs -operation list -resource config

EXAMPLE 2
Copy the current configuration (read-only) and create a new configuration (mynew)
that you can edit for client aixp31:

bmrs -operation copy -resource config -name current -client aixp31

-destination mynew

EXAMPLE 3
Delete configuration mynew for client aixp31:

bmrs -operation delete -resource config -name mynew -client aixp31

EXAMPLE 4
Verify the integrity of shared resource tree aixsrt:

bmrs -operation verify -resource srt -name aixsrt

NOTES
Specifying -? displays a synopsis of command usage when it is the only option
on the command line.
If you use NetBackup Access Management and your user credentials and the
machine credentials expire, renew them before you perform prepare-to-restore
operations. Use the bpnbat command and -Login option to renew your user
credentials. Use the bpnbat command and -LoginMachine option to renew the
machine credentials.

SEE ALSO
bmrc
36 NetBackup Commands
bmrsrtadm

bmrsrtadm
bmrsrtadm – create and manage SRTs and create bootable CD images

SYNOPSIS
<nbu_dir_path>bmrsrtadm
On UNIX and Linux systems, <nbu_dir_path> is /usr/openv/netbackup/bin/
On Windows systems, <nbu_dir_path> is <install_path>\NetBackup\bin\

DESCRIPTION
On UNIX and Linux systems, the bmrsrtadm command interactively manages
shared resource trees.
On Windows systems, the bmrsrtadm command launches the Create Shared
Resource Tree wizard.
Use bmrsrtadm on a BMR boot server (UNIX) or the Create Shared Resource Tree
wizard on a BMR boot server (Windows) to do the following:
■ Create a new shared resource tree.
■ Create a bootable CD image that contains a copy of an existing shared resource
tree.
■ Install additional software into an existing shared resource tree.
■ Copy an existing shared resource tree to a new location.
■ Delete an existing shared resource tree.
■ List available shared resource trees (on UNIX and Linux systems).
■ Enable and disable a shared resource tree for exclusive use (on UNIX and Linux
systems).

NOTES
On UNIX and Linux systems, if you use NetBackup Access Management and your
user credentials and the machine credentials expire, do the following: renew them
before you perform prepare-to-restore operations. Use the bpnbat command and
-Login option to renew your user credentials. Use the bpnbat command and
-LoginMachine option to renew the machine credentials.

Specifying -? displays a synopsis of command usage when it is the only option

on the command line.
 NetBackup Commands 37
bp

bp
bp – start NetBackup menu interface for users

SYNOPSIS
/usr/openv/netbackup/bin/bp [-a | -ra | -b | -r | -rr | -o | -ro |
-s | -rs | -i | -ri | -k | -rk | -rti | -p | -rp | -2 | -r2]
[-verbose]
/usr/openv/netbackup/bin/bp [ -b |-a | -r | -ra] [-verbose]

DESCRIPTION
This command operates only on UNIX and Linux systems.
The bp command starts a menu interface that lets users archive, back up, and
restore files, directories, or raw partitions from their client workstations. You can
run this interface from any character-based terminal (or terminal emulation
window) where you have a termcap or a terminfo definition.
The bp online Help provides detailed operating instructions.

OPTIONS
The startup menu depends on the options that are used with the bp command. If
you run the bp command without specifying an option, the utility starts at the
main menu. To start the utility at a secondary menu, specify one of the following
options:
-a Starts bp in the Archive of Files and Directories menu.
-ra
Starts bp in the Restore Archives menu.
-b Starts bp in the Backup of Files and Directories menu.
-r Starts bp in the Restore Backups menu.
-rr
Starts bp in the Restore Raw Partitions Backups menu.
-o Starts bp in the Backup Oracle DB menu.
-ro
Starts bp in the Restore Oracle DB menu.
-s Starts bp in the Backup Sybase DB menu.
38 NetBackup Commands
bp

-rs
Starts bp in the Restore Sybase DB menu.
-i Starts bp in the Backup Informix DB menu.
-ri
Starts bp in the Restore Informix DB menu. -rtiStarts bp in the Restore True
Image Backups menu.
Note that the following options apply only to the NetBackup Enterprise Server.
-p Starts bp in the Backup SAP DB menu.
-rp
Starts bp in the Restore SAP DB menu.
-2 Starts bp in the Backup DB2 DB menu.
-r2
Starts bp in the Restore DB2 DB menu.
-k Starts bp in the Backup SQL-BackTrack DB menu.
-rk
Starts bp in the Restore SQL-BackTrack DB menu.
-verbose
Provides a verbose response.

FILES
/usr/openv/netbackup/help/bp/*

/usr/openv/netbackup/logs/bp/*

/usr/openv/netbackup/bp.conf

SEE ALSO
bparchive, bpbackup, bprestore
 NetBackup Commands 39
bpadm

bpadm
bpadm – start NetBackup menu interface for administrators

SYNOPSIS
/usr/openv/netbackup/bin/bpadm

DESCRIPTION
This command operates only on UNIX and Linux systems.
The bpadm utility has a menu interface that administrators can use to configure
NetBackup and monitor its operations. bpadm requires superuser privileges.
Administrators can use this interface from any character-based terminal (or
terminal emulation window) where the administrator has a termcap or a terminfo
definition.
See the NetBackup Administrator’s Guide and the bpadm online Help for detailed
operating instructions.

FILES
/usr/openv/netbackup/help/bpadm/*

/usr/openv/netbackup/logs/admin/*

/usr/openv/netbackup/bin/initbprd

/usr/openv/netbackup/bp.conf

SEE ALSO
bprd
40 NetBackup Commands
bparchive

bparchive
bparchive – archive files to the NetBackup server

SYNOPSIS
<nbu_dir_path>bparchive [-p policy] [-s schedule][-L progress_log
[-en]] [-S master_server [,master_server,...]] [-t policy_type] [-w
[hh:mm:ss]] [-k "keyword_phrase"] -f listfile | filenames
On UNIX and Linux systems, <nbu_dir_path> is /usr/openv/netbackup/bin/
On Windows systems, <nbu_dir_path> is <install_path>\NetBackup\bin\

DESCRIPTION
bparchive processes the files that are listed on the command line or in the file
that is specified with the -f listfile option. Any file path that is entered can
be a file name or a directory name. If the list of files includes a directory, bparchive
archives all files and subdirectories of that directory. It starts at the directory
itself.
By default, you return to the system prompt after bparchive is successfully
submitted. The command works in the background and does not return completion
status directly to you. Use the -w option to change bparchive to work in the
foreground and to return completion status after a specified time period.
bparchive writes informative and error messages to a progress-log file if the file
is created. Create the file before you run the bparchive command and specify it
with the -L progress_log option. If bparchive cannot archive any of the requested
files or directories, use the progress log to determine the reason for the failure.
If you create a directory with write access, bparchive creates a debug log file in
this directory to use for troubleshooting.
On Windows systems, <nbu_dir_path> is
<install_path>\NetBackup\logs\bparchive\

On UNIX and Linux systems, the directory is

/usr/openv/netbackup/logs/bparchive/

NetBackup sends mail on the archive completion status to mail_address if USEMAIL

= mail_address . It is entered as follows: non-administrator users specify it on
the $HOME/bp.conf file; administrators specify it in the
/usr/openv/netbackup/bp.conf file. This message is sent when the archive
process is complete.
 NetBackup Commands 41
bparchive

The following restrictions apply to this command:

■ On UNIX and Linux systems: To archive a file with bparchive , you must be
the root or the owner and a member of the primary group (as owner) to delete.
Also, the file must not be read only. Otherwise, NetBackup saves the files but
cannot reset their access time (utime) and does not delete them from the disk.
■ On Windows systems, to archive a file with bparchive , you must have
permission to delete the file and the file must not be read only. Otherwise,
NetBackup saves the files but does not delete them from the disk.
■ On UNIX and Linux systems: If you specify a UNIX file that is a link, bparchive
archives only the link itself, not the file to which it links.
■ bparchive does not archive the "." or ".." directory entries, and does not archive
disk-image backups.

OPTIONS
-p policy
Names the policy to use for the user archive. If it is not specified, the
NetBackup server uses the first policy it finds that includes the client and a
user archive schedule.
-s schedule
Names the schedule to use for the user archive. If it is not specified, the
NetBackup server uses the first user archive schedule it finds in the policy it
currently uses. (See the -p option.)
-S master_server
On UNIX and Linux systems, this option specifies the name of the NetBackup
master server. The default is the first SERVER entry in the
/usr/openv/netbackup/bp.conf file.

On Windows systems, this option specifies the name of the NetBackup master
server. The default is the server designated as current on the Servers tab of
the Specify NetBackup Machines dialog box. To display this dialog box, start
the Backup, Archive, and Restore user interface on the client. Then click
Specify NetBackup Machines on the File menu.
-t policy_type
Specifies one of the following numbers that correspond to the policy type.
The default for Windows clients is 13. For Netware clients the default is 10.
The default for all others is 0:
0 = Standard
42 NetBackup Commands
bparchive

4 = Oracle

6 = Informix-On-BAR

7 = Sybase

10 = NetWare

13 = MS-Windows

14 = OS/2

15 = MS-SQL-Server

16 = MS-Exchange-Server

19 = NDMP

Note that the following policy types apply only to NetBackup Enterprise
Server.
11 = DataTools-SQL-BackTrack

17 = SAP

18 = DB2

20 = FlashBackup

21 = Split-Mirror

22 = AFS

39 = Enterprise-Vault

-L progress_log [-en]
Specifies the name of an existing file in which to write progress information.
On UNIX and Linux systems, the file name must begin with /.
For example: /home/tlc/proglog.
On Windows systems an example is c:\proglog.
The default is not to use a progress log.
Include the -en option to generate a progress log that is in English. The name
of the log contains the string _en. This option is useful to support personnel
in a distributed environment where different locales may create logs of various
languages.
-w [hh:mm:ss]
Causes NetBackup to wait for a completion status from the server before it
returns you to the system prompt.
 NetBackup Commands 43
bparchive

The required date and time values format in NetBackup commands varies
according to your locale. The /user/openv/msg/.conf file (UNIX and Linux)
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.
More information is available about the locale of your system.
See the "Specifying the locale of the NetBackup installation" topic in the
NetBackup Administrator's Guide, Volume II.
You can optionally specify a wait time in hours, minutes, and seconds. The
maximum wait time you can specify is 23:59:59. If the wait time expires before
the archive is complete, the command exits with a timeout status. The archive,
however, still completes on the server.
If you use -w without specifying the wait time or if you specify a value of 0,
NetBackup waits indefinitely for the completion status.
-k keyword_phrase
Specifies a keyword phrase that NetBackup associates with the image created
by this archive operation. You then can restore the image by specifying the
keyword phrase with the -k option on the bprestore command.
The keyword phrase is a textual description of the archive that is a maximum
of 128 characters in length. All printable characters are permitted including
space (" ") and period (".").
Enclose the phrase in double quotes ("...") or single quotes (‘...’).
The default keyword phrase is the null (empty) string.
-f listfile
Specifies a file (listfile) that contains a list of files to be archived and can be
used instead of the filenames option. In listfile, place each file path on a
separate line.
The required file list format depends on whether the files have spaces,
newlines, or returns in the names.
To archive the files that do not have spaces or newlines or returns in the
names, use th following format:

filepath

The path to the file you want to archive. Some examples on UNIX and Linux
systems are:/home, /etc, and /var. Some examples on Windows systems
are: c:\Programs and c:\documents\old_memos
44 NetBackup Commands
bparchive

To archive the files that have spaces or newlines or returns in the names, use
this format:

filepathlen filepath

filepath is the path to the file you want to archive and filepathlen is the number
of characters in the file path.
The path to the file you want to archive. Some examples on UNIX and Linux
systems are:/home, /etc, and /var. Some examples on Windows systems are:
c:\Programs and c:\documents\old_memos

Examples on UNIX and Linux systems are the following:

5 /home

4 /etc

4 /var

19 /home/abc/test file

Examples on Windows systems are the following:

11 c:\Programs

8 c:\winnt

22 c:\documents\old memos

filenames
Names one or more files to be archived and can be used instead of the -f
option. Any files that you specify must be listed at the end, after all other
options.

EXAMPLES
EXAMPLE 1
Archive a single file:
UNIX and Linux systems: bparchive /usr/user1/file1
Windows systems: bparchive c:\usr\user1\file1
EXAMPLE 2
Archive the files that are listed in a file that is named archive_list:
 NetBackup Commands 45
bparchive

bparchive -f archive_list

EXAMPLE 3
Associate keyword phrase "Archive My Home Directory 02/02/07" to the archive
of a directory named kwc and use a progress log that is named arch.log:
UNIX and Linux systems: bparchive -k "Archive My Home Directory 02/02/07"
\-L /home/kwc/arch.log /home/kwc

Windows systems: bparchive -k "Archive My Home Directory 02/02/07"

\-L c:\home\kwc c:\home\kwc\arch.log
46 NetBackup Commands
bpbackup

bpbackup
bpbackup – back up files to the NetBackup server

SYNOPSIS
<nbu_dir_path>bpbackup -f listfile | filenames [-p policy] [-s
schedule][-S master_server...] [-t policy_type] [-L progress_log
[-en]] [-w [hh:mm:ss]] [-k "keyword_phrase"]
<nbu_dir_path>bpbackup -i [-p policy] [-h hostname] [-s schedule]
[-S master_server...] [-t policy_type] [-L progress_log [-en]] [-w
[hh:mm:ss]] [-k "keyword_phrase"]
<nbu_dir_path>bpbackup -dssu DSSUname [-S master_server] [-w
[hh:mm:ss]]
On UNIX and Linux systems, <nbu_dir_path> is /usr/openv/netbackup/bin/
On Windows systems, <nbu_dir_path> is <install_path>\NetBackup\bin\

DESCRIPTION
The bpbackup command can start a process on clients and master servers.
On clients:
The -f option of bpbackup starts a user backup equivalent to what is performed
by using the interface on the client. This type of backup can be started from any
NetBackup client to back up files from that client.
bpbackup processes the files that you list on the command line or in the file that
you specify with the -f listfile option. A file path can be a file name or a
directory name. If the named files include a directory, bpbackup backs up all files
and subdirectories of that directory; it starts at the directory itself.

Note: In addition to listing individual files or directories, bpbackup can also use
directives to indicate the files to be backed up. For example: bpbackup "/Shadow
Copy Components/" or bpbackup "/System State/". Clients can enter the
directive in the listfile using the bpbackup -f <listfile> option.

On master servers:
The -i option of bpbackup starts an immediate manual backup of a client. The
bpbackup option is available only to the administrator on the master server. It is
equivalent to when you start a manual backup from the NetBackup Administration
Console. Use the -h option to specify the host.
 NetBackup Commands 47
bpbackup

Because progress logs are written only on clients and this form of bpbackup is run
from the master server only, the -L option is undefined.
The following restrictions apply to this command:
■ You must be the owner of the file or an administrator to back up a file with
bpbackup.

■ You can back up files and the directories that other users own if you have the
necessary permissions.
■ On UNIX and Linux systems: If you specify a file that is a link, bpbackup backs
up only the link itself, not the file to which it links.
■ bpbackup does not back up the "." or ".." directory entries.

By default, you return to the system prompt after bpbackup is successfully

submitted. The command works in the background and does not return completion
status directly to you. The -w option lets you change this behavior so the command
works in the foreground. It returns completion status after a specified time period.
If you create the file before you run the bpbackup command and then specify the
file with the -L progress_log option, the following occurs: bpbackup writes
informative and error messages to a progress-log file. If bpbackup cannot back
up the requested files or directories, use the progress log to determine the reason
for the failure.

Note: The - L option is not supported for NDMP clients.

If you create the following directory with public-write access, bpbackup creates
a debug log file in the directory that you can use for troubleshooting:

On Windows systems: install_path\NetBackup\logs\bpbackup\

On UNIX and Linux systems: usr/openv/netbackup/logs/bpbackup/

NetBackup sends mail on the backup completion status when the backup process
is complete to mail_address when users specify the following:
■ A nonroot user specifies USEMAIL = mail_address in the $HOME/bp.conf file
■ A root user specifies USEMAIL = mail_address in the
/usr/openv/netbackup/bp.conf file

OPTIONS
-p policy
Names the policy to use for the backup.
48 NetBackup Commands
bpbackup

If this option is not specified, NetBackup uses the first policy it finds that
includes the client and a user backup schedule.
The -p option is required for an immediate-manual backup (-i option).
-i
Starts an immediate-manual backup. It is equivalent to when you start a
manual backup from the NetBackup administrator interface. You must be
the administrator on the master server to use the -i option.
-dssu DSSUname
NetBackup immediately runs the schedule that is associated with the disk
staging storage unit. The -i option is the implied behavior and is not
necessary.
-h hostname
Names the client host on which to run the backup. If it is not specified,
NetBackup runs the backup on all clients in the policy.
-s schedule
Names the schedule to use for the backup. If it is not specified, the NetBackup
server uses the first user backup schedule it finds for the client in the policy
currently in use.
See the -p option.
-S master_server [,master_server,...]
On UNIX and Linux systems, -S specifies the name(s) of the NetBackup master
server(s). The default is the first SERVER entry that is found in the
/usr/openv/netbackup/bp.conf file.

On Windows systems, -S specifies the name(s) of the NetBackup master

server(s). The default is the server designated as current on the Servers tab
of the Specify NetBackup Machines dialog box. To display this dialog box,
start the Backup, Archive, and Restore user interface on the client. Then click
Specify NetBackup Machines on the File menu.
-t policy_type
Specifies one of the following numbers that correspond to the policy type.
The default for Windows clients is 13, for Netware clients the default is 10,
and the default for all others is 0:
0 = Standard

4 = Oracle

6 = Informix-On-BAR

7 = Sybase
 NetBackup Commands 49
bpbackup

8 = MS-SharePoint

10 = NetWare

13 = MS-Windows

14 = OS/2

15 = MS-SQL-Server

16 = MS-Exchange-Server

19 = NDMP

Note that the following policy types apply only to the NetBackup Enterprise
Server.
11 = DataTools-SQL-BackTrack

17 = SAP

18 = DB2

20 = FlashBackup

21 = Split-Mirror

22 = AFS

39 = Enterprise-Vault

-L progress_log [-en]
Specifies the name of a file in which to write progress information. NetBackup
creates the file if it does not exist.
On Windows systems, for example: c:\proglog
On UNIX and Linux systems, for example: /home/tlc/proglog
The default is not to use a progress log.
The - L option is not supported for NDMP clients.
Include the -en option to generate a progress log that is in English. The name
of the log contains the string _en. This option is useful to support personnel
in a distributed environment where different locales may create logs of various
languages.
-w [hh:mm:ss]
Causes NetBackup to wait for a completion status from the server before it
returns you to the system prompt.
The required date and time values format in NetBackup commands varies
according to your locale. The /user/openv/msg/.conf file (UNIX and Linux)
50 NetBackup Commands
bpbackup

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.
More information is available about the locale of your system.
See the "Specifying the locale of the NetBackup installation" topic in the
NetBackup Administrator's Guide, Volume II.
You can optionally specify a wait time in hours, minutes, and seconds. The
maximum wait time you can specify is 23:59:59. If the wait time expires before
the backup is complete, the command exits with a timeout status. The backup,
however, still completes on the server.
The bpbackup -w option causes the shell to wait for a return code. The
operating system shell can only return one return code. Therefore, if you use
-w without specifying a wait time or you specify a value of 0, NetBackup waits
indefinitely for the completion status.
You can start a manual or an administrative backup using bpbackup -i along
with the -w function. This type of backup has the potential to start multiple
jobs because it is based on policy attributes. If the manual backup starts
multiple jobs, the -w function still only returns one return code to the shell.
If you use -i with -w and more than one job begins, NetBackup waits until all
jobs complete before it returns a completion status. However, because
NetBackup only returns one status code to the shell, the job ID that the status
code belongs to is unknown.
If multiple jobs are due to multiple clients and Allow Multiple Data Streams
is not selected, use -h to restrict the operation to one client. However, if Allow
Multiple Data Streams is selected in the policy and the selected client has
multiple jobs, the returned status code is again unknown.
-k keyword_phrase
Specifies a keyword phrase that NetBackup associates with the image that
this backup operation creates. You then can restore the image by specifying
the keyword phrase with the -k option on the bprestore command.
If you use the -i option with -k, NetBackup establishes an association between
the keyword phrase and the backup policy and image.
The keyword phrase is a textual description of the backup that is a maximum
of 128 characters in length.
On UNIX and Linux systems, all printable characters are permitted including
space (" ") and period ("."). Enclose the phrase in double quotes ("...") or single
quotes ( ‘...’) to avoid conflict with the UNIX shell.
 NetBackup Commands 51
bpbackup

On Windows systems, all printable characters are permitted including space

(" ") and period ("."). Enclose the phrase in double quotes ("...") or single quotes
( ‘...’).
The default keyword phrase is the null (empty) string.
-f listfile
Specifies a file (listfile) that contains a list of files to back up. You can use this
option instead of the filenames option, but you cannot use it with the -i
option. List each file on a separate line.
The format that is required for the file list depends on whether the files have
spaces, newlines, or returns in the names.
To back up the files that do not have spaces, newlines, or returns in the names,
use the following format:

filepath

Where filepath is the path to the file you want to back up.
On UNIX and Linux systems, examples are /home, /etc, and /var.
On Windows systems, examples are c:\Programs, c:\winnt, and
c:\documents\old_memos

To back up the files that have spaces, newlines, or returns in the names, use
the following format:

filepathlen filepath

Where filepath is the path to the file you want to back up and filepathlen is
the number of characters in the file path.
Examples on UNIX and Linux systems are the following:

5 /home
4 /etc
4 /var
19 /home/abc/test file

Examples on Windows systems are the following:

11 c:\Programs
8 c:\winnt
22 c:\documents\old memos
52 NetBackup Commands
bpbackup

filenames
Names one or more files to back up. You can use this option instead of the -f
option, but you cannot use it with the -i option. You must list any files that
you specify at the end, following all other options.

EXAMPLES
EXAMPLE 1
Performs a user backup of a single file, enter:
On UNIX and Linux systems: bpbackup /usr/user1/file1
On Windows systems: bpbackup c:\users\user1\file1
EXAMPLE 2
The following command starts a user backup of the files that are listed in a file
that is named backup_list:

bpbackup -f backup_list

bpbackup -f backup_list

bpbackup -f backup_list

bpbackup -f backup_list

EXAMPLE 3
The following command (all on one line) starts an immediate-manual backup of
the client host named diablo, in the policy named cis_co. The policy type is
Standard policy and is in the configuration on the master server named hoss.
UNIX and Linux: bpbackup -p cis_co -i -h diablo -S hoss -t 0
Windows: bpbackup -p cis_co -i -h diablo -S hoss -t 0
EXAMPLE 4
On Windows systems: The following command associates the keyword phrase
"Backup My Home Directory 01/01/01" to the user backup of the directory
C:\home\kwc. (Enter the command on one line.) The progress log is as follows:

bpbackup -k "Backup My Home Directory 01/01/01" -L

c:\home\kwc\bkup.log C:\home\kwc

On UNIX and Linux systems: The following command associates the keyword
phrase "Backup My Home Directory 01/01/01" to the user backup of the directory
 NetBackup Commands 53
bpbackup

/home/kwc. (Enter the command on one line or use the backslash continuation
character.) The progress log is as follows:

bpbackup -k \

"Backup My Home Directory 01/01/01" -L /home/kwc/bkup.log

/home/kwc

EXAMPLE 5
The following command associates the keyword phrase "Policy Win 01/01/01" to
the immediate-manual backup of the client host named slater in the policy named
win_nt_policy. (Enter the command all on one line.)
UNIX and Linux: bpbackup -k "Policy Win 01/01/01" -i -h slater \-p
win_nt_policy -t 13

Windows: bpbackup -k "Policy Win 01/01/01" -i -h slater -p

win_nt_policy -t 13

FILES
UNIX and Linux systems: $HOME/bp.conf

/usr/openv/netbackup/logs/bpbackup/log.mmddyy

Windows systems: <install_path>\NetBackup\logs\bpbackup\*.log

SEE ALSO
bp(UNIX and Linux systems), bparchive, bplist, bprestore
54 NetBackup Commands
bpbackupdb

bpbackupdb
bpbackupdb – initiate a hot catalog backup

SYNOPSIS
<admin_dir_path>bpbackupdb -p policy_name -s sched_label
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

DESCRIPTION
bpbackupdb initiates a hot catalog backup using the specified policy and schedule.

The NetBackup Administrator’s Guide provides additional information on how to

back up NetBackup catalogs. The NetBackup utility bprecover recovers the catalogs
that bpbackupdb has backed up.
The NetBackup Troubleshooting Guide provides information on how to restore
the NetBackup catalogs if a disaster recovery is required.

OPTIONS
-p policy_name -s sched_label
The -p and -s options launch a policy-based, hot catalog backup.
 NetBackup Commands 55
bpcatarc

bpcatarc
bpcatarc – back up the NetBackup catalog

SYNOPSIS
<admin_dir_path>bpcatarc [-version] [-remove_dotf]
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

DESCRIPTION
bpcatarc processes the output of bpcatlist to back up the selected catalog image
.f files and update their image file’s catarc field with this backup job ID.

OPTIONS
-version
Displays the bpcatarc version and exit.
-remove_dotf
Removes the .f files for an archived image immediately so that you do not
need to run bpcatrm.

SEE ALSO
bpcatlist, bpcatres, bpcatrm
56 NetBackup Commands
bpcatlist

bpcatlist
bpcatlist – list selected parts of NetBackup catalog

SYNOPSIS
<admin_dir_path>bpcatlist [-server server_name] [-client client_name]
[-since [ctime | [-since-days nnn | -since-weeks nnn | -since-months
nnn | -before-days nnn | -before-weeks nnn | -before-months nnn]]
[-before [ctime | [-since-days nnn | -since-weeks nnn | -since-months
nnn | -before-days nnn | -before-weeks nnn | -before-months nnn]]
[-date ctime] [-policy policy_name] [-sched sched_name] [-id
backup_id] [-catarc catarc_id] [-version] [-online | -offline]
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

DESCRIPTION
bpcatlist is the starting point for all catalog archiving operations. Use bpcatlist
to select the specific parts of the NetBackup catalog with which you want to work.
All files-file (image .f files), the largest files in a NetBackup catalog, that are
selected for bpcatarc, bpcatres, or bpcatrm, are first selected with bpcatlist.
The output of bpcatlist is piped to the action you want to perform.

OPTIONS
-server server_name
Indicates the name of the NetBackup server. Default: server_name is the first
server name listed in the bp.conf file.
-client client_name
Creates a list of backup images for client_name. Default: client_name is
CLIENT_NAME in bp.conf or the current host name.
To select all clients, use -client all.
-since [ctime | [-since-days nnn | -since-weeks nnn | -since-months
nnn | -before-days nnn | -before-weeks nnn | -before-months nnn]]
Lists backup images since the specified time that is expressed in ctime (for
example, Fri Oct 12 00:00:00 2009).
 NetBackup Commands 57
bpcatlist

If no year is specified, bpcatlist uses the current year by default.

The following command lists all images after December 31, 2009:

bpcatlist -since 2009

Additional examples are found in the Examples section.

-before [ctime | [-since-days nnn | -since-weeks nnn | -since-months
nnn | -before-days nnn | -before-weeks nnn | -before-months nnn]]
Lists backup images before the specified time that is expressed in ctime (for
example, Fri Oct 12 00:00:00 2009). If no year is specified, bpcatlist uses
the current year by default.
-date ctime
Lists of backup images for the specified date that is expressed in ctime (for
example, Fri Oct 12 00:00:00 2009). If no date is specified, bpcatlist uses
the current date by default.
Additional examples are found in the Examples section.
-catarc catarc_id
Lists the files-file that were archived with the specified catarc_id. For example:

-catarc 1022754972

-policy policy_name
Lists the backups that the indicated policy_name for the specified client
creates.
-sched sched_name
Lists the backups that are created following schedule_name for the specified
client.
-id backup_id
Creates a list for the specified backup_id.
-online
Lists only files-file that are online.
-offline
Lists only files-file that are offline.
-version
Displays the bpcatlist version and exit.
58 NetBackup Commands
bpcatlist

EXAMPLES
Displayed dates must be specified in ctime (for example, Fri Sep 13 00:00:00
2007) date format. Displayed dates may be cut and specified without modification.

To list a backup for a specific date and time, specify:

bpcatlist -date Mon Sep 17 14:16:28 2007

(When no year is specified, the current year is used by default.)

To list all backups between two dates of the current year, specify the following:

bpcatlist -before Mon Sep 10 00:00:00 2007 -since Fri Oct

4 00:00:00 2007

To list the backups that are two to three months old, specify the following:

bpcatlist -before-months 2 -since-months 3

-since and -before use the following equivalent values:

-since-days nnn
-since-weeks nnn
-since-months nnn
-before-days nnn
-before-weeks nnn
-before-months nnn

For example, the setting -since-days 14 is equivalent to -since-weeks 2

SEE ALSO
bpcatarc, bpcatres, bpcatrm
 NetBackup Commands 59
bpcatres

bpcatres
bpcatres – restore NetBackup catalog

SYNOPSIS
<admin_dir_path>bpcatres [-version]
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

DESCRIPTION
bpcatres processes the output of bpcatlist to restore the selected catalog image
.f files.

OPTIONS
-version
Displays the bpcatres version and exits.

SEE ALSO
bpcatarc, bpcatlist, bpcatrm
60 NetBackup Commands
bpcatrm

bpcatrm
bpcatrm – delete NetBackup catalog

SYNOPSIS
<admin_dir_path>bpcatrm [-version]
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

DESCRIPTION
bpcatrm processes the output of bpcatlist or bpcatarc to delete the selected
catalog image .f files that have a valid catarc ID in their image file.

OPTIONS
-version
Displays the bpcatrm version and exits.

SEE ALSO
bpcatarc, bpcatlist, bpcatres
 NetBackup Commands 61
bpcd

bpcd
bpcd – NetBackup client daemon. Enables the NetBackup clients and servers to
accept requests from NetBackup servers.

SYNOPSIS
<nbu_dir_path>bpcd [-standalone] [-debug] [-portnum number] [-keyfile]
[-restrict_if host_or_ip]
On UNIX and Linux systems, <nbu_dir_path> is /usr/openv/netbackup/bin/
On Windows systems, <nbu_dir_path> is <install_path>\NetBackup\bin\

DESCRIPTION
On Windows systems, bpcd is a communications daemon that the NetBackup
Client Service bpinetd activates. Typically, on UNIX systems inetd activates
bpcd.

The bpcd daemon accepts requests from NetBackup servers. Requests include the
following:
■ Initiate backup and restore jobs
■ Get NetBackup configuration parameters
■ Set NetBackup configuration parameters
When you install NetBackup on a client, the installation process typically adds
entries for bpcd to the following:
■ UNIX or Linux client: /etc/services and /etc/inetd.conf
■ Windows client: %SystemRoot%\system32\drivers\etc\services
The services entry looks like the following:

bpcd 13782/tcp bpcd

The inetd.conf entry on UNIX and Linux systems looks like the following:

bpcd stream tcp nowait root /usr/openv/netbackup/bin/bpcd bpcd

OPTIONS
The following options are available only on UNIX and Linux clients and imply
that the -standalone option is active.
62 NetBackup Commands
bpcd

-standalone
Instructs bpcd to run continuously rather than inetd start it.
-debug
Prevents bpcd from forking and does not disconnect it from standard input,
output, and error.
-portnum number
Specifies the port number where bpcd listens for requests. The default is the
bpcd entry in: /etc/services.

-restrict_if host_or_ip
Specifies the local network interface that bpcd accepts connections from.
Default is to accept connections from all local network interfaces. You can
specify either a host name or an IP address.
-keyfile
When -keyfile is specified, you are prompted for the NetBackup pass phrase
that lets bpcd access the NetBackup encryption key file.
See the section "Additional key file security (UNIX clients only)" in the
NetBackup Security and Encryption Administrator’s Guide for more
information.

SEE ALSO
bpclient, bpkeyfile
 NetBackup Commands 63
bpchangeprimary

bpchangeprimary
bpchangeprimary – promote a copy of a backup to be the primary copy

SYNOPSIS
<admin_dir_path>bpchangeprimary -copy number | -pool volume_pool |
-group volume_group [-id backup_id] [-M master_server]
<admin_dir_path>bpchangeprimary -copy number | -pool volume_pool |
-group volume_group [-sl schedule_name] [-pn policy_name] [-st
schedule_type] [-pt policy_type] [-cl client_name] [-kw keyword] [-sd
date time] [-ed date time] [-M master_server]
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

DESCRIPTION
The bpchangeprimary command lets you change which copy is the primary copy
for a set of backup images. You can choose the copy to be promoted to primary
by specifying a copy number, volume pool, or volume group. You can apply several
optional criteria to identify the backup images to be affected.
The primary copy of a backup is the copy used by a restore process. Ensure that
the primary copy is accessible for restore. For instance, if one copy of a backup
was sent off site, change the primary copy to be the copy that remains on site.
The bpchangeprimary command finds all backups that match the specified criteria
and updates their copy number to primary.
If you use the -copy option, the specified copy number becomes the primary copy.
If you use the -group or -pool option, the process identifies all media IDs that
belong to the specified volume group or volume pool. It then changes all copies
that reside on those media to primary.

OPTIONS
One of the following three options is required; using one precludes the use of the
others.
-copy number
Specifies that the copy_number is the number of the backup copy you want
to promote to primary.
64 NetBackup Commands
bpchangeprimary

-pool volume_pool
Specifies that the copy on the media that belongs to volume_pool is to be
promoted to primary.
-group volume_group
Specifies that the copy on the media that belongs to volume_group is to be
promoted to primary.
You can apply combinations of one or more of the following criteria to specify
which copies are made primary. None of the following options are required.
-cl client_name
Specifies that backups of client_name are affected. This name must be as it
appears in the NetBackup catalog. For those backup images, this option
promotes the copy that corresponds to the specified -pool, -group, or -copy
option to primary. The default is all clients.
-sd date time, -ed date time
Specifies the start date (-sd) or end date (-ed) of the backup images for which
the primary copy is changed.
The required date and time values format in NetBackup commands varies
according to your locale. The /user/openv/msg/.conf file (UNIX and Linux)
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.
More information is available about the locale of your system.
See the "Specifying the locale of the NetBackup installation" topic in the
NetBackup Administrator's Guide, Volume II.
The default start date is January 1, 1970, which effectively causes a search
for all images. If you run bpchangeprimary without using the -sd option, the
following occurs: You are prompted for a confirmation that you want to
change the primary copy for the backups that were created after January 1,
1970.
The default end date is the current date. The valid range of dates is from
01/01/1970 to 01/19/2038.
-id backup_id
Specifies the backup ID of the backup image for which the primary copy is
changed. For that backup image, -id backup_id changes the copy that
corresponds to the specified -pool, -group, or -copy option.
 NetBackup Commands 65
bpchangeprimary

If you specify this option, you can specify an alternate master server (by using
the -M option). You must specify one of -pool, -group, or -copy. No other
options are used with -id.
-kw keyword
Specifies a keyword phrase for NetBackup to use when you identify backup
images for which the primary copy is changed.
-M master_server
Specifies that the backups that belong to master_server are affected. For those
backup images, -M master_server promotes the copy that corresponds to
the specified -pool, -group, or -copy option to primary.
If you use this option, any other options you specify determine which backup
images on the specified master server are affected. The master_server must
allow access by the system that issues the bpchangeprimary command. The
default is the master server for the system that runs the bpchangeprimary
command.
-pn policy_name
Specifies the name of the backup policy of the backups for which the primary
copy is changed. The default is all policies.
-pt policy_type
Specifies the type of the backup policies of the backups for which the primary
copy is changed. The default is all policy types.
The policy_type is one of the following character strings:
Informix-On-BAR
MS-Exchange-Server
MS-SQL-Server
MS-Windows
NetWare
Oracle
OS/2
Standard
Sybase
NDMP
The following policy types apply only to NetBackup Enterprise Server:
AFS
66 NetBackup Commands
bpchangeprimary

Auspex-FastBackup
DataTools-SQL-BackTrack
DB2
Enterprise-Vault
FlashBackup
SAP
Split-Mirror
-sl schedule_name
Specifies the schedule name (label) for the selection of the backup images for
which the primary copy is changed.
By default, the bpchangeprimary command uses all schedules.
-st schedule_type
Specifies the schedule type for the selection of the backup images for which
the primary copy is changed.
By default, the bpchangeprimary command uses any schedule type. Valid
vales are as follows:
FULL (full backup)

INCR (differential-incremental backup)

CINC (cumulative-incremental backup)

UBAK (user backup)

UARC (user archive)

NOT_ARCHIVE (all backups except user archive)

EXAMPLES
Example 1
The following command promotes all copies on the media that belongs to the
volume pool SUN created after 08/01/2009 to be the primary copy.

bpchangeprimary -pool SUN -sd 08/01/2009

Example 2
The following command promotes copy 2 of all backups of client, oak, created
after 01/01/2009 to be the primary copy:

bpchangeprimary -copy 2 -cl oak -sd 01/01/2009

 NetBackup Commands 67
bpchangeprimary

Example 3
The following command promotes copy 4 of all backups that the backup policy
Offsite created after 08/01/2007 to be the primary copy:

bpchangeprimary -copy 4 -pn Offsite -sd 08/01/2007

68 NetBackup Commands
bpclient

bpclient
bpclient – manage client entries on a master server

SYNOPSIS
<admin_dir_path>bpclient -All [-M master_server] [-l | -L | -H]
<admin_dir_path>bpclient -client client_name [-M master_server] [-l
| -L | -H]
<admin_dir_path>bpclient -client client_name [-M master_server] -add
| -update [-dynamic_address 0|1] [-free_browse 0|1|2] [-list_restore
0|1|2|3] [-max_jobs [1-99] [-current_host host_name] [-current_ip_addr
ip_address] [-current_host host_name[:ip_address]|:ip_address
[-WOFB_enabled 0|1] [-WOFB_FIM 0|1] [-WOFB_usage 0|1] [-WOFB_error
0|1] [-connect_options 0|1|2 0|1|2 0|1|2|3] [-granular_proxy
granular_proxy_host] [-client_direct 0|1|2]
<admin_dir_path>bpclient -client client_name [-M master_server]
-delete
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

DESCRIPTION
The bpclient command describes how a NetBackup server connects to NetBackup
clients.

OPTIONS
-add
Adds a new client entry.
-All
Lists all client entries. Only the client entries appear that are added explicitly
by using the bpclient command.
-client client_name
Specifies the name of the client to list or update.
-client_direct 0|1|2
Client Direct improves backup and restore performance by using the
OpenStorage storage server instead of the media server to transfer data to
 NetBackup Commands 69
bpclient

the client. The -client_direct option setting determines if and when the
client uses this feature. The following settings are possible:
0 = Always use Client Direct: Tries to use only the Client Direct method with
the specified client. If this method fails for any reason, the job fails. No other
transfer method is tried.
1 = Prefer to use Client Direct: Probes for the Client Direct capabilities on the
storage server that is identified during the backup. If the probe passes,
NetBackup uses the Client Direct data transfer method on the specified client.
If the probe fails, is uses the normal data transfer method.
2 = Never use Client Direct: Never use Client Direct as the data transfer method
on the specified host. Always use the normal data transfer method. This
setting is the default condition.
-connect_options 0|1|2 0|1|2 0|1|2|3
First set of arguments, Ports, represents the following:
0 = Reserved Port: Use a reserved port number

1 = Non-reserved Port: Connect to the client’s bpcd by using a non-reserved

port number. If you select this option, enable Allow Nonreserved Ports for
the selected client.
2 = Use Default: Use Default is the default. Use the value that the
DEFAULT_CONNECT_OPTIONS configuration entry on the server defines.
The second set of arguments, BPCD Connect Back, represents the following:
0 = Random Port: NetBackup randomly chooses a free port in the allowed
range to perform the traditional connect-back method.
1 = VNETD port: This method requires no connect-back. The Veritas Network
Daemon (vnetd) was designed to enhance firewall efficiency with NetBackup
during server-to-server and server-to-client communications.
2 = Use Default: The default option. Use the value that the
DEFAULT_CONNECT_OPTIONS configuration entry on the server defines.
The third set of arguments (Daemon Connection Port) represents the
following:
0 = Automatic: This option means that VNETD is used if possible; otherwise
Legacy is used.
1 = Use the VNETD port.
2 = Use the Legacy port number.
3 = Use Default: The default option. Use the value that the
DEFAULT_CONNECT_OPTIONS configuration entry on the server defines.
70 NetBackup Commands
bpclient

Note: If the vnetd Daemon Connection Port is used, the BPCD Connect Back
setting is not applicable. If the vnetd Daemon Connection Port is used,
non-reserved ports are always used regardless of the value of the Ports setting.

-current_host host_name[:ip_address]|:ip_address
The host name and the IP address of the client. This option is meaningful
only when the option -dynamic_address 1 is used. Usually, you do not have
to enter a -current_host value. The client normally contacts the master
server to set the host name and the IP address.
-current_hostname host_name
The current host name of the client. This option is meaningful only when the
option -dynamic_address 1 is used. Usually, you do not have to enter a
-current_hostname value. The client normally contacts the master server
to set the host name and the IP address.
-current_ip_addr ip_address
The current IP address of the client. This option is meaningful only when the
option -dynamic_address 1 is used. Usually, you do not have to enter a
-current_ip_addr value. The client normally contacts the master server to
set the IP address.
-delete
Deletes an existing client entry.
-dynamic_address 0|1
0 = The client name is assumed to be a valid host name for the client (default).

1 = The client is assumed to have a dynamic host name (such as DHCP).

-free_browse 0|1|2
A method that allows users to get around the checking that the server does
when it browses images (owner or group). By default, normal users are not
allowed to browse into scheduled backups on Windows.
0 = Allow

1 = Deny

2 = Use

By default, both the client and the server should be set up to 0 (allow). To
browse freely, either the client or the server must be set up to 2 (use). Neither
can be set up for 1 (deny).
-H
Lists host-specific client information.
 NetBackup Commands 71
bpclient

-l
Lists the limited client information.
-L
Lists all client information in a VERBOSE format.
-M master_server
Name of the master server that contains the client entries. The first server
name in the local configuration is the default master server.
-list_restore 0|1|2|3
Sets up on the server to disallow list and restore requests from a particular
client. The value in the client database overrides the bp.conf file setting.
0 = Not specified (default)

1 = Allow both list and restore requests

2 = Allow list requests only

3 = Deny both list and restore requests

-max_jobs [1-99]
The maximum number of jobs up to 99 that are allowed to run concurrently
on this client. You can configure this item in the NetBackup Administration
Console. It is labeled "Maximum data streams." To perform this function by
using this GUI, select the following: Host Properties > Master Servers >
(double-click the master server name) > Client Attributes.
-update
Updates an existing client entry.
-WOFB_enabled 0|1
0 = disables Windows Open File Backup for the client that is specified in
client_name.
1 = enables Windows Open File Backup for the client that is specified in
client_name.
-WOFB_FIM 0|1
0 = Use Volume Snapshot Provider (VSP) as the snapshot provider for the
Windows Open File Backups. VSP is supported only on the clients that use
NetBackup Release 6.x. Clients that use NetBackup Release 7.x only use VSS.
If you run a Release 7.x client and select VSP with this option, NetBackup
automatically runs VSS instead.
1 = Use Microsoft’s Volume Shadow Service (VSS) as the snapshot provider
for Windows Open File Backups.
72 NetBackup Commands
bpclient

-WOFB_usage 0|1
0 = Individual Drive Snapshot. Specifies that the snapshot be of an individual
drive. When this property is enabled, snapshot creation and file backup are
done sequentially on a per volume basis.
1 = Global Drive Snapshot. Specifies that the snapshot is of a global drive.
The snapshots are taken at one time for all the volumes that require snapshots
for the backup job (or stream group for multistreamed backups) .
-WOFB_error 0|1
0 = Abort Backup on Error. Specifies that a backup aborts if it fails for a
snapshot-related issue in the following situation: After the snapshot is created
and while the backup uses the snapshot to back up open or active files on the
file system.
1 = Disable Snapshot and Continue. Specifies that if the snapshot becomes
invalid during a backup, the volume snapshots for the backup are destroyed.
The backup continues with Windows Open File Backups disabled.

EXAMPLES
Example 1
The following command determines if the client hagar is in the client database
on the master server:

bpclient -client hagar -L

Example 2
The following command adds casper to the client database on the master server.
It also allows a maximum of five concurrent jobs to be run on casper.

bpclient -client casper -add -max_jobs 5

Example 3
The following command lists all client information in verbose format for client
ollie.

# bpclient -client ollie -L

Client Name: ollie
Current Host:
Hostname: ollie
IP Address: 0.0.0.0
Dynamic Address: no
Free Browse: Allow
List Restore: Not Specified
 NetBackup Commands 73
bpclient

Max Jobs This Client: Not Specified

WOFB Enabled: yes
WOFB FIM: VSP
WOFB Usage: Individual Drive Snapshot
WOFB Error Control: Abort on Error
Client Direct: Prefer to use client-side deduplication or
Prefer to move data direct to storage
Client Direct Restore: Move data via media server
OST Proxy: Off
OST Proxy Server: Unspecified
Connect options: 2 2 3
74 NetBackup Commands
bpclimagelist

bpclimagelist
bpclimagelist – produce status report on client NetBackup images or removable
media

SYNOPSIS
<admin_dir_path>bpclimagelist [-U | -Likelydate] [-Listseconds]
[-client client_name] [-server server_name] [-BE] [-t FULL | INCR |
CINC | UBAK | UARC | ANY | NOT_ARCHIVE] [-policy policy_name]
[-keyword keyword_phrase] [-ct client_type] [-s mm/dd/yyyy HH:MM:SS]
[-e mm/dd/yyyy HH:MM:SS]
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

DESCRIPTION
The bpclimagelist command generates status reports on client NetBackup images
or removable media.

OPTIONS
-BE
Displays only the images that were backed up by Backup Exec.
-client client_name
Specifies the client on which a status report is to be generated.
-ct client_type
Displays only the images that are backed up for a specified client type. The
client_type is specified as an integer. Valid values are the following:
0 - standard (typical for UNIX file system backups)
4 - Oracle DB
6 - Informix DB
7 - Sybase DB
8 - Sharepoint
10 - Netware
13 - Windows (typical for Windows file system backups)
 NetBackup Commands 75
bpclimagelist

15 - SQL Server
16 - Exchange
17 - SAP
18 - DB2
19 - NDMP
20 - Flash Backup
21 - Split Mirror
30 - Vault
34 - Disk Staging
35 - NetBackup Catalog
39 - Enterprise Vault
-e mm/dd/yyyy HH:MM:SS
Specifies the name of the client to list or update.
-keyword keyword_phrase
Specifies a keyword phrase for NetBackup to use when it searches. The phrase
must match the one that was previously associated with the image.
-Likelydate
Searches for a useful timestamp that marks the start of backup images to use
for a restore. Usually, this timestamp is the time of the last full backup image.
With no other arguments, this option returns the decimal number of seconds
since January 1, 1970. You can get more detailed and friendly information
by also specifying -L.
-Listseconds
Specifies that the timestamp is shown in seconds granularity.
-policy policy_name
Reports on the backup images that use the specified policy. The default is
any policy.
-s mm/dd/yyyy HH:MM:SS, -e mm/dd/yyyy HH:MM:SS
Specifies the start date (-s) and end date (-e) for the listing.
The -s option specifies a start date and time for the listing. The resulting list
shows only files in backups or the archives that occurred at or after the
specified date and time.
The required date and time values format in NetBackup commands varies
according to your locale. The /user/openv/msg/.conf file (UNIX and Linux)
76 NetBackup Commands
bpclimagelist

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.
More information is available about the locale of your system.
See the "Specifying the locale of the NetBackup installation" topic in the
NetBackup Administrator's Guide, Volume II.
The valid range of dates is from 01/01/1970 00:00:00 to 01/19/2038 03:14:07.
The default is the current date minus six months.
The -e option specifies an end date and time for the listing. The resulting list
shows only files from the backups or the archives that occurred at or before
the specified date and time. Use the same format for start date and time. The
default is the current date and time.
-server server_name
Indicates the name of the NetBackup server. The default value is the first
server name listed in the bp.conf file.
-t
Specifies a schedule type for the image selection. The default is any schedule
type. Valid values, in either uppercase or lowercase, are as follows:
■ FULL (full backup)
■ INCR (differential-incremental backup)
■ CINC (cumulative-incremental backup)
■ UBAK (user backup)
■ UARC (user archive)
■ ANY
■ NOT_ARCHIVE (all backups except user archive)
-U
User display format.
 NetBackup Commands 77
bpclntcmd

bpclntcmd
bpclntcmd – test functionality of a NetBackup system and enable Fibre Transport
services on a NetBackup client

SYNOPSIS
<nbu_dir_path>bpclntcmd [-sv] [-pn] [-self] [-hn hostname] [-server
NBU_master] [-ip ip_address] [-gethostname] [-is_local_host hostname]
[-check_vxss] [-check_vxss_with_host hostname] [-get_pbx_port
hostname] [-get_remote_host_version hostname] [ -ml | -di ]
[-sanclient [0 | 1]]
On UNIX and Linux systems, <nbu_dir_path> is /usr/openv/netbackup/bin/
On Windows systems, <nbu_dir_path> is <install_path>\NetBackup\bin\

DESCRIPTION
The bpclntcmd command tests the functionality of a NetBackup system and
displays information about it. It also enables and disables the Fibre Transport
services on a NetBackup client.

OPTIONS
-check_vxss
Checks if NBAC is configured correctly on the local system.
-check_vxss_with_host hostname
Checks if NBAC is configured correctly on the local system to connect to the
remote host, hostname.
-di filename
Deletes an image by specifying a file name. This option is supported only for
Backup, SQL-BackTrack, and Sybase.
-gethostname
Returns the host name that NetBackup uses on the local system.
-get_pbx_port hostname
Displays the number that hostname considers the PBX port number. If
hostname is not specified, the option displays the number that the local host
considers the PBX port number.
78 NetBackup Commands
bpclntcmd

-get_remote_host_version hostname
Returns the version of NetBackup that is running on the system that is
identified in the hostname variable.
-hn hostname
Returns the host name, alias, and IP address information about the host name
that is identified in the hostname variable.
-ip ip_address
Returns the host name, alias, and IP address information about IP address,
ip_address.
-is_local_host hostname
Checks if hostname is a network interface on the local system.
-ml filename
Displays the media ID by specifying a file name. By specifying a single file
name in an image, -ml filename returns the media ID of the tape, which
contains the image that contains that file.
-pn
Returns what the master server considers your host name (or peer name) to
be.
-sanclient [ 0 | 1 ]
0 - Disables the client Fibre Transport (FT) service. The command returns a
NetBackup SAN client to normal client functionality.
1 - Enables the client FT service, which effectively makes a regular NetBackup
client a SAN client.
-self
Returns the information about the local system.
-server NBU_master
Returns the host name information of the NetBackup master server.
-sv
Returns the NetBackup version of the master server.

SEE ALSO
bpnbat
 NetBackup Commands 79
bpclusterutil

bpclusterutil
bpclusterutil – Modify and configure NetBackup in a cluster.

SYNOPSIS
<nbu_dir_path>bpclusterutil [-addnode NodeName] [-addSvc ServiceName]
[-c] [-ci] [-delete] [-deleteSvc ServiceName] [-depend ServiceName
DependServiceName] [-disableSvc ServiceName] [-display] [-enableSvc
ServiceName] [-freeze] [-isactive] [-iscluster] [-offline] [-online]
[-np] [-s [NBU | OC]] [-startagent] [-stopagent] [-unfreeze] [-vname]
<nbu_dir_path>bpclusterutil -r CLUSTEREDSERVICES servicename |
CLUSTERGROUPNAME | CLUSTERNAME clustername | CLUSTERTYPE [MSCS|VCS]
| GLOBDBHOST nodename | MONITOREDSERVICES servicename |
NETBACKUPINSTALLPATH path | NETBACKUPSHAREDDRIVE drive: |
NETBACKUPTYPE [MASTER|MEDIA] | NETWORKSELECTION network name |
NODENAMES nodename | VIRTUALIPADDRESS ip address | VIRTUALSERVERNAME
virtual name | VIRTUALSUBNETMASK subnet mask
<nbu_dir_path>bpclusterutil -rm CLUSTEREDSERVICES servicename |
MONITOREDSERVICES servicename
On UNIX and Linux systems, <nbu_dir_path> is /usr/openv/netbackup/bin/
On Windows systems, <nbu_dir_path> is <install_path>\NetBackup\bin\

DESCRIPTION
This command is available on NetBackup master and media servers.
On Windows, this command sets up the registry entries that are used for cluster
configuration and then to configure the cluster. This command only modifies
registry entries on the local node.

OPTIONS
-addnode
This option is available on Windows systems only. Adds a node name to the
possible owners list of all the resources in the NetBackup group.
-addSvc "Service Name"
Adds a NetBackup service to the NetBackup cluster group.
-c
Configures NetBackup in a cluster as based on the values that you specified
in the registry and brings the NetBackup group online.
80 NetBackup Commands
bpclusterutil

-ci
Configures NetBackup in a cluster as based on the values that you specified
in the registry and does not bring the NetBackup group online.
-delete
Deletes the registry entries that are used to configure NetBackup in a cluster.
-depend "Service Name" DependServiceName
This option is available on Windows systems only. Sets the cluster resource
for Service Name to have a dependency on DependServiceName.
-deleteSvc "ServiceName"
Delete an existing NetBackup service from the NetBackup cluster group.
Ensure that ServiceName is provided within double quotes. For example,
"NetBackup Key Management Service" for the key management service.
-disableSvc "Service Name"
Disable monitoring of a NetBackup service by the cluster.
-display
This option is available on Windows systems only. Displays the registry
entries that are used for cluster configuration.
-enableSvc "Service Name"
Enable the cluster to monitor a NetBackup service you added to the NetBackup
cluster group.
-freeze
This option is available on UNIX and Linux systems only. Freeze the
NetBackup cluster group.
-isactive
This option displays the state of the NetBackup cluster group on the node. A
return code of 1 indicates that the node is the active node. A return code of
0 indicates that the node is an inactive node.
-iscluster
This option displays the cluster status of NetBackup.
-np
silent mode (no print).
-offline
This option issues the offline command to the NetBackup group in the cluster.
-online
This option issues the online command to the NetBackup group in the cluster.
 NetBackup Commands 81
bpclusterutil

-r
This option is available on Windows systems only. Sets the corresponding
NetBackup cluster configuration registry entry to the specified value.
CLUSTEREDSERVICES servicename
This option adds servicename to the CLUSTEREDSERVICES registry entry.
Only one service name can be entered at a time; run the command multiple
times to add service names. The service name should match the service name
property of the service.
CLUSTERGROUPNAME, CLUSTERNAME clustername, CLUSTERTYPE MSCS|VCS,
GLOBDBHOST nodename, MONITOREDSERVICES servicename
This option adds servicename to the MONITOREDSERVICES registry entry.
Only one service name can be entered at a time; run the command multiple
times to add service names. The service name should match the service name
property of the service.
NETBACKUPINSTALLPATH path, NETBACKUPSHAREDDRIVE drive:, NETBACKUPTYPE
MASTER|MEDIA, NETWORKSELECTION network name, NODENAMES nodename
If NODENAMES is specified, only one node name can be entered. Run the
command multiple times to add node names.
VIRTUALIPADDRESS ip address, VIRTUALSERVERNAME virtual name,
VIRTUALSUBNETMASK subnet mask, -rm
Removes a value from the corresponding NetBackup cluster configuration
registry entry.
CLUSTEREDSERVICES servicename
This option removes servicename from the CLUSTEREDSERVICES registry
entry. Only one service name can be entered at a time; run the command
multiple times to remove service names. The service name should match the
service name property of the service.
MONITOREDSERVICES servicename
This option removes servicename from the MONITOREDSERVICES registry
entry. Only one service name can be entered at a time; run the command
multiple times to remove service names. The service name should match the
service name property of the service.
-s [NBU | OC]
Selects the clustered server type. The possible values are NBU (NetBackup)
and OC (OpsCenter).
-sharedpath
Displays the shared path of the clustered server.
82 NetBackup Commands
bpclusterutil

-startagent
Starts the NetBackup VCS agent.
-stopagent
Stops the NetBackup VCS agent.
-unfreeze
This option is available on UNIX and Linux systems only. Unfreeze the
NetBackup cluster group.
-vname
This option is available on UNIX and Linux systems only. Displays the virtual
name of the NetBackup cluster group.
 NetBackup Commands 83
bpcompatd

bpcompatd
bpcompatd – run NetBackup compatibility service

SYNOPSIS
<nbu_dir_path>bpcompatd [-max_time seconds] [-console] [-debug]
<nbu_dir_path>bpcompatd -alive [-debug]
<nbu_dir_path>bpcompatd -terminate [-debug]
<nbu_dir_path>bpcompatd -bpcd_connect clientname [-debug]
<nbu_dir_path>bpcompatd -bpdbm_connect hostname [-debug]
<nbu_dir_path>bpcompatd -bpjobd_connect hostname [-debug]
<nbu_dir_path>bpcompatd -bprd_connect hostname [-debug]
<nbu_dir_path>bpcompatd -robot_connect hostname robot_type [-debug]
<nbu_dir_path>bpcompatd -vmd_connect hostname [-debug]
On UNIX and Linux systems, <nbu_dir_path> is /usr/openv/netbackup/bin/
On Windows systems, <nbu_dir_path> is <install_path>\NetBackup\bin\

DESCRIPTION
This command is used internally by new NetBackup services to communicate with
legacy NetBackup services.

OPTIONS
-alive
Tests the local bpcompatd daemon or service to see if it is running.
-terminate
Terminates the local bpcompatd daemon or service if it is running.
-bpcd_connect clientname
Tests a bpcd connection to clientname by using the bpcompatd command.
-bpdbm_connect hostname
Tests a bpdbm connection to hostname by using the bpcompatd command.
-bpjobd_connect hostname
Tests a bpjobd connection to hostname by using the bpcompatd command.
-bprd_connect hostname
Tests a bprd connection to hostname by using the bpcompatd command.
84 NetBackup Commands
bpcompatd

If you specify -debug, the information that is normally logged in the debug
log file of bpcompatd is written to standard error.
If you do not specify one of these options, bpcompatd runs as a daemon (for
UNIX/Linux) or a service (for Windows). The following options are available
when you run bpcompatd as a daemon or service:
-robot_connect hostname
Tests a robot daemon connection to hostname for robot type <robot_type>
using thebpcompatd.
-vmd_connect hostname
Tests a vmd connection to hostname by using the bpcompatd command.
-max_time seconds
The maximum time bpcompatd waits for a new connection before it performs
routine tasks. The default is 60 seconds on UNIX and Linux systems. The
default is one second on Windows systems.
-console
This option is applicable to Windows only. Normally, bpcompatd is run through
the Service Manager. You can use the -console option to run the bpcompatd
service from the command line.
-debug
If you specify -debug, the information that normally is logged on the debug
log file of bpcompatd is written to standard error. For Windows, this option
implies the -console option. On UNIX and Linux systems, this option prevents
the bpcompatd service from running in the background.
 NetBackup Commands 85
bpconfig

bpconfig
bpconfig – modify or display global configuration attributes for NetBackup

SYNOPSIS
<admin_dir_path>bpconfig [-cd seconds] [-ha hours] [-kl days] [-kt
days] [-ma [address]] [-sto seconds] [-mj number] [-period hours]
[-prep hours] [-to seconds] [-max_copies number] [cleanup_int hours]
[cleanup_wait minutes] [-tries times] [-wi minutes] [-pui minutes]
[-v] [-M master_server,...]
<admin_dir_path>bpconfig [-L | -l | -U [-v] [-M master_server,...]]
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

DESCRIPTION
The bpconfig command modifies or displays the NetBackup global configuration
attributes. These attributes affect operations for all policies and clients. With the
exception of the NetBackup administrator’s email address, the default values for
these attributes are adequate for most installations.
See the NetBackup Global Attributes section in the NetBackup Administrator’s
Guide, which describes the implications of setting the attribute values.
The following describes the two forms of bpconfig:
■ The first form of bpconfig modifies one or more of the NetBackup global
configuration attributes. At least one option that changes a NetBackup global
configuration attribute must be on the command line.
■ The second form of bpconfig displays the current settings of the NetBackup
global configuration attributes. See DISPLAY FORMATS for more detail.
Errors are sent to stderr. A log of the command’s activity is sent to the NetBackup
admin log file for the current day.

OPTIONS
-cd seconds
Specifies the number of seconds that is the Compress-image-Database time
interval. When seconds is a positive integer, an image compresses after this
86 NetBackup Commands
bpconfig

number of seconds has elapsed since the creation of the image. The range of
values is 86400 to 2147472000. On Windows, NetBackup uses NTFS file
compression only if the database is in an NTFS partition. Otherwise, it is not
compressed.
The effect of compression is that the image database needs less disk space.
However, you need to decompress the images before you browse the image
database for restoring. If you browse first, the compressed images are not
found. To decompress the images, you must use the bpimage command.
The default is 0, which means no compression is done.
-cleanup_int hours
Specifies the minimum period of time (in hours) that can elapse without a
catalog cleanup. The default value is 12 (hours). Since cleanup cannot run
during a catalog backup, large 24x7 environments that run long catalog
backups may need a shorter cleanup interval (e.g., three hours). Regardless
of the value of this option, the image database is automatically cleaned up at
the end of a session of scheduled backups.
This option appears in the output display as Image DB Cleanup Interval (see
examples).
-cleanup_wait minutes
Specifies the interval (in minutes) between image database catalog cleanup
operations. The default value is 60 (minutes). If multiple backups occur during
this cleanup wait interval, NetBackup only initiates one cleanup operation
in this time period. The range of values is zero (0) to 720.
-ha hours
Specifies the number of hours ago that is the beginning of the time range for
selecting NetBackup report entries. The end of the time range is the current
time. For example, if hours ago is 24 and if you request a Backup Status report
at 10:00 a.m., the report includes the following: All backups that ran from
10:00 a.m. yesterday until 10:00 a.m. today.
This value is used to calculate the time range for general reports and media
reports. General reports include Backup Status, Client Backups, Problems,
and All Log Entries. Media reports include Media List, Media Summary, Media
Contents, Images on Media, and Media Log Entries.
Hours Ago is a positive integer in the range of 1 to 32767. The default value
is 24 (hours).
-kl days
The number of days to keep logs. This number determines how long the
NetBackup master server keeps its Error database and debug logs.
 NetBackup Commands 87
bpconfig

NetBackup derives its Backup Status, Problems, All Log Entries, and Media
Log Entries reports from the Error database.
This value limits the period that these reports can cover. The range of values
is 1 to 32767. The default is 28 days. A value of zero (0) turns logs off.

Note: This attribute has no effect on remote media servers or clients (remote
media servers apply only to NetBackup Enterprise Server).

-kt days
The number of days to Keep True-image-recovery (TIR) data. This value
determines how long to keep TIR information for those policies that specify
the collection of TIR information. The default is one (1) day. A value of zero
(0) turns off the TIR information.
-L
The list type is long. See the section DISPLAY FORMATS for more detail.
-l
The list type is short. This option is the default if the command line has no
list-type option (for instance, if you enter bpconfig and a carriage return).
See the section DISPLAY FORMATS for more detail.
-M master_server,...
The master server where the global configuration attributes reside.
-ma [address]
The mail address for the NetBackup administrator. NetBackup sends
notification of failed automatic backups, the manual backup operations that
the administrator directs, and automatic database backups to this email
address. The default is NULL (no email address).
If no address is provided, the current setting of the Admin Mail Address is
cleared. Notification is no longer sent by email to the NetBackup
administrator.
-max_copies number
The maximum number of copies per backup. The range of values is 2 to 10.
The default value is 2.
-sto seconds
The multihosted-media-mount timeout. This timeout is the time in seconds
that NetBackup waits for a shared medium to be mounted, positioned, and
ready on backups and restores. Use this timeout to eliminate excessive waits
if another server uses a shared medium. The default is 0, which means no
timeout (unlimited wait time).
88 NetBackup Commands
bpconfig

See the NetBackup Administrator’s Guide for details on multihosted drives.

-mj number
Specifies the maximum jobs per client. This number is the maximum number
of jobs that a client can perform concurrently. It must be a positive integer.
The range values are 1 to 32767. The default value is 1.
-period hours
The time interval that is associated with the configured number of tries for
a backup (see -tries). This interval is the period in hours during which
NetBackup tries a backup job for a client/policy/schedule combination for as
many tries as configured. The hours must be a positive integer. The range
values are 1 to 24. The default value is 12 hours.

Note: This attribute does not apply to user-directed backups and archives.

-prep hours
Specifies the preprocessing interval. This interval is the minimum time in
hours between client queries to discover new paths when NetBackup uses
auto-discover-streaming mode.
The default Preprocess Interval value is four (4) hours. If the preprocessing
interval changes, change it back to the default by specifying -prep -1. The
preprocessing interval can be set to preprocess immediately by specifying 0
as the preprocess interval for auto discovery on the bpconfig command line.
The maximum Preprocessing Interval is 48 hours.
For additional information, see the Policies chapter of the NetBackup
Administrator’s Guide.
-pui minutes
Specifies the policy update interval, which is how often NetBackup policy
updates are processed. The default value is 10 minutes. The range of values
is 1 to 1440 (minutes).
-to seconds
Specifies the media-mount timeout. This timeout is the time in seconds that
NetBackup waits for the requested media to be mounted, positioned, and
ready on backups and restores. Use -to to eliminate excessive waits when
you need to mount media manually (for example, when robotic media is out
of the robot or off site).
The default is 0, which means no timeout (unlimited wait time). If seconds is
not 0, its value range is 1 to 32,767 seconds.
 NetBackup Commands 89
bpconfig

-tries times
The number of retries for a backup during the configured time period (see
-period). For a given combination of client, policy, and schedule, NetBackup
tries to run a backup job the specified number of times. This option limits
the number of backup tries if repeated failures occur.

Note: This attribute does not apply to user-directed backups and archives.

Values for -tries range from 1 to 32767. The default is two tries. If defaults
are used for both -tries and -period, NetBackup tries the backup two times
in 12 hours.
-U
The list type is user. See DISPLAY FORMATS for more detail.
-v
Selects verbose mode for logging. This option is meaningful only if it runs
with the debug log function on. Therefore, the following directory must be
defined:
On UNIX and Linux systems: /usr/openv/netbackup/logs/admin
On Windows systems: install_path\NetBackup\logs\admin
-wi minutes
Job Retry Delay. Specifies how often NetBackup retries a job. The default
value is 10 minutes. The range of values is 1 to 1440 (minutes).

DISPLAY FORMATS
bpconfig uses the following three different formats to display the current values
of the NetBackup global configuration attributes:
■ User Display Format (-U)
If the command line contains -U, the display format is user. The user display
format is the format used by bpadm and the NetBackup graphical-user
interfaces. This option produces a list with one global attribute per line. Each
line has the form global attribute descriptor: value. This list is similar to the
-L format, except that the global attribute descriptors are more explicit. The
fields are as follows:
Admin Mail Address
Job Retry Delay
Max Simultaneous Jobs/Client
Backup Tries (x tries in y hours)
90 NetBackup Commands
bpconfig

Keep Error/Debug Logs.

Max drives this master
Keep TrueImageRecovery Info.
Compress Image DB Files.
Media Mount Timeout
Display Reports
Preprocess Interval
Maximum backup copies
Image DB Cleanup Interval
Image DB Cleanup Wait Time
Policy update Interval
■ Long Format (-L)
If the command line contains -L, the display format is long. This option
produces a list with one global attribute per line, in the format global attribute
descriptor: value. The fields are as follows:
Mail Admin
Job Retry Delay
Max Jobs/Client
Backup Tries
Keep Logs.
Max drives per master
Compress DB Files.
Media Mnt Timeout
Display Reports
Keep TIR Info.
Prep Interval
Max backup copies
DB Clean Interval
Policy update interval
■ Short Format (-l)
If the bpconfig command line contains -l or contains no list-format option,
the display format is short, which produces a terse listing. This option is useful
for the scripts or the programs that rework the list into a customized report
format. The list layout is a single line that contains the values for all global
attributes. The time units follow the attributes in parentheses for the attributes
that are expressed in units of time. The attributes appear in the following order
with blanks between them:
NetBackup administrator email address.
Job Retry Delay (minutes).
 NetBackup Commands 91
bpconfig

Time period (hours).

Maximum simultaneous jobs per client.
Tries per period.
Keep logs (days).
Maximum drives this master.
Compress the image database interval (seconds; 0 denotes no compression).
Media mount timeout (seconds; 0 denotes unlimited).
Multihosted-media-mount timeout (seconds; 0 denotes unlimited).
Postprocess images flag (0 denotes deferred, otherwise immediately).
Display reports from <x> hours ago (hours).
Keep TIR information (days).
Preprocessing interval (hours).
Example of how the display formats differ:
bpconfig runs with each of the three display formats on a NetBackup
installation. The NetBackup global attributes are the same for the three
displays.
The first display format, -U, looks like the following:

bpconfig -U
Admin Mail Address:
Job Retry Delay: 1 minutes
Max Simultaneous Jobs/Client: 1
Backup Tries: 2 time(s) in 12 hour(s)
Keep Error/Debug Logs: 28 days
Max drives this master: 0
Keep TrueImageRecovery Info: 1 days
Compress Image DB Files: (not enabled)
Media Mount Timeout: 0 minutes (unlimited)
Display Reports: 24 hours ago
Preprocess Interval: 0 hours
Maximum Backup Copies: 10
Image DB Cleanup Interval: 12 hours
Image DB Cleanup Wait Time: 60 minutes
Policy Update Interval: 10 minutes

The second display format, -L, looks like the following:

bpconfig -L
Mail Admin: *NULL*
Job Retry Delay: 1 minutes
Max Jobs/Client: 1
Backup Tries: 2 in 12 hours
Keep Logs: 28 days
92 NetBackup Commands
bpconfig

Max drives/master: 0
Compress DB Files: (not enabled)
Media Int Timeout: 0 minutes (unlimited)
Display Reports: 24 hours ago
Keep TIR Info: 1 days
Prep Interval: 0 hours
Max Backup Copies: 10
DB Clean Interval: 12 hours
DB Clean Wait Time: 60 minutes
Policy Update Interval:10 minutes

The third display format, -l, looks like the following:

bpconfig -l
*NULL* 1 12 1 2 28 0 0 0 0 1 24 1 0 2 10 60

The display fields for the -l display are interpreted as follows:

NetBackup administrator email address has not been set.
Job Retry Delay is 1 minute.
Time period is 12 hours.
Maximum simultaneous jobs per client is 1.
Tries per period is 2.
Keep logs for 28 days.
Maximum drives this master is 0.
Compress image database interval is 0 seconds; 0 denotes no compression.
Media mount timeout is 0seconds; 0 denotes unlimited.
Multihosted-media-mount timeout is 0 seconds; 0 denotes unlimited.
Postprocess images flag is 1 (immediate).
Display reports from 24 hours ago.
Keep TIR information for one (1) day.
Preprocessing interval is zero (0) hours.
Catalog database cleanup interval is two (2) hours.
Catalog database cleanup wait time is 10 minutes.
Policy update interval is 60 minutes.

RETURN VALUES
An exit status of zero (0) means that the command ran successfully.
Any exit status other than zero (0) means that an error occurred.
If the administrative log function is enabled, the exit status is logged in the
administrative daily log under the log directory:
 NetBackup Commands 93
bpconfig

install_path\NetBackup\logs\admin

/usr/openv/netbackup/logs/admin

It has the following form:

bpconfig: EXIT status = exit status

If an error occurred, a diagnostic precedes this message.

EXAMPLES
Example 1
While the master server kiwi runs, display the global attribute settings on the
master server plim:

bpconfig -U -M plim

Admin Mail Address: [email protected]

Job Retry Delay: 10 minutes
Max Simultaneous Jobs/Client: 1
Backup Tries: 1 time(s) in 8 hour(s)
Keep Error/Debug Logs: 6 days
Max drives this master: 0
Keep TrueImageRecovery Info: 1 days
Compress Image DB Files: (not enabled)
Media Mount Timeout: 30 minutes
Display Reports: 24 hours ago
Preprocess Interval: 0 hours
Maximum Backup Copies: 10
Image DB Cleanup Interval: 12 hours
Image DB Cleanup Wait Time: 60 minutes
Policy Update Interval: 10 minutes

Example 2
Set the Compress-image-database interval to 604800 seconds, so that NetBackup
compresses images more than seven days old:

bpconfig -cd 604800

bpconfig -U

Admin Mail Address: *NULL*

Job Retry Delay: 10 minutes
Max Simultaneous Jobs/Client: 1
94 NetBackup Commands
bpconfig

Backup Tries: 2 time(s) in 12 hour(s)

Keep Error/Debug Logs: 28 days
Max drives this master: 0
Keep TrueImageRecovery Info: 2 days
Compress Image DB Files: older than 7 day(s)
Media Mount Timeout: 0 minutes (unlimited)
Display Reports: 24 hours ago
Preprocess Interval: 0 hours
Maximum Backup Copies: 10
Image DB Cleanup Interval: 12 hours
Image DB Cleanup Wait Time: 60 minutes
Policy Update Interval: 10 minutes

Example 3
Set the Media Mount Timeout to 1800 seconds.

bpconfig -to 1800

bpconfig -U

Admin Mail Address: [email protected]

Job Retry Delay: 10 minutes
Max Simultaneous Jobs/Client: 1
Backup Tries: 1 time(s) in 12 hour(s)
Keep Error/Debug Logs: 3 days
Max drives this master: 0
Keep TrueImageRecovery Info: 24 days
Compress Image DB Files: (not enabled)
Media Mount Timeout: 30 minutes
Display Reports: 24 hours ago
Preprocess Interval: 0 hours
Maximum Backup Copies: 10
Image DB Cleanup Interval: 12 hours
Policy Update Interval: 10 minutes

FILES
UNIX and Linux systems:

/usr/openv/netbackup/logs/admin/*
/usr/openv/netbackup/db/config/behavior

Windows systems:
 NetBackup Commands 95
bpconfig

install_path\NetBackup\db\config\behavior
install_path\NetBackup\logs\admin\*

SEE ALSO
bpimage

See the NetBackup Administrator’s Guide for details on Multihosted Drives.

96 NetBackup Commands
bpdbjobs

bpdbjobs
bpdbjobs – interact with NetBackup jobs database

SYNOPSIS
<admin_dir_path>bpdbjobs [-report] [-M master_servers]
[-ignore_parent_jobs] [ -vault | -lvault | -all_columns |
-most_columns | -gdm ] [-file pathname] [-append] [-noheader]
[-mastertime] [-jobid job1,job2,...jobn] [verbose]
<admin_dir_path>bpdbjobs -summary [-M master_servers]
[-ignore_parent_jobs] [ -U | -L | -all_columns ] [-file pathname]
[-append] [verbose]
<admin_dir_path>bpdbjobs -resume | -suspend | -delete | -cancel |
-restart job1,job2,...jobn | type=jobtype | type=all [-M
master_servers] [-quiet]
<admin_dir_path>bpdbjobs -cancel_all [-M master_servers]
<admin_dir_path>bpdbjobs -clean [-M master_servers] [ -keep_hours
hours | -keep_days days ] [ -keep_successful_hours hours |
-keep_successful_days days ] [verbose]
<admin_dir_path>bpdbjobs -version
<admin_dir_path>bpdbjobs -change_priority_by [-M master_servers]
-priority number -jobid job1,job2,...jobn
<admin_dir_path>bpdbjobs -set_priority [-M master_servers] -priority
number -jobid job1,job2,...jobn
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> 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.
 NetBackup Commands 97
bpdbjobs

Refer to the NetBackup Administrator’s Guide for UNIX and Linux, Volume II 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

OPTIONS
-all_columns
Displays all columns of a report or summary. Some of the more useful fields
of this command are:
field2 = jobtype
0=backup, 1=archive, 2=restore, 3=verify, 4=duplicate, 5=import, 6=catalog
backup, 7=vault, 8=label, 9=erase, 10=tape request, 11=tape clean, 12=format
tape, 13=physical inventory, 14=qualification, 15=database recovery,
16=media contents, 17=image delete, 18=LiveUpdate
field3 = state
0=queued, 1=active, 2=wait for retry, 3=done, 4=suspended, 5=incomplete
field5 = policy
The policy that this job is associated with.
field6 = schedule
98 NetBackup Commands
bpdbjobs

The schedule that this job is associated with.

field14 = operation
0=mount
1=position
2=connect
3=write
4=vault initialize
5=vault duplication
6=vault duplication complete
7=vault catalog backup
8=vault eject and report
9=vault complete
10=report
11=duplicate
12=import
13=verify
14=restore
15=catalog-backup
16=vault
17=label
18=erase
field21 = subtype
0=immediate, 1=scheduled, 2=user-initiated, 3=quick erase, 4=long erase,
5=database backup staging, 6=database backup cold
field23 = schedule_type
0=full, 1=incr, 2=user backup, 3=user archive, 4=cumulative-incr
field24 = priority
Priority that is assigned to this job as configured in the policy attributes.
The output of this command consists of a single line per backup job. Each
line of the output is a comma-delimited list in the following format:
 NetBackup Commands 99
bpdbjobs

jobid,jobtype,state,status,policy,schedule,client,server
,started,elapsed,ended,stunit,try,operation,kbytes,files
,pathlastwritten,percent,jobpid,owner,subtype,classtype,
schedule_type,priority,group,masterserver,retentionunits
,retentionperiod,compression,kbyteslastwritten,fileslast
written,filelistcount,[files],trycount,[trypid,trystunit,
tryserver,trystarted,tryelapsed,tryended,trystatus,trys
tatusdescription,trystatuscount,[trystatuslines],trybyte
swritten,tryfileswritten],parentjob,kbpersec,copy,robot,
vault,profile,session,ejecttapes,srcstunit,srcserver,src
media,dstmedia,stream,suspendable,resumable,restartable,
datamovement,snapshot,backupid,killable,controllinghost

The following is an example:

* 415,Backup,Done,96,jvlcc,vlcdiff,mule,buffalo,0885942000,0000000014,
0885942014,8mm,3,,,,,,11602,root,1,0,1,10,,buffalo,2,1,0,0,0,3,/home/
vlc/jadm_JAVA/usr/openv/java,/home/vlc/directory with spaces,/home/vlc/
test,3, 11544,8mm,buffalo,885941970,13,885941983,96,unable to allocate
new media for backup\, storage unit has none available,2,01/27/98 16:59:30
- connecting, 01/27/98 16:59:30 - connected;connect time: 000:00:00,0,0,
11573,8mm,buffalo,885941986,11,885941997,96,unable to allocate new media
for backup\, storage unit has none available,2,01/27/98 16:59:40 -
connecting,01/27/98 16:59:40 - connected; connect time: 000:00:00,0,0,
11602,8mm,buffalo,885942000,14, 885942014,96,unable to allocate new media
for backup\, storage unit has none available,2,01/27/98 17:00:00 -
connecting,01/27/98 17:00:00 - connected; connect time: 000:00:00,0,0

Refer to Example 1 for an example on how to interpret the -all_columns output.

-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 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:
100 NetBackup Commands
bpdbjobs

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.
-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.
 NetBackup Commands 101
bpdbjobs

-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 print the file list or any
information on previous attempts. The -most_columns option is significantly
faster than -all_columns.
-noheader
Prevents the header from being printed in the report.
-quiet
Cancels the reporting of the number of jobs
resumed/suspended/deleted/canceled.
102 NetBackup Commands
bpdbjobs

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

-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 and Linux systems:

/usr/openv/netbackup/logs/bpdbjobs/*
 NetBackup Commands 103
bpdbjobs

On Windows systems: install_path\NetBackup\logs\bpdbjobs\*

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

EXAMPLES
This example shows the following: sample logic to decode -all_columns output
to produce the backup initiation time of a job that succeeded, but not on the first
try.
Field 9 = start time (The time the job was first queued.)
This time is of little value unless you want to know when the job was queued.
Up to Field 32, all fields are fixed. Then Field 32 tells you how many entries are
in the filelist fields.
Field 32 = filelistcount (The number of files that are listed in the filelist.)
Add that value to 33 to determine the field that shows the number of tries:
Field 33 + filelistcount = trycount (The number of tries that occurred.)
If there is only one try, calculate the following to determine its start time:
Field 33 + filelistcount + 4 = [first]trystarted (The start time of the first try.)
If there are two tries, go past the status entries. First, calculate the number of
entries in the status field:
Field 33 + filelistcount + 9 = trystatuscount (The number of status entries in
the first try.)
Then, to get the start time of the second try, calculate the following:
Field 33 + filelistcount + 9 + trystatuscount + 6 = [second] trystarted
104 NetBackup Commands
bpdbm

bpdbm
bpdbm – run NetBackup database manager daemon

SYNOPSIS
<nbu_dir_path>bpdbm [consistency [-move]] [converti2] [ctime
timestamp] [-terminate] [-alive] [-verbose -logqueries -wakeup
minutes]
On UNIX and Linux systems, <nbu_dir_path> is /usr/openv/netbackup/bin/
On Windows systems, <nbu_dir_path> is <install_path>\NetBackup\bin\

DESCRIPTION
bpdbm responds to the queries that are related to the NetBackup internal databases
(catalogs). bpdbm must be running for NetBackup commands and utilities to work
properly. This daemon runs only on the master server and can be started only by
the administrator. The NetBackup request daemon (bprd), or the
/usr/openv/netbackup/bin/initbpdbm script starts bpdbm.

When bpdbm starts, the following sequence occurs in the order listed:
■ It logs a message that indicates that it has started and verifies that no other
instances are running. If another process is found, the program terminates.
■ bpdbm finds its port number by checking the services file for an entry with a
service name of bpdbm and a protocol name of tcp. For example:

bpdbm 13721/tcp

■ bpdbm starts to respond to queries from bprd and the NetBackup administrative
utilities. A child process is created to respond to each query.

OPTIONS
-alive
Sends a query to bpdbm to determine if the bpdbm service is up.
-consistency [0-2]
Runs the consistency checks on the catalog. The following are the three
consistency levels:
0 - A quick check of the NetBackup image database (the default).
1 - Performs more checks than the default check.
 NetBackup Commands 105
bpdbm

2 - The most in-depth consistency check. In addition to the checks of levels

0 and 1, this level also checks that the media that is mentioned in the image
exists. (That is, it cross-references the media servers databases.) On a large
NetBackup installation, the process takes much longer to complete than the
other checks.
-converti2
Converts the old catalogs that were created by using the old directory name
scheme without the time-stamp subdirectories for each client to the new
scheme. Use caution on this operation and make sure that a valid catalog
backup is in hand and ready to use to recover the catalog.
-ctime timestamp
Converts a UNIX timestamp to human-readable form.
-logqueries
Causes bpdbm to log each bpdbm query to the file BPDBMqueries of the tmp
directory. Each query has an entry at the start of the log of the form:

date_stamp process_id query type

And one at the end of the query of the form:

date_stamp process_id query type status status

Where date_stamp is a 10-digit integer, process_id is the identifier for the

process that runs the query, type is an integer that identifies the type of query,
and status is the status returned by the query.
-terminate
Terminates bpdbm. Any currently running child process continues to run until
its task is complete.
-verbose -logqueries
Causes bpdbm to operate at verbose level 1 if it is configured to run in bp.conf
at verbose level 0 and creates the bpdbm log directory and file.
-wakeup minutes
Overrides the default timeout interval (in minutes) that bpdbm uses when it
establishes the initial connection on the port. Used on UNIX and Linux systems
only.

FILES
/usr/openv/netbackup/db/*
/usr/openv/netbackup/bp.conf
106 NetBackup Commands
bpdbm

/usr/openv/netbackup/logs/bpdbm/*
/usr/openv/netbackup/bin/initbpdbm

SEE ALSO
bpadm, bprd
 NetBackup Commands 107
bpdgclone

bpdgclone
bpdgclone – create or remove clones of Volume Manager (VxVM) volumes

SYNOPSIS
/usr/openv/netbackup/bin/bpdgclone [-h] [-v] [-c] -g disk_group -n
volume [-d
primary_disk,secondary_disk:primary_disk_2,secondary_disk_2:
primary_disk_n,secondary_disk_n] [-f output_location]

DESCRIPTION
This command operates only on UNIX and Linux systems.
bpdgclone creates temporary disk groups or clones of disk(s) that contain the
mirror image of the volume for the backups that use array-specific snapshot
methods. In array-specific snapshot methods (EMC TimeFinder, Hitachi
ShadowImage, HP BusinessCopy) client data is configured over a Volume Manager
volume. To avoid a name conflict in the Volume Manager, bpdgclone names the
temporary disk group as follows: client_name_diskgroup_name_clone. When the
backup completes, NetBackup removes the disk group clone.
During normal operation, NetBackup calls the bpdgclone command as needed:
no administrator use of this command is required. But if a system failure prevents
NetBackup from removing the clone, you must use the bpdgclone command with
the -c option to remove the clone. Then you must synchronize the mirror disk
again with the primary disk.

Note: If the backup completes, but the clone is not removed, subsequent backups
of the client’s data fail. To remove a clone, see the examples.

OPTIONS
-g Specifies the name of the target disk group.
-n Specifies the name of the target volume.
-d Lists the primary disks and the secondary disks. The list consists of disk pairs
(primary,secondary), where the primary is separated from the secondary by
a comma. If there is more than one primary disk in the target volume, colons
(:) separate the additional device pairs.
108 NetBackup Commands
bpdgclone

-c Deletes the cloned disk group and volume. Note that the primary disks and
the secondary disks must be resynchronized after the clone is deleted.
-h Prints the command usage.
-v Sets the verbose mode.
-f Specifies an output file. This file contains a list of pathnames of the primary
disks over which the target volume is configured. Use this option to discover
the primary disks that make up the target volume.

NOTES
The following are considerations to note when you use the bpdgclone command:
■ Do not remove a clone while the snapshot backup that uses that clone is still
in progress. With no system failures, NetBackup removes the clone when the
backup completes.
■ If you use the bpdgclone command to remove a left over disk clone, you must
synchronize the mirror disk again with the primary disk.
■ Before NetBackup executes bpdgclone to create the clone, NetBackup splits
the secondary disk from the primary disk.

EXAMPLES
The following example removes a clone.

/usr/openv/netbackup/bin/bpdgclone -g wil_test -n vol01 -c

where wil_test is the name of the disk group after which the clone was named
(in this example, the actual clone would be named clone_wil_test_clone).
For detailed assistance, refer to "Removing a VxVM Volume Clone" in the
Troubleshooting chapter of the NetBackup Snapshot Client Administrator’s Guide.
 NetBackup Commands 109
bpdown

bpdown
bpdown – shut down NetBackup services on Windows systems

SYNOPSIS
<install_path>\NetBackup\bin\bpdown [-S|v] [-f] [-c] [-d] [-m]
[-n][-s] [-r]

DESCRIPTION
This command operates only on Windows systems.
bpdown shuts down the NetBackup services including many components of the
product, such as the NetBackup databases, Media Manager, clients, and some
robotic control daemons. This option does not shut down the processes.
The bpup command starts the NetBackup services.

OPTIONS
-S Silent mode. No listing is generated and no confirmation is requested.
-v The selected verbose mode generates a detailed listing.
-f Forces a shutdown of the NetBackup services without prompting the user
for a confirmation.
-c Shuts down the client.
-d Shuts down the NetBackup database.
-m Shuts down Media Manager.
-n Shuts down the NetBackup server and not the client.
-s Shuts down the server (NetBackup and Media Manager).
-r Shuts down the robotic control daemons.
110 NetBackup Commands
bpduplicate

bpduplicate
bpduplicate – create a copy of backups that NetBackup has created

SYNOPSIS
<admin_dir_path>bpduplicate -npc new_primary_copy -backupid backup_id
[-local] [-client name]
<admin_dir_path>bpduplicate [-number_copies number] [-dstunit
destination_storage_unit_label [,copy2,...] [-dp
destination_volume_pool_name [,copy2,...] [-p | -pb | -PD | -PM]
[-Bidfile file_name] [-v] [-local] [-client name] [-st sched_type]
[-sl sched_label] [-L output_file [-en]] [-shost source_host] [-policy
name] [-s date] [-e date] [-pt policy_type] [-hoursago hours] [[-cn
copy_number] | [-primary]] [-M master_server] [-altreadhost hostname]
[-backupid backup_id] [-id media_id] [-rl
retention_level[,rl-copy2,...]] [-fail_on_error 0|1[,...,0|1]] [-mpx]
[-priority number] [-set_primary copy_index] [-bc_only]
[-granular_proxy hostname] [-owner
media_share_group[,share_group_copy2,...]]
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

DESCRIPTION
The bpduplicate command allows a copy of a backup to be created. The
bpduplicate command can also change the primary copy to enable restoring from
a duplicated backup. The primary copy is used to satisfy restore requests and is
initially the original copy.
Multiplexed duplications can be created by using the -mpx option. Refer to the
discussion of the -mpx option for more information.
The duplicated backup has a separate expiration date from the original. Initially,
the expiration date of the copy is set to the expiration date of the original. You
can change the expiration date of the copy or the original by using the bpexpdate
command.
Use bpduplicate to create up to 10 copies of unexpired backups.
 NetBackup Commands 111
bpduplicate

OPTIONS
-altreadhost hostname
Specify an alternate host from which to read the media. The default condition
is that bpduplicate reads the source media from the host that performed
the backup.
-backupid backup_id
Specifies the backup ID of a single backup to duplicate or for which to change
the primary copy.
-bc_only

-Bidfile file_name
file_name specifies a file that contains a list of backup IDs to be duplicated.
List one backup ID per line in the file. If this parameter is specified, other
selection criteria are ignored.
Also, file_name is removed during the execution of that command line
interface (CLI) because the NetBackup GUIs commonly use this parameter.
They expect the command-line interface to remove the temporary file that
was used for the -Bidfile option upon completion. Direct command-line
interface users can also use the option; however, it removes the file.
-client name
Specifies the name of the client that produced the originals and is used as
search criteria for backups to duplicate. The default is all clients.
When you specify -client with the -npc option to change the primary copy,
NetBackup first searches for the backup ID that belongs to the client. This
search is useful if the client name has changed.
-cn copy_number|-primary
Determines the copy number to duplicate. Valid values are 1 through 10. The
default is 1.
-primary means to search or duplicate the primary copy.

-dp destination_volume_pool_name [,copy2,...]

Specifies the volume pool for the duplicates. NetBackup does not verify that
the media ID that is selected for the duplicate copy is not the same media ID
where the original resides. Therefore, to avoid the possibility of a deadlock,
specify a different volume pool than where the original media ID resides. The
default pool name is NB_duplicates.
Specify a pool for each copy that you specify.
112 NetBackup Commands
bpduplicate

-dstunit destination_storage_unit_label [,copy2,...]

Specifies the destination storage unit. This parameter is required to duplicate
backups. Do not specify this option to preview backups to be duplicated (-p,
-pb, -PM, or -PD options) or to change the primary copy (-npc option). This
option does not have a default.
Specify a storage unit for each copy that you specify.
-e date, -s date
Specifies the end (-e) or start (-s) of the range of dates and times that include
all backups to duplicate. The default end date is the current date and time.
The default start time is 24 hours before the current date and time.
The required date and time values format in NetBackup commands varies
according to your locale. The /user/openv/msg/.conf file (UNIX and Linux)
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.
More information is available about the locale of your system.
See the "Specifying the locale of the NetBackup installation" topic in the
NetBackup Administrator's Guide, Volume II.
-fail_on_error 0|1[,0|1,...,0|1]
Specifies whether to fail the other duplications if the copy fails, where:
0 - Do not fail the other copies
1 - Fail the other copies
Specify one for each copy that you specify.
-granular_proxy

-hoursago hours
Specifies the number of hours before the current time to search for backups.
Do not use with the -s option. The default is the previous midnight.
-id media_id
Search the image catalog for backups to duplicate that are on this media ID.
If the original is fragmented between different media IDs, NetBackup
duplicates only the backups that exist on the specified media ID. Backups
that span media are duplicated, but not any other backups on the spanned
media ID.
 NetBackup Commands 113
bpduplicate

-L output_file [-en]
Specifies the name of a file in which to write progress information. The default
is not to use a progress file.
Include the -en option to generate a log in English. The name of the log
contains the string _en. This option is useful to support the personnel that
assist in a distributed environment where different locales may create logs
of various languages.
-local
When bpduplicate runs from a host other than the master server and -local
is not used (default), the following occurs: It starts a remote copy of the
command on the master server. The remote copy allows the command to be
terminated from the Activity Monitor.
Use this option to prevent the creation of a remote copy on the master server.
You can also run bpduplicate only from the host where it was initiated.
If the -local option is used, bpduplicate cannot be canceled from the Activity
Monitor.
-M master_server
Specifies the master server that manages the media catalog that has the
media ID. If this option is not specified, the default is one of the following:
The NetBackup server supports only one server (the master) with no remote
media servers. Therefore, the default in this case is always the NetBackup
server master where you run the command.
On the NetBackup Enterprise Server, if the command is run on a master
server, then that server is the default. If the command is run on a media server
that is not the master, then the master for that media server is the default.
-mpx
Specifies that when you duplicate multiplexed backups, NetBackup creates
multiplexed backups on the destination media, which reduces the time to
duplicate multiplexed backups.
Multiplexed duplication is not supported for the following operations:
■ Non-multiplexed backups
■ Backups from disk type storage units
■ Backups to disk type storage units
■ FlashBackup or NDMP backups
114 NetBackup Commands
bpduplicate

If backups in the previous categories are encountered during duplication,

NetBackup duplicates them first and uses non-multiplexed duplication. It
then duplicates the multiplexed backups by using multiplexed duplication.
If all the backups in a multiplexed group are not duplicated, the duplicated
multiplexed group has a different fragment layout. (A multiplexed group is
a set of backups that are multiplexed together during a single multiplexing
session.)
If this option is not specified, all backups are duplicated by using
non-multiplexed duplication.
For more information on multiplex operations, see the NetBackup
Administrator’s Guide.
-npc new_primary_copy
Allows the primary copy to be changed. The value can be 1 through 10. The
-backupid option must be specified with this option.

-number_copies number
Specifies the number of copies to be created. Without the Inline Tape Copy
option or NetBackup Vault extension that is installed, the value can be set to
1 only. The default is 1.
Use with -dstunit, -dp, -fail_on_error, and -r1:

-number_copies 2 -dstunit stunit-copy1,stunit-copy2

-number_copies 2 -dp pool1, pool2

-owner media_share_group [,share_group_copy2,...]

Specifies the share group for the duplicate. Specify a share group for each
copy that you specify.
-p
Previews backups to be duplicated according the option settings, but does
not perform the duplication. Displays the media IDs, server name, backups
that are not candidates for duplication (and why), and information about the
backups to be duplicated.
-pb
Previews the duplication but does not perform the duplication. Similar to the
-p option, but does not display information about the backups.

-PD
Same as the -PM option, except that it sorts and displays the backups by date
and time (newest to oldest).
 NetBackup Commands 115
bpduplicate

-PM
Displays the information on the backups to be duplicated according to the
option settings, but does not perform the duplication. This format first
displays the backup IDs that cannot be duplicated and the reason why (for
example, the backup already has two copies). It displays the following
information about the backup: Date and time of the backup, policy, schedule,
backup ID, host, media ID or path, copy number, and whether the copy is the
primary copy:
1 = Primary copy
0 = Not primary copy
-policy name
Searches for backups to duplicate in the specified policy. The default is all
policies.
-priority number
Sets a backup policy to run at a lesser or a higher priority than disk staging
duplication.
-pt policy_type
Search for the backups that the specified policy type created. The default is
any policy type.
Valid values are:

Informix-On-BAR Oracle
Macintosh
MS-Exchange-Server
MS-Windows
MS-SharePoint
MS-SQL-Server
NDMP
Netware
OS/2
Standard
Sybase

Note: The following policy types apply only to NetBackup Enterprise Server.

AFS
DataTools-SQL-BackTrack
DB2
Enterprise-Vault
FlashBackup
116 NetBackup Commands
bpduplicate

SAP
Split-Mirror

-rl retention_level[,rl-copy2,...]
Provides a retention level for each copy that you specify.
If no retention levels are specified, the expiration date of the original copy is
used for each copy. If a retention period is indicated, the expiration date for
the copy is the backup date plus the retention period.
For example, if a backup was created on May 14, 2007, and its retention period
is one week, the new copy’s expiration date is May 21, 2007.
A value of -1 indicates that the original expiration date is used for the copy.
-set_primary copy_index
Specify a new copy to become the primary copy.
copy_index is one of the following:
0 = Do not change the primary copy (default)

1 = First new copy is the primary copy

2 = Second new copy is the primary copy

3 = Third new copy is the primary copy, and so on.

copy_index cannot be greater than the -number_copies value.

If the copy specified to be the primary copy fails, but other copies are
successful, the primary copy does not change from its current value.
-shost source_host
Specifies that only the backups that are created on the specified backup server
are considered for duplication. The default is to consider all backups regardless
of the backup server.
-sl sched_label
Search for backups to duplicate that the specified schedule created. The
default is all schedules.
-st sched_type
Search for backups to duplicate that the specified schedule type created. The
default is any schedule type.
Valid values are:
FULL (full backup)

INCR (differential-incremental backup)

 NetBackup Commands 117
bpduplicate

CINC (cumulative-incremental backup)

UBAK (user backup)

UARC (user archive)

NOT_ARCHIVE (all backups except user archive)

-v
Selects the verbose mode. When you specify the debug logs or progress logs,
it includes more information.

EXAMPLES
EXAMPLE 1
The following command (all on one line) lists backups with a copy number of 1.
They were backed up by the policy that is named stdpol, and created between
July 1, 2009, and August 1, 2009.

# bpduplicate -PM -cn 1 -policy stdpol -s 07/01/09 -e 08/01/09

EXAMPLE 2
The following command creates a duplicate copy of the backup IDs in file name
plum. It duplicates copy 1 to copy 5 on storage unit Tape_stu of pool NBU.

# bpduplicate -Bidfile plum dstunit Tape_stu -dp NBU -cn 1 -dcn 5

EXAMPLE 3
The following command can be all on one line, or you can use a backslash
continuation character. The command duplicates copy 1 of the backups that are
listed in file bidfile in the tmp directory. The destination storage unit is unit1
and the destination pool is dup_pool. Progress information is written to bpdup.ls.

On UNIX and Linux systems: bpduplicate -dstunit unit1 -Bidfile

/tmp/bidfile -L /tmp/bpdup.ls -dp dup_pool -cn 1

On Windows systems: bpduplicate -dstunit unit1 -Bidfile

C:\tmp\bidfile -L C:\tmp\bpdup.ls -dp dup_pool -cn 1

EXAMPLE 4
The following command can be all on one line, or you can use a backslash
continuation character. It is the same as the previous example, except multiplexed
backups are duplicated when you select multiplexed duplication.

On UNIX and Linux systems: bpduplicate -dstunit unit1 -Bidfile

/tmp/bidfile -mpx -L /tmp/bpdup.ls -dp dup_pool -cn 1
118 NetBackup Commands
bpduplicate

On Windows systems: bpduplicate -dstunit unit1 -Bidfile

C:\tmp\bidfile -mpx -L C:\tmp\bpdup.ls -dp dup_pool -cn 1

FILES
UNIX and Linux systems:

/usr/openv/netbackup/logs/admin/*
/usr/openv/netbackup/db/images/*

Windows systems:

install_path\NetBackup\db\images\*
install_path\NetBackup\logs\admin\*
 NetBackup Commands 119
bperror

bperror
bperror – display NetBackup status and troubleshooting information or entries
from NetBackup error catalog

SYNOPSIS
<admin_dir_path>bperror {-S | -statuscode status_code} [-r |
-recommendation] [[-p Unx | NTx] | [-platform Unx | NTx]] [-v]
<admin_dir_path>bperror [-all | -problems | -media | tape] {-backstat
[-by_statcode]} [-L | -l | -U] [-columns ncols] [-d date | -hoursago
hours] [-e date] [-client client_name] [-server server_name] [-jobid
job_id] [-M master_server,...] [-v]
<admin_dir_path>bperror [-s {severity[+]}|severity ...] [-t type ...]
[-dt disk_type] [-L | -l | -U] [-columns ncols] [-d date | -hoursago
hours] [-e date] [-client client_name] [-server server_name] [-jobid
job_id] [-M master_server,...] [-v]
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

DESCRIPTION
bperror displays information from either the same source as the online
troubleshooter (in the Activity Monitor or Reports applications) or from the
NetBackup error catalog. bperror provides the following types of displays:
■ A display of the message that corresponds to a status code and, optionally, a
recommendation on how to troubleshoot the problem. In this case, the display
results come from the same source as the online troubleshooter for the local
system.
■ A display of the error catalog entries that satisfy the command-line options.
For instance, bperror can display all the problem entries for the previous day.
■ A display of the error catalog entries that correspond to a particular message
severity and message type.
For information on details of the displays, see DISPLAY FORMATS later in this
command description.
bperror writes its debug log information to the following directory:

On Windows systems: install_path\NetBackup\logs\admin

120 NetBackup Commands
bperror

On UNIX and Linux systems: /usr/openv/netbackup/logs/admin

You can use the information in this directory for troubleshooting.
The output of bperror goes to standard output.

OPTIONS
-all, -backstat [-by_statcode], -media, -problems
These options specify the type and severity of log messages to display. The
default type is ALL. The default severity is ALL.
-all: The type is ALL, and severity is ALL. Run bperror with this option and
with -U to produce an All Log Entries report.
-backstat: The type is BACKSTAT, and severity is ALL. If -by_statcode is
present, the display contains one entry for each unique status code. Line 1
of the entry contains the status code and the corresponding message text.
Line 2 of the entry contains the list of clients for which this status code
occurred. -by_statcode is only valid when the command line contains both
-backstat and -U. Run bperror with this option and with -U to produce a
Backup Status report.
-media: The type is MEDIADEV, and severity is ALL. Run bperror with this
option and with -U produces a Media Logs report.
-problems: The type is ALL, and severity is the union of WARNING, ERROR,
and CRITICAL. Run bperror with this option and with -U to produce a
Problems report.
-client client_name
Specifies the name of a NetBackup client. This name must be as it appears in
the NetBackup catalog. By default, bperror searches for all clients.
-columns ncols
For the -L and -U reports, -columns provides an approximate upper bound
on the maximum line length. bperror does not try to produce lines exactly
ncols characters in length.
-columns does not apply to the -l report.

ncols must be at least 40. The default is 80.

-d date, -e date
Specifies the start date and end date range for the listing.
-d specifies a start date and time (optional) for the listing. The resulting list
shows only images in the backups or archives that occurred at or after the
 NetBackup Commands 121
bperror

specified date-time. The valid range of dates is from 01/01/1970 00:00:00 to

01/19/2038 03:14:07. The default is 24 hours before the current date and
time.
-e specifies an end date and time (optional) for the listing. The resulting list
shows only files from backups or the archives that occurred at or before the
specified date and time. Use the same format for the start date. The default
is the current date and time. The end date must be greater than or equal to
the start date.
The required date and time values format in NetBackup commands varies
according to your locale. The /user/openv/msg/.conf file (UNIX and Linux)
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.
More information is available about the locale of your system.
See the "Specifying the locale of the NetBackup installation" topic in the
NetBackup Administrator's Guide, Volume II.
The following is a typical format for the -d and -e options:

[-d mm/dd/yyyy hh:mm:ss | -hoursago hours]

[-e mm/dd/yyyy hh:mm:ss]

-dt disk_type
Enables the user to specify a disk type. The following are the valid values for
disk_type:
0 - All
1 - BasicDisk
2 - NearStore
3 - SnapVault
6 - DiskPool
-hoursago hours
Specifies a start time of many hours ago, which is equivalent to specifying a
start time (-d) of the current time minus hours. Hours is an integer. The
default is 24, which is a start time of 24 hours before the current time.
-jobid job_id
Specifies a NetBackup job ID. By default, bperror searches for all job IDs.
122 NetBackup Commands
bperror

-L
Reports in long format.
-l
Reports in short format. This report produces a terse listing. This option is
useful for scripts or the programs that rework the listing contents into a
customized report format. This option is the default list type.
-M master_server,...
Specifies a comma-separated list of one or more hostnames. The command
is run on each of the master servers in this list. The master servers must allow
access by the system that issues the command. If an error occurs for any
master server, the process stops at that point in the list. The default is the
master server for the system where the command is entered.
-p Unx | NTx, -platform Unx | NTx
Displays the message that applies to the platform (UNIX or Windows) for the
specified status code. The default is to display the message for the platform
on which bperror is running. The -S or -statuscode option must be specified
when you use this option.
-r | -recommendation
Displays the recommended action for the specified status code from the
troubleshooting guide. The default is not to display the recommendation.
The -S or -statuscode option must be specified when you use this option.
-S status_code, -statuscode status_code
Displays the message that corresponds to the status code. This option has no
default condition.
-s severity, -s severity+
Specifies the severity of log messages to display. The defined values are ALL,
DEBUG, INFO, WARNING, ERROR, and CRITICAL.

You can specify severity in two ways. The first way is a list of one or more
severity values. For instance, "-s INFO ERROR" displays the messages with
either severity INFO or severity ERROR. The delimiter must be a blank (" ")
between the elements in the list . The second way is a single severity value
with "+" appended, which is this severity or greater. For instance "-s
WARNING+" displays the messages with severity values WARNING, ERROR, and
CRITICAL.

The default is ALL. The severity value can be in uppercase or lowercase.

 NetBackup Commands 123
bperror

-server server_name
Specifies the name of a NetBackup server. This name must be as it appears
in the NetBackup catalog. The display is limited to the messages that are
logged for this server, which also satisfies the criteria for any other bperror
options. For example, if -server plim and -hoursago 2 are bperror options,
the display contains the messages that were logged for plim in the past two
hours.
The server name must match the server name that was recorded in the log
messages. For example, if the logs record the server name as plim.null.com,
-server plim does not display the logs, but -server plim.null.com does.

The query goes to the error catalog which resides on either the local master
server or the master server that -M specifies. The master server must allow
access by the system that runs bperror.
The default is to display log messages for all media servers that are known
to the master server(s).
-t type
Specifies the type of log messages to display. The defined values are ALL,
BACKSTAT, MEDIADEV, GENERAL, BACKUP, ARCHIVE, RETRIEVE, and SECURITY. The
default is ALL. The type value can be upper or lower case. It is entered as a
list of one or more values. For instance, -t BACKSTAT MEDIADEV displays the
messages with either type BACKSTAT or type MEDIADEV. The delimiter between
the list elements must be a blank (" ").
-U
Reports in user format. NetBackup report-generating tools such as the
NetBackup-Java Reports application uses this report.
-v
Verbose mode. This option causes bperror to log additional information for
the debugging purposes that go into the NetBackup-administration daily
debug log. -v is meaningful only when NetBackup has debug logs enabled
(install_path\NetBackup\logs\admin/usr/openv/netbackup/logs/admin
directory defined). The default is to not be verbose.

DISPLAY FORMATS
The following are display formats of the bperror command:
■ Status code display (for example, bperror -S status_code):
124 NetBackup Commands
bperror

bperror queries the NetBackup online troubleshooter on the local system for
the message that corresponds to the status code. bperror displays the message
text on one line and an explanation on a second line.
If -r is an option, bperror also queries for the troubleshooting recommendation
that corresponds to the status code. bperror displays the recommendation
following the status message, on one or more lines.
■ Error catalog display (for example, bperror -all; bperror -s severity):
bperror queries the NetBackup error catalog on either the local master server
or the master servers in the -M option list. The display consists of the results
that are returned from querying the error catalog on the master server(s). The
results are limited to catalog the entries that satisfy all the bperror options.
For example, the bperror command line may contain options for client, start
time, and end time. If so, then bperror reports only the jobs that are run for
that client between the start time and end time.
The display variant that shows individual message entries from the error
catalog can appear in long (-L), user (-U), or short (-l) format. The display
variant that categorizes by status code can appear in user (-U) format only.
The following is the display content for each of these formats:
■ Error catalog display, individual message entries, long format (for example,
bperror -media -L). This report produces several lines per log entry, with
the following contents:
Line 1: Date and time
V:NetBackup version
S:Server
C:Client
J:Job ID
(U:Job group ID and an unused field.) If a policy is multistream enabled, the
job group ID is the job ID of the first job that spawned a collection of
multistreaming backups. If multistreaming is disabled for the policy, the job
group ID is always zero.
Line 2: Severity (severity name and severity code in hexadecimal)
Type (type name and type code in hexadecimal)
Who (name of the entity that added the log entry)
Line 3: Text (at the start of the log message text, continued on subsequent
lines if necessary)
■ Error catalog display, individual message entries, user format (for example,
bperror -media -U). The user format produces a header line that shows
column names, and one or more lines per log entry with these contents:
Line 1: Date and time
Server
 NetBackup Commands 125
bperror

Client
Text (at the start of the log message, continued on subsequent lines if needed)
■ Error catalog display, individual message entries, short format (for example,
bperror -media -l). The short format produces a single line per log entry,
with the following contents:
Line 1: Time (internal system representation)
NetBackup version
Type code (decimal)
Severity code (decimal)
Server
Job ID
Job Group ID
An unused field
Client
Who
Text (the entire log message text, with no truncation of the line length)
■ Error catalog display that the status code categorizes. This display reports
only each unique status code, instead of listing every log entry for that status
code (for example, bperror -backstat -by_statcode -U). This option
produces two or more lines per status code, with the following contents:
Line 1: Status code
Text (the beginning of the log message text, continued on subsequent lines if
necessary)
Line 2: The list of clients for which this status occurred.

EXAMPLES
EXAMPLE 1
Here bperror displays the error for a job that failed because the NetBackup
encryption package was not installed. Status code 9 is the NetBackup status code
for this failure. The second run of bperror displays the action that is recommended
for NetBackup status code 9.

# bperror -d 12/23/2007 16:00:00 -e 12/23/2007 17:00:00 -t backstat

-U
STATUS CLIENT POLICY SCHED SERVER TIME COMPLETED
9 plim dhcrypt user plim 12/23/2007 16:38:09
an extension package is needed, but was not installed
# bperror -S 9 -r
an extension package is needed, but was not installed
A NetBackup extension product is required in order to perform the
126 NetBackup Commands
bperror

requested operation.
Install the required extension product.

EXAMPLE 2
bperror reports the problems in the User format that have occurred in the previous
24 hours.

# bperror -U -problems
TIME SERVER CLIENT - TEXT
11/23/2007 16:07:39 raisins - no storage units configured
11/23/2007 16:07:39 raisins - scheduler exiting - failed reading
storage unit database information (217)
11/23/2007 16:17:38 raisins - no storage units configured
11/23/2007 16:17:38 raisins - scheduler exiting - failed reading
storage unit database information (217)
11/23/2007 18:11:03 raisins nut bpcd on nut exited with status 59:
access to the client was not allowed
11/23/2007? 18:11:20 raisins - WARNING: NetBackup database backup is
currently disabled

EXAMPLE 3
The following example displays status for type backstat for the jobs that are run
in the previous 24 hours. The option -by_statcode produces a display that is
organized by status code.
The display shows that one or more jobs for each of the clients chive, gava, and
raisins have completed successfully (the status code is 0). In addition, one or
more jobs for client nut have failed because nut did not allow access by the master
server or media server. (The status code is 59.)

# bperror -U -backstat -by_statcode

0 the requested operation was successfully completed
chive gava raisins
59 access to the client was not allowed
nut

EXAMPLE 4
This example identifies and retrieves the results for a particular user job. It first
lists the log entries with job Ids other than zero. It then runs a User-format report
on the job of interest.

# bperror -hoursago 2007 -L | grep 'S:' | egrep 'J\:[1-9]'

12/21/2007 17:24:14 V1 S:plim C:plim J:1 (U:0,0)
12/23/2007 16:31:04 V1 S:plim C:plim J:1 (U:0,0)
 NetBackup Commands 127
bperror

12/23/2007 16:38:04 V1 S:plim C:plim J:3 (U:0,0)

# bperror -d 1/7/2007 -jobid 34 -U
TIME SERVER CLIENT - TEXT
01/07/2007 13:12:31 plim plim started backup job for client plim,
policy jdhcrypt, schedule user on storage unit jdhcrypt
01/07/2007 13:12:40 plim plim successfully wrote backup id
plim_0947272350,copy 1, fragment 1, 32 Kbytes at 11.057 Kbytes/sec
01/07/2007 13:12:41 plim plim CLIENT plim POLICY jdhcrypt SCHED user
EXIT STATUS 0 (the requested operation was successfully completed)

EXAMPLE 5
This example shows media entries in the error catalog for the past 2000 hours.

bperror -hoursago 2000 -media -U

TTIME SERVER CLIENT - TEXT
12/23/2007 16:31:04 plim plim Media Manager terminated during mount
of media id A00000, possible media mount timeout
12/24/2007 04:31:20 plim - media id A00000 removed from Media
Manager database (manual deassign)

EXAMPLE 6
This example reports and adds up the total number of bytes backed up in the past
24 hours.

bperror -all -hoursago 24 | grep "successfully wrote backup id | awk

'{bytes= bytes + $20} END {print "backed up",bytes," Kbytes of
data"}'
backed up 64 Kbytes of data
up",bytes," Kbytes of data"}'
128 NetBackup Commands
bpexpdate

bpexpdate
bpexpdate – change expiration date of backups in image catalog and media in
media catalog

SYNOPSIS
<admin_dir_path>bpexpdate -m media_id -d date | 0 | infinity [-host
name] [-force] [-nodelete] [-notimmediate] [-M master_server,...]
<admin_dir_path>bpexpdate -deassignempty [-m media_id] [-force] [-M
master_server,...]
<admin_dir_path>bpexpdate -backupid backup_id -d date | 0 | infinity
[-client name] [-copy number] [-force] [-nodelete] [-notimmediate]
[-M master_server,...]
<admin_dir_path>bpexpdate -recalculate [-backupid backup_id] [-copy
number] [-d date | 0 | infinity] [-client name] [-policy name] [-ret
retention_level] [-sched type] [-M master_server,...]
<admin_dir_path>bpexpdate -stype server_type [-dp disk_pool_name [-dv
disk_volume]] [-nodelete] [-notimmediate] [-M master_server,...]
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

DESCRIPTION
NetBackup maintains catalogs, which are internal databases with backup image
and media information. The image record in the image catalog contains an
expiration date. The media ID in the media catalog also contains an expiration
date. The expiration date is the date and time when NetBackup removes the record
for a backup or a media ID from the corresponding catalog.
The bpexpdate command allows the expiration date and time of backups to be
changed in the NetBackup image catalog. The command is also used to change
the expiration of removable media in the NetBackup media catalog. If the date is
set to zero, bpexpdate immediately expires backups from the image catalog or
media from the media catalog. When a media ID is removed from the NetBackup
media catalog, it is also removed from the Enterprise Media Manager Database.
It is removed regardless of the media’s previous state (FROZEN, SUSPENDED,
and so on).
You can change the expiration on a media ID basis or on an individual backup ID
basis. When you change the expiration date of a media ID, the expiration date of
 NetBackup Commands 129
bpexpdate

all backups on the media are also changed. bpexpdate also provides the following
options:
■ Remove media from the media catalog if they no longer contain valid backups.
■ Recalculate the expiration date to base it on the configured or a supplied
retention level.
Any authorized user can run this command.
For more information about NetBackup authorization, refer to the NetBackup
Security and Encryption Guide.

OPTIONS
The different formats of the command are as follows:
-backupid
Changes the expiration of a single backup. If the date is zero, the backup is
removed from the image catalog. If the backup is on removable media and
the -d expiration is greater than the current media ID expiration, the media
catalog expiration also changes. The change affects all copies of a backup,
unless the -copy option is used. The -copy option causes only the specified
copy to be affected.
-deassignempty
Searches the catalog for the removable media that no longer contain valid
backups. It removes the media from the media catalog and removes the media
IDs in the Media Manager catalog. The media is then available to use again.
You can use the NetBackup Images on Media report to determine if the
assigned media no longer contain valid backups.
-m
Changes the expiration date or removes the media ID from the media catalog
and associated backups from the NetBackup catalog. A separate expiration
date is maintained in the image catalog for each copy of a backup. When this
format is used, only the expiration of the copy on the media is affected. If you
remove the media ID from the media catalog by specifying a zero date, you
also remove it in the Enterprise Media Manager Database.
-recalculate
Allows the expiration date of backups to be changed based on the specified
retention level, or you can specify a new expiration date. When the expiration
changes according to retention level, the new date is based on the creation
date of the backup plus the retention level value. The expiration can be
changed for a single backup, or for all backups for a particular client, policy,
or schedule type.
130 NetBackup Commands
bpexpdate

If the backup is on removable media, the expiration in the media catalog

changes if the command expiration is greater than the current expiration.
-stype server_type
A string that identifies the storage server type. Possible values are
AdvancedDisk, OpenStorage (vendorname), and PureDisk.

OPTIONS
-client name
Specifies the client name for the -backupid and -recalculate operations.
For the backupid operation, this option causes NetBackup to first search for
the backup ID for the specified client. This option is useful if the client name
has changed.
For recalculate, this option causes NetBackup to recalculate the expiration
date to be based on the retention level for all the specified client backups.
-copy number
Expires or changes the expiration date of the specified copy number and is
valid only with the -backupid and -recalculate options. Valid values are 1
through 10.
If the primary copy is expired, the other copy becomes the primary copy. If
this option is not specified, the expiration affects both copies of the backup.
-d date

Specifies the expiration date and time. date can be any one of the following:
■ mm/dd/yy hh:mm:ss
■ 0 - the backup or media expires immediately

■ infinity - the backup never expires

The required date and time values format in NetBackup commands varies
according to your locale. The /user/openv/msg/.conf file (UNIX and Linux)
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.
More information is available about the locale of your system.
See the "Specifying the locale of the NetBackup installation" topic in the
NetBackup Administrator's Guide, Volume II.
 NetBackup Commands 131
bpexpdate

-deassignempty
Expires the removable media from the media catalog when that media no
longer contain valid backups. It also deassigns the media ID in the Media
Manager catalog.
-dp disk_pool_name -dv disk_volume
Specifies the disk pool and, optionally, the disk volume for the expiration
date operation to be performed.
-force
Before you run the specified operation, bpexpdate queries before it starts the
operation. This option forces the bpexpdate command to carry out the
operation without querying the user.
-host name

Note: For the NetBackup server, this option is not required because only one
server (the master) exists. If you do use the option, specify the host name of
that server.

Specifies the host name of the server to which the media is assigned. This
option should be used only with the -m media_id option, and then only if the
following is true: The master has remote media servers and the volume was
not written on the server where you run bpexpdate.
For example, assume that you have a master server named whale and a media
server named eel. You run the following command on whale to remove media
ID BU0001 manually from the media catalog and all corresponding backups
from the image catalog:

bpexpdate -m BU0001 -d 0 -host eel

You can use the NetBackup Media List report to determine which server’s
media catalog has the volume.
-m media_id
Specifies the media ID that the expiration date change affects. The expiration
dates of the backups on the media ID also change. The -d option must be
included with this option.
This option can also be used when the -deassignempty option is specified to
check if valid backups exist on this particular media ID. In this case, do not
include the -d option.
The media ID must be six or fewer characters and must be in the NetBackup
media catalog.
132 NetBackup Commands
bpexpdate

-M master_server [,...]
Specifies the master server that manages the media catalog that has the
media ID. If this option is not specified, the default is one of the following:
For NetBackup server :
NetBackup server supports only one server (the master) with no remote media
servers. Therefore, the default in this case is always the master server where
you run the command.
For NetBackup Enterprise Server:
If the command is run on a master server, then that server is the default. If
the command is run on a media server that is not the master, then the master
for that media server is the default.
-nodelete
Deletes the backup from the image catalog but does not delete it from the
disk storage. Use this option when you unimport a disk group from one master
server and import the disk group to a different master server.
-notimmediate
Inhibits the call that bpexpdate makes to the nbdelete command after it
expires an image on disk. If you intend to delete many images at the same
time, use -notimmediate to avoid the overhead of multiple job creation for
nbdelete to process. You can then run the nbdelete command later.

-policy name
Specifies the policy name and is valid with the -recalculate option. When
the policy name is specified, the expiration is recalculated based on the
retention level for all backups that are created in this policy.
-recalculate
Recalculates the expiration of backups that are based on the retention level
or you can specify a new expiration date. You can include other options to
change the expiration for a single backup, or for the following: All backups
for a specific client name, policy name, or schedule type. Either the -d or -ret
option must be specified with this option.
-ret retention_level
Specifies the retention level to use when you recalculate expiration dates and
is valid with the -recalculate option. Levels range from 0 to 24. The new
expiration date is the backup’s creation date plus this retention level. You
must specify either -backupid or -policy with this option.
-sched type
Specifies the schedule type and is valid with the -recalculate option. When
the type is specified, the expiration is recalculated based on the retention
 NetBackup Commands 133
bpexpdate

level for all backups that are created with this schedule type. Enter a numeric
value for type as follows:
0 = Full

1 = Differential Incremental

2 = User Backup

3 = User Archive

4 = Cumulative Incremental

The -policy option must be specified with -sched.

NOTES
Some options in large environments can take a significant amount of time to
complete. Changes that cause backups or media to expire are irrevocable. You
may be required to import backups or recover previous versions of the catalogs
if you make mistakes by using this command.

EXAMPLES
EXAMPLE 1
The following command, run on the master server, removes media ID BU0002
from the media catalog. It deassigns the media ID in the Media Manager catalog.
It also expires associated image records in the image catalog.

# bpexpdate -m BU0002 -d 0

EXAMPLE 2
The following command changes the expiration of copy 2 of backupid
eel_0904219764. It does not affect the expiration of copy 1 of the backup.

# bpexpdate -backupid eel_0904219764 -d 12/20/2007 08:00:00 -copy 2

EXAMPLE 3
The following command removes the backup from the image catalog. Since the
-copy option is not specified, all copies are removed.

# bpexpdate -backupid eel_0904219764 -d 0

EXAMPLE 4
134 NetBackup Commands
bpexpdate

The following command checks for media in the host cat’s media catalog that is
still assigned, but no longer contain valid backups. The command removes any
such media from the catalog and deassigns them in the Media Manager catalog.

# bpexpdate -deassignempty -host cat

EXAMPLE 5
The following command recalculates the expiration date of backup ID 1234 to the
date 10/31/2009.

# bpexpdate -recalculate -backupid 1234 -d 10/31/09

EXAMPLE 6
The following command recalculates the expiration date of backup ID 1234 based
on a retention level. The new retention level is 4 which is two months (default
value). Backup ID 1234 is now scheduled to expire in 2 months.

# bpexpdate -recalculate -backupid 1234 -ret 4

FILES
UNIX and Linux systems:

/usr/openv/netbackup/logs/admin/*
/usr/openv/netbackup/db/media/*
/usr/openv/netbackup/db/images/*

Windows systems:

install_path\NetBackup\logs\admin\*
install_path\NetBackup\db\media\*
nstall_path\NetBackup\db\images\*
 NetBackup Commands 135
bpfis

bpfis
bpfis – create or delete a snapshot, or return information about existing snapshots

SYNOPSIS
<nbu_dir_path>bpfis create [-rhost host] [-id id] [-v] [-V] [-owner
owner] -fim fim_name[:option=value,option=value,...] [-pt policy_type]
file1 [file2...]
<nbu_dir_path>bpfis delete [-force] -id id
<nbu_dir_path>bpfis deletedb -id id
<nbu_dir_path>bpfis query [-id id]
<nbu_dir_path>bpfis verify [create_options]
On UNIX and Linux systems, <nbu_dir_path> is /usr/openv/netbackup/bin/
On Windows systems, <nbu_dir_path> is <install_path>\NetBackup\bin\

DESCRIPTION
The bpfis command can create, delete, or query snapshots of a client system (file
system or volume).

Note: To store the image on tape or other media requires that you run a separate
backup job.

For more detailed examples and procedures for using bpfis, refer to the NetBackup
Snapshot Client Administrator’s Guide.
You must have administrator privileges to run this command.

OPTIONS
The bpfis command allows the following operations:
create
Creates a snapshot with the specified snapshot method.
delete
Deletes the snapshot that -id identifies.
deletedb
Deletes from the snapshot database the snapshot entry that -id identifies.
136 NetBackup Commands
bpfis

query
Retrieve detailed information on the specified snapshot of a client system.
verify
Verify that the snapshot that create_options describes is able to be created.
The following are the other options for the bpfis command:
-rhost
The remote host or alternate client on which the snapshot is made accessible.
The default is the local host.
On UNIX and Linux systems, the -rhost option can be used with the
FlashSnap, VVR, TimeFinder, BusinessCopy, and ShadowImage methods only.
On Windows systems, the -rhost option can be used with the FlashSnap
method only.
-id
For bpfis create, this option is a user-defined snapshot identifier. The
default ID is a timestamp that shows when the image was created.
For bpfis delete, this option designates the ID of the snapshot to be deleted.
For bpfis query, this option designates the ID of the snapshot for which to
return information.
-v -V
Indicates the verbosity levels in the log files. -V is a higher level of verbosity
than -v. Default is non-verbose.
-owner owner
Specifies the owner of this snapshot (default is GENERIC).
-fim fim_name[:option=value,option=value, ...]
Specifies the snapshot method to use to create the image. Select the method
by using the type of data and hardware that the client uses.
For details on snapshot methods, refer to the NetBackup Snapshot Client
Administrator’s Guide.
The available options depend on the snapshot method. For a list of snapshot
methods and their options, refer to the <opt_params> area of each snapshot
method (FIM) listed in the vfm.conf file.
For example, under the BusinessCopy snapshot method, the first optional
parameter is listed as follows:

keep_fi=%b[0]#Keep frozen image after backup

 NetBackup Commands 137
bpfis

Where keep_fi= is the option, and the value is Boolean (0 for no, 1 for yes).
For an example of the bpfis command that uses the value option, refer to
bpfis in the NetBackup Snapshot Client Administrator’s Guide.

-pt policy_type
Specifies the NetBackup policy type that the snapshot method must support.
file1 file2
Specifies the path of the file system or volume from which the snapshot is to
be made.
-force
Specifies the force delete.

EXAMPLES
EXAMPLE 1
Create a snapshot of /mnt/ufscon on hostB by using the FlashSnap method on a
UNIX or Linux client.

/usr/openv/netbackup/bin/bpfis create -rhost hostB -fim FlashSnap

/mnt/ufscon

Sample output:

INF - BACKUP START 26808

INF - FIS_ID=1034037338
INF - REMAP FILE BACKUP /mnt/ufscon USING
/tmp/_vrts_frzn_img_26808/mnt/ufscon
OPTIONS:ALT_PATH_PREFIX=/tmp/_vrts_frzn_img_26808,FITYPE
=MIRROR,MNTPOINT=/mnt/ufscon,FSTYPE=ufs
=MIRROR,MNTPOINT=E:\,FSTYPE=NTFS
INF - EXIT STATUS 0: the requested operation was successfully
completed

Create a snapshot of E:\ on hostB by using the FlashSnap method on a Windows

client.

install path\bin\bpfis create -rhost hostB -fim FlashSnap E:\

Sample output:

INF - BACKUP START 26808

INF - FIS_ID=1034037338
INF - REMAP FILE BACKUP E: USING <GUID>
138 NetBackup Commands
bpfis

OPTIONS:ALT_PATH_PREFIX=/tmp/_vrts_frzn_img_26808,FITYPE
INF - EXIT STATUS 0: the requested operation was successfully
completed

EXAMPLE 2
To obtain information about a particular snapshot on the local host:

# bpfis query -id 1034037338

Sample output:

INF - BACKUP START 26838

INF - Frozen image host : ricochet
INF - Frozen image owner: GENERIC
INF - Time created : Mon Oct 7 19:35:38 2007

INF - REMAP FILE BACKUP /mnt/ufscon USING (UNIX and Linux systems)

INF - REMAP FILE BACKUP E: USING <GUID> (Windows systems)

/tmp/_vrts_frzn_img_26808/mnt/ufscon (UNIX and Linux systems)

OPTIONS:ALT_PATH_PREFIX=/tmp/_vrts_frzn_img_26808,FITYPE=MIRROR,

MNTPOINT=/mnt/ufscon,FSTYPE=ufs (UNIX and Linux systems)

MNTPOINT=E:\,FSTYPE=NTFS (Windows systems)

INF - EXIT STATUS 0: the requested operation was successfully

completed

EXAMPLE 3
To delete a snapshot on the local host:

# bpfis delete -id 1034037338

Sample output:

INF - BACKUP START 26839

INF - EXIT STATUS 0: the requested operation was successfully
completed
 NetBackup Commands 139
bpgetconfig

bpgetconfig
bpgetconfig – helper program to obtain configuration information

SYNOPSIS
<admin_dir_path>bpgetconfig -M master [-x | -X] [config_item ...]
<admin_dir_path>bpgetconfig [-u | -h] [-x | -X] [config_item ...]
<admin_dir_path>bpgetconfig -H config_item
<admin_dir_path>bpgetconfig -g server [-L | -U | -l] [-c] [-A]
<admin_dir_path>bpgetconfig -s server [-L | -U | -l] [-c] [-A]
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

DESCRIPTION
bpgetconfig can be used as a stand-alone program or as a helper program for the
backuptrace and the restoretrace commands to obtain configuration
information. This command is available for all NetBackup server platforms. It
displays the configuration information of a specified server in various formats.
bpgetconfig also retrieves general host information from a specified host server
by using the -g or -s option.
You must have administrator privileges to run this command.

OPTIONS
-A
Displays all available system information. The -A option can be used only
with the -g or -s option.
-c
Displays the ciphers, one per line, that are appended to the -g or -s option
output. The -c option can be used only with the -g or -s option.
-e
Writes the exclude_list from server to filename.
-g server

Selects the host server (server) for which the following general Backup Exec
and NetBackup information appears:
140 NetBackup Commands
bpgetconfig

■ Master or Client
■ NetBackup Client Platform
■ NetBackup Client Protocol Level
■ Product Type (for Backup Exec if installed, else NetBackup)
■ Version Name (for Backup Exec if installed, else NetBackup)
■ Version number (for Backup Exec if installed, else NetBackup)
■ Installed Path for NetBackup Bin (null if Backup Exec is installed)
■ Installed OS for host server
-H config_item
Displays the valid configuration items.
-h
Displays the default local host configuration.
-i
Writes the include_list from server to filename.
-L
Displays a long, user-readable list. The -L option can be used only with the
-g or -s option.

-l
Displays a compact, machine-readable list. The -l option can be used only
with the -g or -s option.
-M master
Specifies the master server (master) whose host configuration appears.
-s server

Selects the host server (server) for which the following general system
information that is NetBackup specific appears:
■ Master or Client
■ NetBackup Client Platform
■ NetBackup Client Protocol Level
■ Product Type (NetBackup)
■ Version Name
■ Version number
■ Installed Path for NetBackup Bin
 NetBackup Commands 141
bpgetconfig

■ Installed OS for host server

-t
Displays the tier information, one item per line, that is appended to the -s
option output. The -t option can be used only with the -g or -s option.
-U
Displays a brief, user-readable list (default). The -U option can be used only
with the -g or -s option.
-u
Displays the current user configuration.
-X
Lists all configuration items by default. The -x and -X options may be
combined with the -M, -h, and -u options. The -x and -X options have no
effect if one or more configuration items are specified on the command line.
If config_item is specified, it appears on the specified configuration items.
-x
Excludes the items not explicitly listed in the configuration.

EXAMPLES
EXAMPLE 1
Retrieve the VERSIONINFO option setting from the bp.conf file.

# bpgetconfig VERSIONINFO
VERSIONINFO = "SunOS" "5.9" "Unknown" "NetBackup" "6.5" 650000

EXAMPLE 2
Retrieve all available system information and display a long, user-readable list.

# bpgetconfig -s hagar -A -L
Client/Master = Master
NetBackup Client Platform = Solaris, Solaris9
NetBackup Client Protocol Level = 6.5.0
Product = NetBackup
Version Name = 6.5
Version Number = 650000
NetBackup Installation Path = /usr/openv/netbackup/bin
Client OS/Release = SunOS 5.9
Cipher =
Patch Level = 6.5
142 NetBackup Commands
bpgetdebuglog

bpgetdebuglog
bpgetdebuglog – Run helper program for backuptrace and restoretrace. Prints
out debug log file. Useful as a stand-alone program.

SYNOPSIS
<admin_dir_path>bpgetdebuglog remote_machine [remote_program mmddyy]
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

DESCRIPTION
If all three arguments are specified, bpgetdebuglog prints the contents of the
specified debug log file to standard output. If only remote_machine is specified,
bpgetdebuglog prints to standard output the number of seconds of clock drift
between the local machine and the remote machine. A positive number means
that the local machine is ahead of the remote machine. A negative number means
that the remote machine is ahead of the local machine.
The bpgetdebuglog command must be in the specified directory (see SYNOPSIS)
for backuptrace and restoretrace to use it.
You must have administrator privileges to run this command.

OPTIONS
remote_machine
Name of the remote server.
remote_program
Name of the debug log directory on the remote server.
mmddyy
The day stamp that is used to identify the log file (log.mmddyy for UNIX and
Linux, mmddyy.log for Windows) to be read.

EXAMPLES
# bpgetdebuglog peony bpcd 071207
# bpgetdebuglog peony
 NetBackup Commands 143
bpimage

bpimage
bpimage – perform functions on stored images in a database

SYNOPSIS
<nbu_dir_path>bpimage -[de]compress [-allclients | -client name]
<nbu_dir_path>bpimage [-M master_server,...,master_server]
<nbu_dir_path>bpimage -npc copy # -backupid backupid [-client name]
<nbu_dir_path>bpimage -newserver newserver_name [-oldserver
oldserver_name] [-id id]
<nbu_dir_path>bpimage -deletecopy # -backupid backupid
<nbu_dir_path>bpimage -testlock # -backupid backupid
<nbu_dir_path>bpimage -prunetir [-allclients | -client name] -cleanup
<nbu_dir_path>bpimage -create_image_list -client name
<nbu_dir_path>bpimage -index index_number -client name
<nbu_dir_path>bpimage -wff path_bytes -backupid backupid [-client
name]
<nbu_dir_path>bpimage -update [-secinfo 0|1 | -rfile 0|1 |
-filesysonly 0|1 | -numfiles number | -keyword keyword_phrase |
-objdesc string] [-client name -policy name -t type -d mm/dd/yyyy
HH:MM:SS] [-id id]
On UNIX and Linux systems, <nbu_dir_path> is /usr/openv/netbackup/bin/
On Windows systems, <nbu_dir_path> is <install_path>\NetBackup\bin\

DESCRIPTION
This command can be used to perform many different functions to images that
are stored in a database. Some of the functions are as follows:
■ Compress and decompress the stored images.
■ Remove existing images from the database.
■ Test the locking capability on an image.
■ Create an image list file that can be used to qualify an image.
■ Index a client.
144 NetBackup Commands
bpimage

OPTIONS
The following options represent the criteria that determine which images or media
are selected for the report. Where images are discussed in these options, media
can be substituted if the context refers to a media report.
-allclients
Specifies the selection of all NetBackup clients that are already backed up on
the system.
-backupid backup_id
Specifies a backup ID to use for finding applicable images.
-client name
Specifies a client name to use for finding backups or archives to list. This
name must be as it appears in the NetBackup catalog.
-cleanup
Deletes expired images, compresses the images that are scheduled to be
compressed, and prunes the TIR information from the specified images.

Note: This option enables a user to accomplish the same tasks manually that
the scheduler performs on a regular basis. It can be used when the user does
not have enough time to wait for the scheduler to perform these tasks.

-create_image_list
Creates an image_list file and an image_info file that can be used quickly
to qualify an image.
-d date
Specifies the start date and end date range for the listing.
-d specifies a start date and time for the listing. The resulting list shows only
images in backups or the archives that occurred at or after the specified date
and time.
The required date and time values format in NetBackup commands varies
according to your locale. The /user/openv/msg/.conf file (UNIX and Linux)
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.
More information is available about the locale of your system.
See the "Specifying the locale of the NetBackup installation" topic in the
NetBackup Administrator's Guide, Volume II.
 NetBackup Commands 145
bpimage

The valid range of dates is from 01/01/1970 00:00:00 to 01/19/2038 03:14:07.

The default is the previous midnight.
-[de]compress
Initiates compression or decompression of a specified client or all clients.
-deletecopy #
Removes the images that the copy number (#) and the backup_id specify.
-filesysonly 0|1
Limits bpimage to query only the local file system if set to 1.
-id id
Specifies the media ID when used with the -newserver command or specifies
the backup ID when used with the -update command.
-index n
Indexes the database. The n variable is the index level and has a range from
1 to 9. A value of 9 provides the most optimum index. This option applies
only to ASCII.
-keyword "keyword_phrase"
Specifies a keyword phrase for NetBackup to use when it searches. The phrase
must match the phrase that was previously associated with the image.
-objdesc string
Specifies the object description string of the Informix client type when used
with the -update command.
-newserver name | -oldserver name
Specifies the new name or the old name of a NetBackup server.
-npc copy #
Sets the specified image as the primary image, which is based on the copy
number of the image.
-numfiles number
Specifies the number of files when used with the -update command.
-M master_server,...
Specifies a list of alternative master servers. This list is a comma-delimited
list of hostnames. If this option is present, each master server in the list runs
the bpimage command. If an error occurs for any master server, the process
stops at that point.
The report is the composite of the information that all the master servers in
this list returned. bpimage queries each of these master servers. The master
server returns image or media information from the image catalogs. Each
146 NetBackup Commands
bpimage

master server must allow access by the system that issues the bpimage
command.
The default is the master server for the system running bpimage.
-policy name
Searches for backups to import in the specified policy. The default is all
policies.
-prunetir
Prunes the true image restore (TIR) information from the specified clients.
The default is all clients.
-rfile 0|1
Specifies the use of the Restore file when used with the -update command.
-secinfo 0|1
Specifies the use of Extended Security information on the NetWare client
type.
-t type
Specifies a policy type. By default, bpimage searches for all policy types. type
is one of the following character strings:

Informix-On-BAR
MS-Exchange-Server
MS-SQL-Server
MS-Windows
NetWare
Oracle
OS/2
Standard
Sybase
NDMP

The following policy types apply only to NetBackup Enterprise Server:

AFS
DataTools-SQL-BackTrack
DB2
FlashBackup
SAP
Split-Mirror

-update
Updates an image that is based on the chosen parameter.
 NetBackup Commands 147
bpimage

-wff path bytes

Writes the files file (image .f file) for the backup that is specified with
-backupID.
148 NetBackup Commands
bpimagelist

bpimagelist
bpimagelist – produce status report on NetBackup images or removable media

SYNOPSIS
<admin_dir_path>bpimagelist [-media] [-l | -L | -U | -idonly] [-tape]
[-d date] [-e date] [-hoursago hours] [-keyword "keyword phrase"]
[-client client_name] [-server server_name] [-backupid backup_id]
[-option INCLUDE_PRE_IMPORT | INCLUDE_TIR | LIST_COMPLETE_COPIES |
LIST_OLD_TO_NEW | ONLY_PRE_IMPORT | ONLY_TIR] [-policy policy_name]
[-pt policy_type] [-rl retention_level] [-sl sched_label] [-st
sched_type] [-class_id class_guid] [-stl_complete] [-stl_incomplete]
[-stl_name storage_service_name] [-M master_server,...] [-v]
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd

DESCRIPTION
bpimagelist uses a specified format to report on catalog images or the removable
media that matches the attributes that are sent from the command options.
bpimagelist reports on the removable media if the -media option is on the
command line. If not, it reports on the catalog images.
It writes its debug log information to the following directory:

On UNIX and Linux systems: /usr/openv/netbackup/logs/admin

On Windows systems: install_path\NetBackup\logs\admin

You can use the information in this directory for troubleshooting.

The output of bpimagelist goes to standard output.
Authorized users can run this command.
For more information about NetBackup authorization, refer to the NetBackup
Administrator’s Guide.

OPTIONS
The following is the bpimagelist report-type option:
 NetBackup Commands 149
bpimagelist

-media
Specifies that the listing reports on the removable media that are based on
a set of criteria. If -media is not in the command line, the report is on images,
not media.
The following are the bpimagelist report-format options:
-U
Generates the report in User mode. The report is formatted. It includes a
banner that lists the column titles. The status is a descriptive term instead
of a number.
-L
Generates the report in Long mode. For instance, for the Media List report,
the report lists the information for each media ID as a series of attribute =
value pairs. The density value is provided as both a descriptive term and a
number.
-l
Reports in Short mode, which produces a terse listing. This option is useful
for the scripts or programs that rework the listing contents into a customized
report format.
-idonly
Produces an abbreviated list. For an image list, the list contains the creation
time, backup ID, and schedule type of each image. For instance, if the list
criterion is a window of time, the image list contains the following: For each
image that is created in this window, only the creation time, backup ID, and
schedule type of the image.
For a media list, the list contains only the applicable media IDs. For instance,
if the list criterion is a window of time, the list contains only the media IDs
that are written in this window.
The following options represent the criteria that determine which images or
media are selected for the report. Where images are discussed in these options,
media can be substituted if the report is a media report.
-hoursago hours
Includes the images that were written up to this many hours ago. This option
is equivalent to a specification of a start time (-d) of the current time minus
hours. hours must be 1 or greater.
-option option_name,...

Specifies one or more criteria for finding images to list. option_name is one
of the following character strings, in uppercase or lowercase:
150 NetBackup Commands
bpimagelist

■ INCLUDE_PRE_IMPORT - Report the images that completed phase 1 of an

import.
Refer to the bpimport command description or the NetBackup
Administrator’s Guide for more information.
■ INCLUDE_TIR - Report the images that true-image-recovery backups
created.
Refer to the bpcpinfo command description or the NetBackup
Administrator’s Guide for more information on this topic.
■ LIST_COMPLETE_COPIES - Do not report fragments of a duplicate copy that
is still in process.
■ LIST_OLD_TO_NEW - Report images by oldest to newest date.

■ ONLY_PRE_IMPORT - Report only the images that completed phase 1 of an

import.
■ ONLY_TIR - Report only the images that true-image-recovery backups
created.
The default is no restrictions on the selected images.
-backupid backup_id
Specifies a backup ID to use for finding applicable images (applies only to the
image list).
-class_id class_guid
Specifies a class identifier to use to select images. The identifier represents
a GUID (Globally Unique Identifier). The bpimagelist command reports only
those images with the specified class identifier.
-client client_name
Specifies a client name to use for finding backups or archives to list. This
name must be as it appears in the NetBackup catalog. By default, bpimagelist
searches for all clients.
-server server_name
Specifies the name of a NetBackup server or ALL. If -server specifies a server
name, then the images or media in the report are only those that reside on
that server. The images also satisfy the other criteria that bpimagelist
specifies. For instance, if -hoursago 2 is specified, the media must contain
an image that was created in the past two hours.
The query goes to the image catalog that resides on the local master server.
The master server must allow access by the system running bpimagelist.
 NetBackup Commands 151
bpimagelist

The default is to report all media in the image catalog on the local master
server, which is equivalent to the specification of -server ALL.
-stl_complete
Reports only the images that the storage lifecycle completely processed. This
option cannot be used with the stl_incomplete option.
-stl_incomplete
Reports only the images that the storage lifecycle has not completely
processed. This option cannot be used with the stl_complete option.
-stl_name storage_lifecycle_name
Specifies a storage lifecycle name to be used when you select images. Only
images with the specified storage lifecycle name are selected.
-M master_server,...
Specifies a list of one or more alternative master servers. This list is a
comma-delimited list of hostnames. If this option is present, each master
server in the list runs the bpimagelist command. If an error occurs for any
master server, the process stops at that point.
The report is the composite of the information that all the master servers in
this list return. bpimagelist queries each of these master servers. The master
server returns image or media information from the image catalogs. Each
master server must allow access by the system that issues the bpimagelist
command.
The default is the master server for the system running bpimagelist.
-pt policy_type
Specifies a policy type. By default, bpimagelist searches for all policy types.
policy_type is one of the following character strings:

Informix-On-BAR
MS-Exchange-Server
MS-SQL-Server
MS-SharePoint
MS-Windows-NT
NetWare
Oracle
OS/2
Standard
Sybase
NDMP
152 NetBackup Commands
bpimagelist

Note that the following policy types apply only to the NetBackup Enterprise
Server:

AFS
DataTools-SQL-BackTrack
DB2
Enterprise-Vault
FlashBackup
SAP
Split-Mirror

-rl retention_level
Specifies the retention_level. The retention_level is an integer between 0 and
24. By default, bpimagelist searches for all retention levels.
-d date, -e date
Specifies the start date and end date range for the listing.
-d specifies a start date and time for the listing. The output list shows only
images in backups or the archives that occurred at or after the specified date
and time.
-e specifies an end date and time for the listing. The output list shows only
files from backups or the archives that occurred at or before the specified
date and time. Use the same format as for the start date. The default is the
current date and time.
The valid range of dates is from 01/01/1970 00:00:00 to 01/19/2038 03:14:07.
The default is the previous midnight.
The required date and time values format in NetBackup commands varies
according to your locale. The /user/openv/msg/.conf file (UNIX and Linux)
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.
More information is available about the locale of your system.
See the "Specifying the locale of the NetBackup installation" topic in the
NetBackup Administrator's Guide, Volume II.
The following is part of the -help USAGE statement for -bpimagelist that
shows the -d and -e options:
[-d mm/dd/yy hh:mm:ss] [-e mm/dd/yy hh:mm:ss]
 NetBackup Commands 153
bpimagelist

-keyword "keyword_phrase"
Specifies a keyword phrase for NetBackup to use when it searches. The phrase
must match the one that was previously associated with the image. For
instance, the -k option of the bpbackup or the bparchive command associates
a keyword with the image when the image is created.
-sl sched_label
Specifies a schedule label for the image selection. The default is all schedules.
-st sched_type

Specifies a schedule type for the image selection. The default is any schedule
type. Valid values are as follows:
■ FULL (full backup)

■ INCR (differential-incremental backup)

■ CINC (cumulative-incremental backup)

■ UBAK (user backup)

■ UARC (user archive)

■ NOT_ARCHIVE (all backups except user archive)

-policy name
Searches for backups to import in the specified policy. The default is all
policies.
The following are other bpimagelist options:
-tape
Displays in the list only the images that have at least one fragment that resides
on removable or tape-based media. Any disk-based fragments in these images
are ignored. If an image has fragments on both tape and disk, this option
displays only the tape-based fragments.
-v Selects the verbose mode. This option causes bpimagelist to log additional
information for debugging purposes. The information goes into the NetBackup
administration daily debug log. This option is meaningful only when the
debug log function is enabled; that is, when the following directory is defined:
UNIX and Linux systems: /usr/openv/netbackup/logs/admin
Windows systems: install_path\NetBackup\logs\admin

EXAMPLES
EXAMPLE 1
154 NetBackup Commands
bpimagelist

The first example shows the last time each media ID available to a server had a
backup image that was written today:

# bpimagelist -media -U
Media ID Last Written Server
-------- ---------------- ----------
IBM000 01/06/2006 01:06 hatt
AEK800 01/06/2006 03:01 hatt
C0015 01/06/2006 02:01 hatt

EXAMPLE 2
The following example shows the last time the media IDs available to the server
had a backup image that was written during the specified time:

# bpimagelist -media -d 01/05/2007 18:00:46 -e 01/06/2007 23:59:59

-U
Media ID Last Written Server
-------- ---------------- ----------
IBM000 01/06/2007 01:06 hatt
AEK800 01/06/2007 03:01 hatt
C0015 01/06/2007 02:01 hatt
143191 01/05/2007 23:00 hatt

EXAMPLE 3
The following example lists all images that were written today:

# bpimagelist -U
Backed Up Expires Files KB C Sched Type Policy
--------------- -------- -------- ------ - ------------ ----------
01/27/2007 01:08 02/03/2007 1122 202624 N Full Backup 3590Grau
01/27/2007 01:01 02/03/2007 1122 202624 N Full Backup IBM35pol
01/27/2007 03:01 02/03/2007 531 1055104 N Full Backup DELLpol
01/27/2007 02:01 02/03/2007 961 31776 N Full Backup QUALpol
01/27/2007 01:08 02/03/2007 2063 603328 N Full Backup IBM35pol
01/27/2007 01:01 02/03/2007 2063 603328 N Full Backup 3590Grau

EXAMPLE 4
The following example lists media written information for 01/05/2006:

# bpimagelist -media -d 01/05/2006 -e 01/05/2006 -U

Media ID Last Written Server
-------- -------------- ----------
IBM000 01/05/2006 01:13 hatt
143191 01/05/2006 23:00 hatt
 NetBackup Commands 155
bpimagelist

AEK800 01/05/2006 03:07 hatt

C0015 01/05/2006 02:06 hatt

FILES
UNIX and Linux systems: /usr/openv/netbackup/logs/admin/log.mmddyy

/usr/openv/netbackup/db/images

Windows systems:

install_path\NetBackup\logs\admin\log.mmddyy
install_path\NetBackup\db\images

SEE ALSO
bp(UNIX and Linux systems), bparchive, bpbackup, bprestore
156 NetBackup Commands
bpimmedia

bpimmedia
bpimmedia – display information about NetBackup images on media

SYNOPSIS
<admin_dir_path>bpimmedia [-disk_stu storage_unit_label | [-dt
disk_type | -stype server_type [-dp disk_pool_name [-dv disk_volume]]
[-legacy]]] [-l | -L] [-disk | -tape] [-policy policy_name] [-client
client_name] [-d date time] [-e date time] [-mediaid media_id |
path_name] [-mtype image_type] [-option option_name] [-rl retlevel]
[-sl sched_label] [-t sched_type] [-M master_server...] [-verbose]
<admin_dir_path>bpimmedia -spanpools [-cn copy_number] [-mediaid
media_id] [-U]
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

DESCRIPTION
bpimmedia queries the NetBackup image catalog and produces the following two
types of reports on the images:
■ An Images-on-Media report
■ A Spanpools report
The first form of bpimmedia in the SYNOPSIS displays a set of NetBackup images
in the Images-on-Media report. This report lists the contents of media as recorded
in the NetBackup image catalog.
You can generate this report for any medium including disk. Filter the report
contents according to client, media ID, path, and so on.
Refer to the section on NetBackup Reports in the NetBackup Administrator’s Guide
for more information, including details about the fields in the Images-on-Media
report.
The report does not show information for the media that is used in backups of
the NetBackup catalogs.
Several options (-dt, -dp, -dv, -stype) report images present on SAN disk storage
only, not on any other disk-resident images. Other options and output format
continue to function as before.
 NetBackup Commands 157
bpimmedia

The second SYNOPSIS form of bpimmedia uses -spanpools to list the disk ID pools
that are related because images span from one volume to another. The output
lists, for each media server in the cluster, the media IDs that have spanned images.
The -spanpools form of bpimmedia must be run on the NetBackup master server
that administers the volumes.
For more information on spanned images, see the Spanning Media topic in the
NetBackup Administrator’s Guide.
Only removable media types are processed.
bpimmedia sends its error messages to stderr. bpimmedia sends a log of its activity
to the NetBackup admin log file for the current day.
Authorized users can run this command.
For more information about NetBackup authorization, refer to the NetBackup
Security and Encryption Guide.

OPTIONS
client client_name
Client name. This name must be as it appears in the NetBackup catalog. By
default, bpimmedia searches for all clients.
-cn copy_number
Copy number (1 or 2) of a backup ID. The default is copy 1. This option is used
only in combination with -spanpools.
-d date time, -e date time
Specifies the start date and end date range for the listing.
-d specifies a start date and time for the listing. The output list shows only
images in backups or the archives that occurred at or after the specified date
and time.
-e specifies an end date and time for the listing.The output list shows only
files from backups or the archives that occurred at or before the specified
date and time. Use the same format as for the start date. The default is the
current date and time.
The valid range of dates is from 01/01/1970 00:00:00 to 01/19/2038 03:14:07.
The default is the previous midnight.
The required date and time values format in NetBackup commands varies
according to your locale. The /user/openv/msg/.conf file (UNIX and Linux)
and the install_path\VERITAS\msg\LC.CONF file (Windows) contain
information such as the date-time formats for each supported locale. The
158 NetBackup Commands
bpimmedia

files contain specific instructions on how to add or modify the list of supported
locales and formats.
More information is available about the locale of your system.
See the "Specifying the locale of the NetBackup installation" topic in the
NetBackup Administrator's Guide, Volume II.
The following is part of the -help USAGE statement for -bpimagelist that
shows the -d and -e options:
[-d mm/dd/yy hh:mm:ss] [-e mm/dd/yy hh:mm:ss]
-dp disk_pool_name
Displays the images on the specified disk pool only.
-dt disk_type
Specifies the type of disk storage. The following are valid options:
1 - BasicDisk
2 - NearStore
3 - SnapVault
This option does not apply to the OpenStorage disk type.
-dv disk_volume
Displays the images that reside on the specified disk volume only. The input
value is the volume path for NearStore, the path for BasicDisk, and the volume
name for SharedDisk (NetBackup 6.5 media servers only).
-L
The list type is long.
See DISPLAY FORMATS.
-l
The list type is short. This setting is the default if the command line has no
list-type option (for example, if you enter bpimmedia and a carriage return).
See DISPLAY FORMATS.
-legacy
Formats the new data in legacy format.
-M master_server,...
A list of alternative master servers. This list is a comma-separated list of
hostnames. If this option is present, the command is run on each of the master
servers in this list. The master servers must allow access by the system that
issues the command. If an error occurs for any master server, the process
 NetBackup Commands 159
bpimmedia

stops at that point in the list. The default is the master server for the system
where the command is entered.
-mediaid media_id | pathname
This ID is either a VSN or an absolute pathname. If the media ID is a VSN, it
is a one- to six-character string. If the media ID is a pathname, it is the
absolute pathname of the file system for a disk storage unit.
When -mediaid is specified, the Images-on-Media report displays only the
images that are stored on this VSN or pathname. By default, the report
displays the images that are stored on all media IDs and pathnames.
For the Spanpools report (-spanpools), only a VSN can follow -mediaid. If
-mediaid is omitted when -spanpools is present, bpimmedia displays all
media in all spanning pools.
-mtype image_type

Image type. The defined values and their interpretations are as follows:
■ 0 = Regular backup (scheduled or user-directed backup)

■ 1 = Pre-imported backup (phase 1 completed)

■ 2 = Imported backup

-option option_name

Specifies a criterion for finding images to list. option_name is one of the

following character strings, in either uppercase or lowercase:
■ INCLUDE_PRE_IMPORT - Include images that completed phase 1 of an import.
Refer to the bpimport command description or the NetBackup
Administrator’s Guide for more information.
■ ONLY_PRE_IMPORT - Include only the images that completed phase 1 of an
import.
The default is INCLUDE_PRE_IMPORT.
-policy policy_name
Searches for images with the specified policy name. By default, bpimmedia
searches for images for all policies.
-rl retlevel
Specifies the retention_level. The retention_level is an integer between 0 and
24. By default, bpimmedia searches for all retention levels.
-sl sched_label
Searches for images with the specified schedule label. By default, bpimmedia
searches for images for all schedule labels.
160 NetBackup Commands
bpimmedia

-spanpools
Specifies that bpimmedia should create a Spanpools report. The default
(-spanpools not present on the command line) is to create an Images-on-Media
report.
-stype server_type
Specifies a string that identifies the storage server type. Possible values are
AdvancedDisk, OpenStorage (vendorname), PureDisk, and SharedDisk
(NetBackup 6.5 media servers only).
-t sched_type

Specifies a schedule type for the image selection. The default is any schedule
type. Valid values, in either uppercase or lowercase, are as follows:
■ FULL (full backup)

■ INCR (differential-incremental backup)

■ CINC (cumulative-incremental backup)

■ UBAK (user backup)

■ UARC (user archive)

-tape
Displays in the Images-on-Media report only the images that have at least
one fragment that resides on removable or tape-based media. Disk-based
fragments in these images are ignored. If an image has fragments on both
tape and disk, this option displays only the tape-based fragments.
-U
The list type is user. This option is used only in combination with -spanpools.
See DISPLAY FORMATS.
-verbose
Select verbose mode for logging. This option is only meaningful when it runs
with debug logging on; that is, when the following directory is defined:
UNIX and Linux systems: /usr/openv/netbackup/logs/admin
Windows systems: install_path\NetBackup\logs\admin

DISPLAY FORMATS
IMAGES-ON-MEDIA REPORT
The Images-on-Media report consists of two formats, short (-l or default) and
long (-L).
 NetBackup Commands 161
bpimmedia

To process and use the output of bpimmedia, use the -l option. The output of
bpimmedia that uses the -L or -U options may be truncated for the Backup-ID,
Policy, and Host columns. The -L or -U options are useful when you want to obtain
a quick, more readable view of the NetBackup images on media.
The following shows the long display format (-L) and the short display format (-l)
of the Images-on-Media report:
■ Long Display Format (-L)
If the command line contains -L, the display format is long. It contains a
multi-line entry for each backup image. The number of lines for an entry is
n+1, where n is the number of fragments for the image. The fields for an entry
are listed later. The first line of the entry contains the fields
Backup_ID...Expires. Each fragment in the image has a line that contains the
fields Copy_Media ID. The report has a two-line header. The first header line
lists the field names for line 1 of each entry. The second header line lists the
field names for the lines that contain fragment information.
See the bpduplicate command page for more information on the copy number
and primary copy.
Fields and meanings for the -L format are as follows:
Line 1
Backup-ID - Unique identifier for the backup that produced this image
Policy - Policy name (may be truncated if long)
Type - Schedule type (FULL, etc.)
RL - Retention level (0..24)
Files - Number of files in the backup
C - Compression (Y or N)
E - Encryption (Y or N)
T - Image type
R - Regular (scheduled or user-directed backup)
P - Pre-imported backup (phase 1 completed)
I - Imported backup
PC - Primary copy, 1 or 2. Designates which copy of the backup NetBackup
chooses when it restores.
Expires - The expiration date of the first copy to expire, which appears in the
Expires field of the fragment, which is described later.
Line 2_n+1
Copy - Copy number of this fragment
Frag - Fragment number or IDX for a true-image-restore (TIR) fragment
KB - Size of the fragment, in kilobytes. This value does not include the size of
tape headers between backups. A fragment size of 0 is possible for a multiplexed
backup.
162 NetBackup Commands
bpimmedia

Type - Media type (Rmed - removable media; Disk otherwise)Density - Density

of the removable media that produced the backupFnum - File number; the n-th
backup on this removable media Host - Server whose catalog contains this
imageDWO - Device Written On; device where the backup was written. The DWO
matches the drive index as configured in Media Manager (applies only to
removable media).
MPX - Flag that indicates whether this copy is multiplexed: Y or N (applies
only when fragment number is 1)
Expires - The expiration date of this copy (applies only when fragment number
is 1)
MediaID - Media ID or absolute path where the image is stored
Example of Long display format:

bpimmedia -L -policy regr1_gava -t FULL

Backup-ID Policy Type RL Files C E T PC Expires
Copy Frag KB Type Density FNum Host DWO MPX Expires MediaID
----------------------------------------------------------------
gava_0949949902 r1_guav FULL 3 25 N N R 1 12:58 03/09/2007
1 1 256 RMed dlt 13 0 plim 0 Y 12:58 03/09/2007 A00002

■ Short Display Format (-l)

If the bpconfig command line contains -l or contains no list-format option,
the display format is short, which produces a terse listing. This option can be
useful for scripts or the programs that rework the listing into a customized
report format. The -l display format contains a multi-line entry for each
backup image. The number of lines per entry is n+1, where n is the number of
fragments for the image. The layout of an entry is a first line that contains
information about the image. A second line follows that contains information
about each fragment of the image. The attributes appear in the following order
(separated by blanks).
Fields for the -l format are as follows:
Line 1
IMAGE - Identifies the start of an image entry
Client - Client for the backup that produced this image
Version - Image-version level
Backup-ID - Unique identifier for the backup that produced this image
Policy - Policy name
Policy type - 0 denotes Standard, etc. Run bpimmedia -L or refer to bpbackup
to interpret the policy-type value as a policy-type name.
Schedule - Schedule name
Type - Schedule type (full, etc.)
 NetBackup Commands 163
bpimmedia

RL - Retention level (0-24)

Files - Number of files
Expiration date or time - The expiration date of the first copy to expire. It
appears in the Expires field of the fragment, which is described later (system
time). A value of zero (0) denotes an image in progress or failed.
C - Compression; 1 (yes) or 0 (no)
E - Encryption; 1 (yes) or 0 (no)
Line 2_n+1
FRAG - Identifies a fragment line in an image entry
Copy - Copy number of this fragment
Frag - Fragment number, or -1 for a TIR fragment
KB - Size of the fragment in kilobytes
MPX - Flag that indicates whether this copy is multiplexed, 1(yes) or 0(no)
(applies only when fragment number is 1)
Expires - The expiration date of this copy in system time (applies only when
fragment number is 1)
Disk type - BasicDisk (1), NearStore (2), SAN Disk (4)
Disk pool name - Only applies to SAN Disk. All other disk types show *NULL*.
Media ID - volume path if NearStore, path if BasicDisk, or volume name if SAN
Disk
Density - Density value (applies only to removable media). Run bpimmedia -L
or bpmedialist -mlist -L -m mediaid to interpret the density value as a
density label
Fnum - File number; the n-th backup on this removable media
MediaID - Media ID or absolute path where the image is stored
Host - Server whose catalog contains this image
Block size - Number of kilobytes per block for this medium
Off - Offset
Media date - Time this medium was allocated (system time)
DWO - Device Written On (applies only to removable media)
Example of the short display format:

# bpimmedia -l -policy regr1_gava -t FULL

IMAGE gava 3 gava_0949949902 regr1_gava 0 full 0 3 25 952628302 0 0
FRAG 1 1 10256 512 2 13 13 A00002 plim 65536 0 949616279 0 0 *NULL* 952628302 1

SPANPOOLS REPORT
The Spanpools report has two formats: user (-U option) and short (the default).
Both formats list the server name and the pool data for each server. It lists the
media IDs for each pool of media that share spanned backup images. When
164 NetBackup Commands
bpimmedia

-mediaid appears on the command line, only the server pool and the disk pool
that are related to that media ID appear.
If you want to process and use the output of bpimmedia, we recommend that
you use the -l option. The output of bpimmedia that uses the -U or -L options
may be truncated for the Backup-ID, Policy, and Host columns. The -U or -L
options are useful when you want to obtain a quick, more readable view of the
NetBackup images on media.
The user (-U) display format looks like the following:

# bpimmedia -spanpools -U
Related media pools containing spanned backup images, server plim:
Pool:
A00002 A00003
Pool:
400032

The short display format looks like the following

bpimmedia -spanpools
SERVER plim
POOL A00002 A00003
POOL 400032

EXAMPLES
EXAMPLE 1
List the images for policy c_NDMP. This request runs on a NetBackup media server.
The report is based on the image catalog on the media server’s master server,
almond.

# bpimmedia -L -policy c_NDMP

Backup-ID Policy Type RL Files C E T PC Expires

Copy Frag KB Type Density FNum Off Host DWO MPX Expires MediaID
--------------------------------------------------------------------------------------

t_0929653085 c_NDMP FULL 3 5909 N N R 1 15:58 07/18/2007

1 IDX 844 RMed dlt 2 0 almond 3 CB7514
1 1 9136 RMed dlt 1 0 almond 3 N 15:58 07/18/2007
CB7514

EXAMPLE 2
 NetBackup Commands 165
bpimmedia

The following example displays the tapes that are required to restore a particular
file. If the bpimmedia command line provides the criteria to identify an individual
backup, the output shows the media that was used for the backup.
In this case, the command line provides the client, the date of the backup and the
schedule type. The output shows that tape A00002 on the server plim contains
the backup.

# bpimmedia -L -client gava -d 2/7/2007 -t UBAK

Backup-ID Policy Type RL Files C E T PC Expires

Copy Frag KB Type Density FNum Off Host DWO MPX Expires MediaID
---------------------------------------------------------------------------------------
------

gava_0949949686 regr1_guav UBAK 3 25 N N R 1 12:54 03/09/2007

1 1 10256 RMed dlt 11 0 plim 0 Y 12:54 03/09/2007
A00002

EXAMPLE 3
List in long format all the backups in the image catalog on master server gava.

# bpimmedia -L -M gava

Backup-ID Policy Type RL Files C E T PC Expires

Copy Frag KB Type Density FNum Off Host DWO MPX Expires MediaID
--------------------------------------------------------------------------------------
gava_0949599942 test-policy FULL 1 15 N N R 1 11:45 02/17/2007
1 1 224 Disk - - - gava - N 11:45 02/17/20
/var/qatest/storage_unit//gava_0949599942_C1_F1

EXAMPLE 4
List in long format the backups on media ID CB7514.

# bpimmedia -L -mediaid CB7514

Backup-ID Policy Type RL Files C E T PC Expires

Copy Frag KB Type Density FNum Off Host DWO MPX Expires MediaID
--------------------------------------------------------------------------------------
toaster1_0929679294 tort_policy FULL 3 5898 N N R 1 23:14 07/18/2007
1 IDX 839 RMed dlt 4 0 almond 6 CB7514
1 1 27154 RMed dlt 3 0 almond 6 N 23:14 07/18/2007
CB7514
166 NetBackup Commands
bpimmedia

toaster1_0929653085 NDMP_policy FULL 3 5909 N N R 1 15:58 07/18/2007

1 IDX 844 RMed dlt 2 0 almond 3 CB7514
1 1 9136 RMed dlt 1 0 almond 3 N 15:58 07/18/2007
CB7514

RETURN VALUES
An exit status of zero (0) means that the command ran successfully.
Any exit status other than zero (0) means that an error occurred.
If the administrative log function is enabled, the exit status is logged in the
administrative daily log under the log directory:

UNIX and Linux systems: /usr/openv/netbackup/logs/admin

Windows systems: install_path\NetBackup\logs\admin

It has the following form:

bpimmedia: EXIT status = exit status

If an error occurred, a diagnostic precedes this message.

FILES
UNIX and Linux systems:

/usr/openv/netbackup/logs/admin/*
/usr/openv/netbackup/db/images

Windows systems:

install_path\NetBackup\logs\admin\*
install_path\NetBackup\db\images

SEE ALSO
bpbackup, bpduplicate, bpimport
 NetBackup Commands 167
bpimport

bpimport
bpimport – import NetBackup and Backup Exec backups that are expired or are
from another NetBackup or Backup Exec Server

SYNOPSIS
<admin_dir_path>bpimport -create_db_info -id media_id or path | -stype
server_type [-dp disk_pool_name [-dv disk_volume]] [-server name]
[-L output_file [-en]] [-passwd] [-local] [-nh ndmp_host [-mst
media_subtype]]
<admin_dir_path>bpimport [-l] [-p] [-pb] [-PD] [-PM] [-v] [-local]
[-client name] [-M master_server] [-Bidfile file_name] [-st
sched_type] [-sl sched_label] [-L output_file [-en]] [-policy name]
[-s startdate] [-e enddate] [-pt policy_type] [-hoursago hours] [-cn
copy_number] [-backupid backup_id] [[-id media_id | path] | -stype
server_type]] [-dp disk_pool_name [-dv disk_volume]] [-priority
number]
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

DESCRIPTION
The bpimport command allows backups to be imported. This command is useful
for importing expired backups or the backups from another NetBackup server.
The import operation consists of the following two steps:
■ Step 1 is performed with the first form of the command that appears in the
Synopsis (-create_db_info option). This step recreates catalog entries for
the backups that are on the specified media.
■ Step 2 is performed with the second form of the command that appears in the
Synopsis. This step imports the backups from the media.
The expiration date for imported backups is the current date plus the retention
period. For example, if a backup is imported on 14 November 2006 and its retention
level is one week, its new expiration date is 21 November 2006.
You can import a backup only if all copies of it are expired.
For more information on how to import backups, see the NetBackup
Administrator’s Guide.
168 NetBackup Commands
bpimport

OPTIONS
-backupid backup_id
Specifies the backup ID of a single backup to import.
-Bidfile file_name
file_name specifies a file that contains a list of backup IDs to import. List one
backup ID per line in the file. If this option is included, other selection criteria
are ignored.
In addition, NetBackup removes the file that is specified with the -Bidfile
parameter during the activation of that command line interface (CLI). It is
removed because the NetBackup GUIs commonly use this parameter. The
GUIs expect the command-line interface to remove the temporary file that
was used for the -Bidfile option upon completion. Direct command-line
interface users can also use the option, however it removes the file.
-client name
The host name of the client for which the backups were performed. The
default is all clients.
-cn copy_number
Specifies the source copy number of the backups to import. Valid values are
1 through 10. The default is all copies.
-create_db_info
This option recreates catalog entries for the backups that are on the specified
media. It skips the backups that are already in the catalog. This option only
creates information about the backups that are candidates for import, and
does not perform the import operation. The bpimport command must be run
with this option before you import any backups.
-dp disk_pool_name [-dv disk_volume]
Imports images on the specified disk pool only. Optionally, the import can
be restricted to the images that reside on the specified disk volume only. The
disk_volume argument is the volume path for NearStore, the path for
BasicDisk, and the volume name for SharedDisk (NetBackup 6.5 media servers
only).
Option -stype is required with this option.
-e enddate, -s startdate
Specifies the start date and end date range for all backups to import.
-s specifies a start date and time for the listing. The output list shows only
images in backups or the archives that occurred at or after the specified date
 NetBackup Commands 169
bpimport

and time. The default for the start date is 24 hours before the current date
and time.
-e specifies an end date and time for the listing.The output list shows only
files from backups or the archives that occurred at or before the specified
date and time. Use the same format as for the start date. The default is the
current date and time.
The valid range of dates is from 01/01/1970 00:00:00 to 01/19/2038 03:14:07.
The default is the previous midnight.
The required date and time values format in NetBackup commands varies
according to your locale. The /user/openv/msg/.conf file (UNIX and Linux)
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.
More information is available about the locale of your system.
See the "Specifying the locale of the NetBackup installation" topic in the
NetBackup Administrator's Guide, Volume II.
The following is part of the -help USAGE statement for -bpimagelist that
shows the -s and -e options:
-s mm/dd/yy [hh[:mm[:ss]]] -e mm/dd/yy [hh[:mm[:ss]]]
-hoursago hours
Specifies the number of hours to search before the current time for backups.
Do not use with the -s option. The default is the previous midnight.
-id media_id | path
Disk media:
Specifies the path to the storage directory that contains the backup to be
imported.
Tape media:
For step 1 (-create_db_info), this option specifies the media ID that has the
backups you plan to import. This option is required with -create_db_info.
For step 2, this option designates a specific media ID from which to import
backups. The default is all media IDs that were processed in step 1 of the
import operation.
A backup ID that begins on a media ID that step 1 does not process, does not
import (the backup is incomplete).
170 NetBackup Commands
bpimport

-L output_file [-en]
Specifies the name of a file in which to write progress information. The default
is not to use a progress file.
Include the -en option to generate a log in English. The name of the log
contains the string _en. This option is useful to support the personnel that
assist in a distributed environment where different locales may create logs
of various languages.
-l
Produces the output in the progress log that lists each imported file.
-local
When a host other than master server initiates bpimport and -local is not
used (default), the following occurs: bpimport starts a remote copy of the
command on the master server.
The remote copy allows the command to be terminated from the Activity
Monitor.
Use -localto prevent the creation of a remote copy on the master server.
You also can use it to run the bpimport only from the host where it was
initiated.
If the -local option is used, bpimport cannot be canceled from the Activity
Monitor.
-M master_server

Note: This option is not required for NetBackup server because it has only
one server, the master. If you do use this option in this case, specify the
NetBackup master where you run the command.

Specifies the master server that manages the media catalog that has the
media ID. If this option is not specified, the default is one of the following:
If the command is run on a master server, then that server is the default.
If the command is run on a media server that is not the master, then the
master for that media server is the default.
-p
Previews backups to import according to the option settings, but does not
perform the import. Displays the media IDs, server name, and information
about the backups to import.
 NetBackup Commands 171
bpimport

-passwd
Use with the Backup Exec tape reader option to catalog password-protected
Backup Exec media. When -passwd is specified, bpimport prompts the user
for a password. The given password is then compared with the password on
the media. If the password matches, the job proceeds. If the password does
not match, the job fails.
Use -passwd only when Backup Exec media are imported and the Backup Exec
media are password-protected. Backup Exec media can only be imported on
a Windows media server.
-pb
Previews the backups to import but does not perform the import. Similar to
the -p option, but does not display the backups.
-PD
Same as the -PM option, except the backups sort by date and time (newest to
oldest).
-PM
Displays the information on the backups to be imported according to the
option settings, but does not perform the import. It displays the following
information about the backup: Date and time of the backup, policy, schedule,
backup ID, host, and media ID.
-policy name
Search for backups to import in the specified policy. The default is all policies.
-priority number
Specifies a new priority for the import job that overrides the default job
priority.
-pt policy_type
Search for the backups that the specified policy type created. The default is
any policy type.
Valid values are:

Informix-On-BAR
MS-Exchange-Server
MS-SharePoint
MS-SQL-Server
MS-Windows-NT
NDMP
NetWare
Oracle
OS/2
172 NetBackup Commands
bpimport

Standard
Sybase

The following policy types apply only to NetBackup Enterprise Server:

AFS
DataTools-SQL-BackTrack
DB2
Enterprise-Vault
FlashBackup
SAP
Split-Mirror

-server name

Note: The NetBackup server has only one server (the master). When you use
NetBackup server , specify the name of that server.

Specifies the name of the media server. The volume database for this server
must have a record of the media ID that contains the backups to import. The
default is the media server where the command is run.
-sl sched_label
Search for backups to import that the specified schedule created. The default
is all schedules.
-st sched_type
Search for backups to import that the specified schedule type created. The
default is any schedule type.
Valid values are as follows:
FULL (full backup)

INCR (differential-incremental backup)

CINC (cumulative-incremental backup)

UBAK (user backup)

UARC (user archive)

NOT_ARCHIVE (all backups except user archive)

-stype server_type
A string that identifies the storage server type. Possible values are
AdvancedDisk, OpenStorage (vendorname), PureDisk, and SharedDisk
(NetBackup 6.5 media servers only).
 NetBackup Commands 173
bpimport

-v
Selects the verbose mode. The debug logs and progress logs display more
information.

EXAMPLES
EXAMPLE 1
The following command (all on one line) creates catalog information for backups
on media ID A0000. The media host hostname is cat. The progress file is
bpimport.ls, which is located in the tmp directory.

UNIX and Linux systems: # bpimport -create_db_info -id A0000 -server

cat -L /tmp/bpimport.ls

Windows systems: # bpimport -create_db_info -id A0000 -server cat -L

\tmp\bpimport.ls

EXAMPLE 2
The following command (all on one line) displays information about the backups
that are candidates for import. The backups that appear were created between
11/01/2006 and 11/10/2006. The bpimport command with the -create_db_info
option must be run before this command.

# bpimport -PM -s 11/01/2006 -e 11/10/2006

EXAMPLE 3
The following command imports the backups that were specified in the images
file. The progress is entered in the bpimport.ls file.
UNIX and Linux systems: # bpimport -Bidfile /tmp/import/image -L
/tmp/bpimport.ls

Windows systems: # bpimport -Bidfile \tmp\import\image -L

\tmp\bpimport.ls

FILES
UNIX and Linux systems:

/usr/openv/netbackup/logs/admin/*

/usr/openv/netbackup/db/images/*

Windows systems:
174 NetBackup Commands
bpimport

install_path\NetBackup\logs\admin\*

install_path\NetBackup\db\images\*
 NetBackup Commands 175
bpinst

bpinst
bpinst – configure legacy NetBackup Encryption

SYNOPSIS
<nbu_dir_path>bpinst -LEGACY_CRYPT [-crypt_option option]
[-crypt_strength strength] [-passphrase_prompt |-passphrase_stdin]
[-verbose] [ [-policy_encrypt 0 | 1] -policy_names] name1 [name2 ...
nameN]
On UNIX and Linux systems, <nbu_dir_path> is /usr/openv/netbackup/bin/
On Windows systems, <nbu_dir_path> is <install_path>\NetBackup\bin\

DESCRIPTION
NetBackup Encryption provides file-level encryption of backups and archives.
-LEGACY_CRYPT is the Legacy Encryption method. It provides the user with the
encryption strength choices previously available (40-bit DES and 56-bit DES).
The bpinst command that is used with the -LEGACY_CRYPT option configures the
legacy NetBackup Encryption product on the NetBackup clients that can support
encryption. You can also configure encryption for a client that is installed on the
master server host.
Activate bpinst -LEGACY_CRYPT on the master server to configure NetBackup
Encryption on the clients. A single activation makes the necessary configuration
changes on both the clients and the master server.

Note: Ensure that the DISALLOW_SERVER_FILE_WRITES NetBackup configuration

option is not set on the client. If this option is set, the server cannot configure the
software on the client.

OPTIONS
-LEGACY_CRYPT
Required if you use 40-bit DES or 56-bit DES encryption. To configure DES
encryption, specify this option first to use the bpinst command. The order
is important; do not omit this option.
176 NetBackup Commands
bpinst

-crypt_option option
Configures the CRYPT_OPTION configuration entry on the NetBackup clients.
If you do not specify -crypt_option, the client allows either encrypted or
unencrypted backups (see ALLOWED).
The possible values for option are:

DENIED | denied | -1

Specifies that the client does not permit encrypted backups. If the server
requests an encrypted backup, it is considered an error. This option is the
default for a client that has not been configured for encryption.

ALLOWED | allowed | 0

Specifies that the client allows either encrypted or unencrypted backups.

ALLOWED is the default condition.

REQUIRED | required | 1

Specifies that the client requires encrypted backups. If the server requests
an unencrypted backup, it is considered an error.
-crypt_strength strength
Configures the CRYPT_STRENGTH configuration entry on the NetBackup clients.
If you do not specify this option, the CRYPT_STRENGTH configuration entries
on the clients remain unchanged.
The possible values for strength are:

DES_40 | des_40 | 40

Specifies the 40-bit DES encryption. This value is the default value for a client
that has not been configured for encryption.

DES_56 | des_56 | 56

Specifies the 56-bit DES encryption.

-passphrase_prompt | -passphrase_stdin

Note: Do not forget the pass phrase. If the key file is damaged or lost, you
may need the pass phrase to regenerate the key file. Without the proper key
file, you cannot restore encrypted backups.

NetBackup uses a pass phrase to create the data that it places in a key file on
each client. NetBackup then uses the data in the key file to create the
 NetBackup Commands 177
bpinst

encryption keys that are required to encrypt and decrypt the backup data.
This option applies to the -LEGACY_CRYPT option only.
The -passphrase_prompt option prompts you to enter a pass phrase. The
actual pass phrase is hidden while you type.
The -passphrase_stdin option reads the pass phrase through standard input.
You must enter the pass phrase twice. This option is less secure than the
-passphrase_prompt option because the pass phrase is not hidden. However,
it may be more convenient if you use bpinst -LEGACY_CRYPT in a shell script.
NetBackup uses the pass phrase for all the clients that you specify on the
bpinst -LEGACY_CRYPT command. If you want separate pass phrases for each
client, enter a separate bpinst -LEGACY_CRYPT command for each client.
When you specify a pass phrase, bpinst -LEGACY_CRYPT creates or updates
the key files on the clients. The encryption keys (generated from the pass
phrase) are used for subsequent backups. Old encryption keys are retained
in the key file to allow restores of previous backups.
If you do not specify either the -passphrase_prompt or -passphrase_stdin
option, the key files on the clients remain unchanged.
-verbose
Prints the current encryption configuration of each client and what gets
installed and reconfigured on each client.
-policy_encrypt 0 | 1
Sets the Encryption policy attribute for the NetBackup policies. You can
include -policy_encrypt only with the -policy_names option. The possible
values are:
0 - clears the Encryption attribute (or leaves it clear) so the server does not
request encryption for clients in this policy. This setting is the default for
the policies that are not configured for encryption.
1 - sets the Encryption attribute so the server requests encryption for clients
in this policy.
If you do not specify this option, the Encryption attributes for the policies
remain unchanged.
-policy_names
Specifies that the names you specify (with the names option) are NetBackup
policy names.
If you include the -policy_names option, bpinst -LEGACY_CRYPT configures
all the clients in each specified policy. If you omit the -policy_names option,
the names are assumed to be NetBackup client names.
178 NetBackup Commands
bpinst

name1 [name2 ... nameN]

Specifies one or more NetBackup client or policy names, depending on whether
you have included the -policy_names option. If you omit the -policy_names
option, the names are assumed to be NetBackup client names.

NOTES
The following notes apply to the -LEGACY_CRYPT option:
■ If you are running NetBackup in a clustered environment, you can push
configuration data to the client only from the active node.
■ If you push the configuration to clients that are located in a cluster, do the
following: Specify the hostnames of the individual nodes (not virtual names)
in the clients list.
■ When you finish the restore of encrypted files from a client, rename or delete
the key file created. Move or rename your own key file to its original location
or name. If you do not re-establish your key file to its original location or name,
you may not be able to restore your own encrypted backups.
■ Existing 40-bit encryption license keys or 56-bit encryption license keys are
valid for upgrades.
■ A privately defined NetBackup 40-bit DES key encrypts the pass phrase that
bpinst -LEGACY_CRYPT sends over the network.

■ The key file on each NetBackup client is encrypted with a privately defined
NetBackup DES key. The key can be 40 bits or 56 bits depending on how the
client is configured. Restrict access to the key file to the administrator of the
client computer. On a UNIX client, the owner of the key file should be root and
the mode bits should be 600. The key file should not be exportable through
NFS.
■ The key file must be the same on all nodes in a cluster.
■ Remember pass phrases. In a disaster recovery situation, you may have to
recreate a key file on a client by using bpinst -LEGACY_CRYPT. For example,
suppose a NetBackup client that is named orca performs encrypted backups
and an accident occurs that causes orca to lose its files. In this case you must
reinstall and configure encryption on the client to restore your backups.
For additional information about NetBackup encryption, refer to the NetBackup
Security and Encryption Guide.
See the NetBackup Troubleshooting Guide for details on how to restore the
operating system and NetBackup.
 NetBackup Commands 179
bpinst

To provide disaster recovery when you use encryption (client named orbit)
1 Reinstall the operating system on orbit.
2 Reinstall and configure the NetBackup client software on orbit.
3 Reinstall and configure encryption on orbit by using the following command:

# bpinst -LEGACY_CRYPT -crypt_option allowed

4 Activate bpinst -LEGACY_CRYPT to create a pass phrase by using the following

command:

# bpinst -LEGACY_CRYPT -passphrase_prompt orbit

Enter new NetBackup pass phrase: *********************
Re-enter new NetBackup pass phrase: *********************

Enter the pass phrase that is used on orca.

5 Activate bpinst -LEGACY_CRYPT for each subsequent pass phrase that is used
on orbit by entering the following:

# bpinst -LEGACY_CRYPT -passphrase_prompt orbit

Enter new NetBackup pass phrase: *********************
Re-enter new NetBackup pass phrase: *********************

6 Restore the backed up files to orbit.

EXAMPLES
EXAMPLE 1
The following command (all on one line) configures 40-bit DES encryption on
UNIX clients in a policy named policy40:

# bpinst -LEGACY_CRYPT -crypt_option allowed -crypt_strength des_40

-policy_encrypt 1 -policy_names policy40

This example command uses the -policy_encrypt option to set the Encryption
attribute for the policy. You can also use the NetBackup administrator utility to
set the Encryption attribute.
EXAMPLE 2
The following command uses the -passphrase_prompt option to create a passphrase
on all clients in a policy named policy40:
180 NetBackup Commands
bpinst

# bpinst -LEGACY_CRYPT -passphrase_prompt -policy_names policy40

Enter new NetBackup pass phrase: *********************
Re-enter new NetBackup pass phrase: *********************

EXAMPLE 3
The following command (all on one line) specifies that the NetBackup client named
strong must use 56-bit DES encryption:

# bpinst -LEGACY_CRYPT -crypt_option required -crypt_strength des_56

strong

EXAMPLE 4
The following command displays a verbose listing of the configuration for the
client named strong:

# bpinst -LEGACY_CRYPT -verbose strong

BPCD protocol version 7.0.0 on client strong

40-bit library version is 3.1.0.40 on client strong
56-bit library version is 3.1.0.56 on client strong
BPCD platform is redhat for client strong
Current configuration entries are:
CRYPT_KEYFILE = /usr/openv/netbackup/keyfile
CRYPT_LIBPATH = /usr/openv/lib
CRYPT_OPTION = required
CRYPT_STRENGTH = des-56
V_PATH_SHARE = /usr/openv/share
No update of NetBackup configuration required for client strong
No update of NetBackup pass phrase required for client strong

FILES
The following are the files that are used on UNIX and Linux systems:
■ UNIX server command

/usr/openv/netbackup/bin/bpinst

■ UNIX client encryption libraries for 40-bit DES and 56-bit DES

/usr/openv/lib/libvdes*.*

■ UNIX client encryption key file for 40-bit DES and 56-bit DES

/usr/openv/netbackup/keyfile
 NetBackup Commands 181
bpinst

■ UNIX client encryption key file utility for 40-bit DES and 56-bit DES

/usr/openv/netbackup/bin/bpkeyfile

■ UNIX client encryption key file utility for 128-bit OpenSSL cipher and 256-bit
OpenSSL cipher

/usr/openv/netbackup/bin/bpkeyutil
/usr/openv/share/ciphers.txt

The following are the files that are used on Windows systems:
■ Windows server command

install_path\NetBackup\bin\bpinst.exe

■ Windows client encryption key file

install_path\NetBackup\var\keyfile.dat

■ Windows client encryption libraries

install_path\bin\libvdes*.dll

■ Windows client encryption key file utility

install_path\bin\bpkeyfile.exe
install_path\share\ciphers.txt
182 NetBackup Commands
bpkeyfile

bpkeyfile
bpkeyfile – run the legacy key file utility that is used for NetBackup standard
encryption

SYNOPSIS
<admin_dir_path>bpkeyfile [-stdin] [-change_key_file_pass_phrase]
[-change_netbackup_pass_phrase] [-display] key_file_path
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

AVAILABILITY
The bpkeyfile command is available only with the NetBackup Encryption option.

DESCRIPTION
bpkeyfile creates or updates a file that contains the information that is used to
generate DES encryption keys. The information is generated based on a NetBackup
phrase that you supply. You supply a key-file pass phrase to encrypt the key file.
NetBackup client software uses an encryption key that is calculated from the key
file information to encrypt files during backups or decrypt files during restores.
If the file exists, you are prompted to enter the current key-file pass phrase.
If you specify -change_key_file_pass_phrase, you are prompted for a new
key-file pass phrase. If you enter an empty pass phrase, a standard key-file pass
phrase is used.
If you use the standard key-file pass phrase, bpcd runs automatically. If you use
your own key-file pass phrase, start bpcd with the -keyfile argument.
For more information on how to start bpcd with the -keyfile argument, refer to
the NetBackup Security and Encryption Guide.

OPTIONS
-stdin
Reads pass phrases from standard input. By default, bpkeyfile reads the
pass phrases that you are prompted to input from your terminal window.
 NetBackup Commands 183
bpkeyfile

-change_key_file_pass_phrase (or -ckfpp)

Changes the pass phrase that is used to encrypt the key file.
-change_netbackup_pass_phrase (or -cnpp)
Changes the pass phrase that is used to encrypt NetBackup backups and
archives on this client.
-display
Displays information about the key file.
key_file_path
The path of the key file that bpkeyfile creates or updates.

NOTES
The pass phrases that NetBackup uses can be from 0 to 63 characters long. To
avoid compatibility problems between systems, restrict the characters in a pass
phrase to printable ASCII characters: from the Space character (code 32) to the
tilde character (code 126).
The bpkeyfile command is used for legacy encryption.

FILES
Client encryption key file:
UNIX and Linux systems: /usr/openv/netbackup/keyfile
Windows systems: install_path\NetBackup\bin\keyfile.dat
184 NetBackup Commands
bpkeyutil

bpkeyutil
bpkeyutil – run the key file utility that is used for NetBackup standard encryption

SYNOPSIS
<admin_dir_path>bpkeyutil [-stdin | -insert | -delete] [-display]
[-client client_name1[,client_name2,...]] [-M server]
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

AVAILABILITY
The bpkeyutil command is available only with the NetBackup Encryption option.

DESCRIPTION
The bpkeyutil command updates a key file that contains the keys that are used
for encryption and decryption. The keys are generated based on the private
NetBackup pass phrases that you supply. The key file is encrypted by using a key.
The NetBackup client software uses an encryption key from the key file to encrypt
files during a backup or decrypt files during a restore.

OPTIONS
-stdin
Reads pass phrases from standard input. By default, bpkeyutil reads the
pass phrases that you are prompted to input from your terminal window.
-insert
Inserts a new NetBackup pass phrase to the key file to encrypt NetBackup
backups and archives on this client.
-delete
Deletes an existing pass phrase from the key file.
-display
Displays information about the key file.
 NetBackup Commands 185
bpkeyutil

-client client_name1[,client_name2,...,client_namen]
Name of the client where the key file resides. The default is the local client.
You may specify multiple client names that are separated by commas. You
can only use this argument if you are a NetBackup administrator.
-M server
Name of the master server of the client. The default is the master server
defined in the local client's configuration. You can only use this argument if
you are a NetBackup administrator on the specified master server.

NOTES
Note the following items when you use the bpkeyutil command:
■ The bpkeyutil command is used for standard encryption.
■ The key file must be the same on all nodes in a cluster.

FILES
Client encryption key file:
UNIX and Linux systems: /usr/openv/var/keyfile.dat
Windows systems: install_path\NetBackup\var\keyfile.dat
186 NetBackup Commands
bplabel

bplabel
bplabel – write NetBackup label on tape media

SYNOPSIS
<admin_dir_path>bplabel -m media_id -d density [-o] [-p
volume_pool_name] [-n drive_name | -u device_number] [-host
media_server] [-erase [-l]] [-priority number]
On UNIX and Linux systems, <admin_dir_path> is
/usr/openv/netbackup/bin/admincmd/
On Windows systems, <admin_dir_path> is
<install_path>\NetBackup\bin\admincmd\

DESCRIPTION
The bplabel command writes a NetBackup label on the specified media. Labels
are required only for the media that were last used for NetBackup catalog backups
or by a non-NetBackup application. You can use this command to erase and label
the media that is unassigned in a volume database. In addition, you can use this
command to assign specific media IDs. The NetBackup Device Manager daemon
or service (ltid) must be active for bplabel to succeed. You also must manually
assign the drive by using the NetBackup Device Monitor unless you include the
-u option on the bplabel command.

Caution: Ensure that the media does not contain required backups. After the media
is relabeled, any backups that were on it cannot be restored.

Any authorized user can run this command.

For more information about NetBackup authorization, refer to the NetBackup
Security and Encryption Guide.
The following are some items about how to use this command:
■ The -m and -d options are required.
■ The -p option is required if the media ID is not in the NetBackup volume pool.
■ If the data on the media is in a recognized format and the -o option is not
specified, bplabel prompts you to confirm the overwrite. Data format
recognition works only if the first block on a variable length media is less than
or equal to 32 kilobytes.
■ Use the bplabel command only for tapes.
 NetBackup Commands 187
bplabel

You must have administrator privileges to run this command.

OPTIONS
-d density
A required option that specifies the density of the tape drive on which the
media is mounted. The tape mount request must be performed on a drive
type that satisfies the -d option.

Note: Do not use capital letters when you enter the density. Incorrect density
syntax causes the command to fail and an "Invalid Density Drive Type"
message to appear.

The valid densities are as follows:

4mm (4-mm Cartridge)

8mm (8-mm Cartridge)

dlt (DLT Cartridge)

hcart (1/2 Inch Cartridge)

qscsi (1/4 Inch Cartridge)

-erase [-l]
This option is used to erase the media. Short erase is the default erase. If -l
option is specified, the media is long erased. A long erase operation can take
a long time depending on the type of drive.
-host media_server
The media_server variable is the host where the drive is attached. This drive
is the drive that is used to mount the media. By default, if this option is not
used, the command runs on the local system.
-m media_ID
A required option that specifies the external media ID that is written to the
tape label as a media ID. You can enter the media ID in either uppercase or
lowercase. Internally, it always converts to uppercase. The media ID must be
six or fewer alphanumeric characters.
-n drive_name
Unconditionally assigns the stand-alone drive that drive_name specifies. The
drive must contain media and be ready. By using this option, manual operator
assignment is not required. The name for the drive can be obtained from the
Media Manager configuration.
188 NetBackup Commands
bplabel

-o
Unconditionally overwrites the selected media ID. If this option is not
specified, bplabel prompts for permission to overwrite the media that meets
any of the following conditions:
Contains a NetBackup media header.
Is a NetBackup catalog backup media.
Is in TAR, CPIO, DBR, AOS/VS, or ANSI format.
-p volume_pool_name
This option is required if the media ID is defined in the Enterprise Media
Manager Database but is not in the NetBackup volume pool.
volume_pool_name must specify the correct pool.
-priority number
Specifies a new priority (number) for the label job that overrides the default
job priority.
-u device_number
Unconditionally assigns the stand-alone drive that device_number specifies.
The drive must contain media and be ready. By using this option, manual
operator assignment is not required. The number for the drive can be obtained
from the Media Manager configuration.

NOTES
tpconfig -d, tpconfig -l, and vmoprcmd may truncate long drive names. Use
tpconfig -dl to obtain the full drive name.

SEE ALSO
ltid, vmadm
 NetBackup Commands 189
bplist

bplist
bplist – list the backed up and archived files on the NetBackup server

SYNOPSIS
<nbu_dir_path>bplist [-A | -B] [-C client] [-S master_server] [-k
policy] [-t policy_type] [-F] [-R [n]] [-b | -c | -u] [-l] [-r]
[-flops options] [-Listseconds] [-T] [-unix_files] [-nt_files] [-s
date] [-e date] [-I] [-PI] [-keyword keyword_phrase] [filename]
[-Listpolicy]
On UNIX and Linux systems, <nbu_dir_path> is /usr/openv/netbackup/bin/
On Windows systems, <nbu_dir_path> is <install_path>\NetBackup\bin\

DESCRIPTION
The bplist command shows a list of previously archived or backed up files
according to the options that you specify. You can choose the file or directory and
the time period that you want the listing to cover. Directories can be recursively
displayed to a specified depth. bplist shows only the files that you have read
access to. It lists the files only if an administrator account performs the user
backup. A non-administrator or backup operator cannot use bplist.
You also must own or have read access to all directories in the file paths. You can
list the files that were backed up or archived by another client only if the
NetBackup administrator has validated you to do so.
If you create the following directory with public-write access, bplist creates a
debug log file in this directory that you can use for troubleshooting:

UNIX and Linux systems: usr/openv/netbackup/logs/bplist/

Windows systems: install_path\NetBackup\logs\bplist\

OPTIONS
-A | -B
Specifies whether to produce the listing from archives (-A) or backups (-B).
The default is -B.
-C client
Specifies a client name to use for finding backups or archives to list. This
name must be as it appears in the NetBackup configuration. The default is
the current client name.
190 NetBackup Commands
bplist

-S master_server
UNIX and Linux systems: -s specifies the name of the NetBackup server. The
default is the first SERVER entry that is found in the
/usr/openv/netbackup/bp.conf file.

Windows systems: -s specifies the name of the NetBackup server. The default
is the server designated as current on the Servers tab of the Specify NetBackup
Machines dialog box. To display this dialog box, start the Backup, Archive,
and Restore user interface on the client. Then click Specify NetBackup
Machines on the File menu.
-t policy_type
Specifies one of the following numbers that correspond to the policy type.
The default is 0 for all clients except Windows, where the default is 13.
0 = Standard

4 = Oracle

6 = Informix-On-BAR

7 = Sybase

8 = MS-SharePoint

10 = NetWare

13 = MS-Windows

14 = OS/2

15 = MS-SQL-Server

16 = MS-Exchange-Server

19 = NDMP

35 = NBU-Catalog

The following policy types apply only to NetBackup Enterprise Server.

11 = DataTools-SQL-BackTrack

17 = SAP

18 = DB2

20 = FlashBackup

21 = Split-Mirror

22 = AFS

25 = Lotus Notes
 NetBackup Commands 191
bplist

39 = Enterprise-Vault

-k policy
Names the policy to search to produce the list. If not specified, all policies
are searched.
-F
Specifies that in the list output, symbolic links (which apply only to UNIX
clients) end with a trailing @ and executable files with a trailing *.
-R [n]
Recursively lists the subdirectories that are encountered to a depth of n. The
default for n is 999.
-b | -c | -u
Specifies an alternate date-time to be used for printing with the -l option:
-b displays the backup date and time of each file.

-c displays the last inode modification date and time (UNIX and Linux systems)
or creation date and time (Windows systems) for each file.
-u displays the last access date and time of each file.

The default is to display the time of the last modification of each file.
-l
On Windows systems, -l shows the file details.
On UNIX and Linux systems, -l lists the following file details in a long format:
Mode, owner, group, size in bytes, and time of last modification for each file
(see the EXAMPLES section). The list shows the mode of each file as 10
characters that represent the standard UNIX file permissions. The first
character is one of the following:
d (specifies a directory)

l (specifies a link)

m (specifies a file that migrated by Veritas Storage Migrator for UNIX or

Veritas Data Lifecycle Manager)
- (specifies a file)

The next nine characters show the three sets of permissions. The first set
shows the owner’s permissions, the next set shows the user-group
permissions, and the last set shows permissions for all other users. Each set
of three specifies the read, write, and execute permissions as follows:
r = the file is readable
192 NetBackup Commands
bplist

w = the file is writable

x = the file is executable

- = the indicated permission is not granted

-Listseconds
Specifies that seconds granularity be used for the timestamp when the -l
option is used.
-r
On Windows systems, -r lists the disk images that were backed up. The default
is to list file systems.
On UNIX and Linux systems, -r lists the raw partitions that were backed up.
The default is to list file systems.
-flops options
Lists Backup Exec files or both Backup Exec and NetBackup files. The default
(-flops not specified) is to list only NetBackup files.
To list only Backup Exec files specify:

-flops 524288

To list Backup Exec and NetBackup files specify:

-flops 1048576

-T
Lists the directories in true-image backups. The default is to list
non-true-image backups.

Note: TIR information does not appear for synthetic full backups, even though
TIR information is used for synthetic full backups.

-unix_files
Lists the files and directories in UNIX format. For example: /C/users/test
-nt_files
Lists the files and directories in Windows format. For example: C:\users\test
-s date, -e date
Specifies the start date (-s) and end date (-e) for the listing.
-s specifies a start date and time for the listing. The resulting list shows only
files in backups or the archives that occurred at or after the specified date
and time.
 NetBackup Commands 193
bplist

The required date and time values format in NetBackup commands varies
according to your locale. The /user/openv/msg/.conf file (UNIX and Linux)
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.
More information is available about the locale of your system.
See the "Specifying the locale of the NetBackup installation" topic in the
NetBackup Administrator's Guide, Volume II.
The valid range of dates is from 01/01/1970 00:00:00 to 01/19/2038 03:14:07.
The default is the current date minus six months.
-e specifies an end date and time for the listing. The resulting list shows only
files from the backups or the archives that occurred at or before the specified
date and time. Use the same format for start date and time. The default is the
current date and time.
-I
Specifies a search that is case insensitive. The capitalization is not considered
when it compares names (for example, Cat matches cat).
-PI
Specifies a path-independent search, which means that NetBackup searches
for a specified file or directory without regard to the path. For example, a file
with the name test exists in the three following directories. A search for
test finds all three instances of the file:

UNIX and Linux systems:

/tmp/junk/test

/abc/123/xxx/test

/abc/123/xxx/yyy/zzz/test

Windows systems:

\tmp\junk\test

\abc\123\xxx\test

\abc\123\xxx\yyy\zzz\test
194 NetBackup Commands
bplist

-keyword keyword_phrase
Specifies a keyword phrase for NetBackup to use when it searches for backups
or archives from which to restore files. The phrase must match the one that
was previously associated with the backup or archive by the -k option of
bpbackup or bparchive.

You can use this option in place of or in combination with the other restore
options to make it easier to restore backups and archives. Use the following
meta-characters to help match keywords or parts of keywords in the phrase:
* matches any string of characters.
? matches any single character.

[ ] matches one of the sequence of characters that is specified within the

brackets.
[ - ] matches one of the range of characters, separated by the "-".
The keyword phrase can be up to 128 characters in length. All printable
characters are permitted including space ("") and period (".").
The phrase must be enclosed in double quotes ("...") or single quotes (‘...’ ).
The default keyword phrase is the null (empty) string.

Note: The keyword phrase is ignored when you use the following policy types:
DB2, Informix-On-BAR, Oracle, SAP, MS-SQL-Server, Sybase.

filename
Names the file or directory to list. Any files or directories that you specify
must be listed at the end, following all other options. If you do not specify a
path, the default is the current working directory.
For Windows systems, use uppercase for the drive letter. For example:

C:\NetBackup\log1

For directories, if you do not use the -R option, include the trailing path
separator as in the following:
UNIX and Linux systems: bplist -l "/home/user1/*"
Windows systems: bplist -l "D:\WS_FTP.LOG\*"
If you use the asterisk meta-character (*), use quotation marks around the
file name for the command to work properly.
-Listpolicy
Includes the schedule type and policy name in the command output.
 NetBackup Commands 195
bplist

EXAMPLES
EXAMPLE 1 - List recursively in long format
To list recursively in long format, the files that were backed up in /home/user1
(UNIX and Linux) or D:\WS_RTP.LOG (Windows).
On UNIX and Linux systems:

# bplist -l -R /home/user1
lrwxrwxrwx user1;usr@ eng;None 0 Apr 28 12:25 /home/user1/dirlink
drwxr-xr-x user1;usr@ eng;None 0 Apr 04 07:48 /home/user1/testdir
drwxr-x--- user1;usr@ eng;None 0 Apr 04 07:49 /home/user1/dir
-rwxr----- user1;usr@ eng;None 1002 Apr 02 09:59 /home/user1/dir/file
lrwxrwxrwx user1;usr@ eng;None 0 Apr 04 07:49 /home/user1/dir/link

On Windows systems:

# bplist -l -R D:\WS_FTP.LOG<