Professional Documents
Culture Documents
0 for
NDMP
System Administrators Guide
UNIX, Windows, and Linux
N15271C
September 2005
Disclaimer
The information contained in this publication is subject to change without notice. VERITAS Software
Corporation makes no warranty of any kind with regard to this manual, including, but not limited to,
the implied warranties of merchantability and fitness for a particular purpose. VERITAS Software
Corporation shall not be liable for errors contained herein or for incidental or consequential damages
in connection with the furnishing, performance, or use of this manual.
VERITAS Legal Notice
Copyright 2002 - 2005 VERITAS Software Corporation. All rights reserved. VERITAS, the VERITAS
Logo, and NetBackup are trademarks or registered trademarks of VERITAS Software Corporation or
its affiliates in the U.S. and other countries. Other names may be trademarks of their respective
owners.
Portions of this software are derived from the RSA Data Security, Inc. MD5 Message-Digest
Algorithm. Copyright 1991-92, RSA Data Security, Inc. Created 1991. All rights reserved.
VERITAS Software Corporation
350 Ellis Street
Mountain View, CA 94043
USA
Phone 650-527-8000
Fax 650-527-2908
www.veritas.com
Third-Party Copyrights
For a list of third-party copyrights, see the NetBackup Release Notes appendix.
ii
Contents
Accessibility Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
NDMP Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Storage Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
iii
Installation Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Adding a Drive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Enabling/Disabling DAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Setting Up Clustering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Post-Installation Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
iv
Chapter 7. Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Notes on DAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Troubleshooting NetBackup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Types of Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Troubleshooting Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Troubleshooting DAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Testing a Robot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
ndmp_start_notify (UNIX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
ndmp_end_notify (UNIX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
ndmp_start_path_notify (UNIX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Contents
ndmp_end_path_notify (UNIX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
ndmp_moving_path_notify (UNIX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
vi
Preface
This guide explains how to install, configure, and use VERITAS NetBackup for NDMP
(Network Data Management Protocol). In this guide, VERITAS NetBackup is referred to
as NetBackup.
This guide is intended for the system administrator responsible for installing, configuring,
and using NetBackup for NDMP, and assumes a thorough working knowledge of how to
administer both NetBackup and the NDMP host platform.
Getting Help
You can find answers to questions and get help from the NetBackup documentation and
from the VERITAS technical support web site.
vii
Getting Help
Contact the VERITAS Technical Support staff and post questions to them
From http://support.veritas.com, you can complete various tasks to obtain specific types
of support for NetBackup:
1. Subscribe to the VERITAS Email notification service to be informed of software alerts,
newly published documentation, Beta programs, and other services.
a. From the main http://support.veritas.com page, select a product family and a
product.
b. Under Support Resources, click Email Notifications.
Your customer profile ensures you receive the latest VERITAS technical
information pertaining to your specific interests.
2. Locate the telephone support directory at http://support.veritas.com by clicking the
Phone Support icon. A page appears that contains VERITAS support numbers from
around the world.
Note Telephone support for NetBackup is only available with a valid support
contract. To contact VERITAS for technical support, dial the appropriate phone
number listed on the Technical Support Guide included in the product box and
have your product license information ready for quick navigation to the proper
support group.
3. Contact technical support using e-mail.
viii
Accessibility Features
a. From the main http://support.veritas.com page, click the E-mail Support icon.
A wizard guides you to do the following:
Accessibility Features
NetBackup contains features that make the user interface easier to use by people who are
visually impaired and by people who have limited dexterity. Accessibility features
include:
Support for assistive technologies such as screen readers and voice input (Windows
servers only)
Support for keyboard (mouseless) navigation using accelerator keys and mnemonic
keys
Preface
ix
The title and product version of the manual on which you are commenting
Your comment
Your name
NDMP Policies
Storage Units
NetBackup can also create a SnapVault disk copy from a NAS snapshot.
Configuration details are contained in the NetBackup Advanced Client System
Administrators Guide.
For a list of NAS vendors that NetBackup currently supports for SnapVault and
NAS_Snapshot, refer to the Advanced Client Configuration and Compatibility online
document (see the preface of this manual for help accessing that document).
The enhanced ability to execute customized scripts during a backup, especially for
relational databases residing on NAS devices.
A separate instance of an NDMP server process exists for each connection to an NDMP
client. That is, if two backups are in progress, an NDMP server process exists for each
backup.
NDMP Storage Unit
An NDMP storage unit stores the backup data for an NDMP host. The tape drives in this
storage unit attach directly to the NDMP host or can be configured on a SAN.
Note that NDMP storage units cannot be used to store data for non-NDMP hosts, and
NetBackup disk storage units cannot be used for NDMP tasks.
Redirected Restore (to a Different Client)
In a redirected restore, files are restored to a client other than the one from which they
were originally backed up. In NetBackup for NDMP, this means the restore data travels
from an NDMP host (or NetBackup media server) with a locally attached storage device
to another NDMP host on the network.
Remote NDMP
See NDMP Backup to Media Manager Devices.
Three-Way Backup/Restore
In a three-way backup or restore, data travels between an NDMP host and a storage
device attached to another NDMP host or to a NetBackup media server. This contrasts
with local NDMP backup/restore, where the data travels between an NDMP hosts disk
and a storage device directly attached to the same NDMP host.
The NetBackup master or media server that has NetBackup for NDMP installed is
called a NetBackup for NDMP server.
The host where the NDMP server application resides is called an NDMP host.
The NetBackup software is a client of the NDMP server application. The NetBackup
for NDMP application allows NetBackup to be an NDMP client. The NDMP hosts, on
the other hand, act as NetBackup clients.
Network
NDMP Host
NDMP Host
LAN/WAN
NDMP
host
NetBackup for
NDMP server
FC/SAN
Disks
Tape library
LAN/WAN
NDMP
host
NDMP
Host
NetBackup for
NDMP server
Disks
Tape library
LAN / WAN
NetBackup
for NDMP
server
NDMP
host
FC/SAN
Tape library
Disks
NOTE: The NetBackup drive(s) must be in Media Manager type storage units.
NDMP Policies
NDMP Policies
After installing and configuring NetBackup for NDMP, you can schedule backups by
creating an NDMP policy in NetBackup.
An NDMP policy can have one or more NetBackup clients. Each NetBackup client must
be an NDMP host (see figure NDMP and NetBackup Hosts as Clients of Each Other on
page 6). Note that you do not install any NetBackup software on the NDMP hosts.
The allowable backup types for schedules in an NDMP policy are: Full, Cumulative
Incremental, or Differential Incremental. User initiated backups and archives are not
allowed, because the NDMP protocol does not permit these tasks.
Restores of NDMP host backups can be initiated from any NetBackup media server that is
within the same overall NetBackup storage domain and uses the same NetBackup master
server as used by the media server that performed the backup. The data can be restored to
the NDMP host where it was backed up, or to another NDMP host.
NDMP policies can use either NDMP storage units or Media Manager storage units.
10
Storage Units
Storage Units
NetBackup uses either NDMP-type storage units (for local or three-way backup), or
Media Manager storage units (for backup to devices attached to a NetBackup media
server).
Tape drives 1, 3, and 5 are attached to NDMP hosts and are in NDMP storage units
that can be used for NDMP backup (local or three-way).
The commands that control these drives originate on the NetBackup for NDMP server
and are sent through the NDMP connection on the network. The NDMP server
application on each NDMP host translates the NDMP commands into SCSI
commands for the local drives.
Tape drives 2 and 4 are attached to a NetBackup server and are in non-NDMP storage
units, controlled in the same way as other drives on NetBackup servers. Depending
on the type of storage unit, these drives can be used for the following:
11
Storage Units
In the case of tape drives in Media Manager storage units, they can be used for
both NDMP (local or three-way) and non-NDMP backup.
In this diagram, all tape drives except drive 4 can be used for NDMP backup.
NDMP and Non-NDMP Storage Units
LAN/WAN
#
+
Drive 1
#
Drive 2
NDMP
host
NDMP
host
NDMP
host
NB for
NDMP
media
server
Drive 5
Drive 3
Drive 4
TLD
Robot
# In NDMP storage
unit
+ In NetBackup
Media Manager
storage unit
* In another type of
NetBackup storage
unit (not NDMP or
Media Manager)
12
NDMP backups.
Drive 2 (in Media Manager storage unit) can be used for NDMP
or non-NDMP backup.
Storage Units
Commands to
control robot
NetBackup
NDMP
for
Host
NDMP
Server
Robotic
Control
Robot
NetBackup server
The robot is controlled in the same way as other robots on NetBackup servers.
Robotics Control Attached to a NetBackup Server
NetBackup
NDMP
Server
Host
Commands to
control robot
Robotic
Control
Robot
13
Over the network, from an NDMP host without its own storage device to a
NDMP host (or NetBackup media server) with a locally attached storage device
(three-way backup).
4. The NDMP server application sends information to the NetBackup for NDMP server
about the files that were backed up. This information is stored in the NetBackup file
database.
5. The NDMP server application sends status about the backup operation to the
NetBackup for NDMP server.
14
NetBackup
Administration
Console
File
Database
bprd
bpdbm
nbproxy
nbpem
nbproxy
EMM
database
nbemm
nbrb
g
lo
ta
Ca
bpcd
n
io
at
rm
fo
in
NetBackup Master
or Media Server
nbjm
bpbrm
Network
Connection
bptm
pe
Ta
ndmpagent
t
es
qu
e
R
ltid
3-way
NDMP Host
NDMP Server
OS
NDMP Host
NDMP Server
OS
Tape
Disk
Disk
Local
15
From a tape drive to a local disk (tape drive and disk are on the same NDMP host)
Over the network, from an NDMP host (or NetBackup media server) with a
locally attached storage device to another NDMP host (three-way
backup/restore)
4. The NDMP server application sends status about the restore operation to the
NetBackup for NDMP server.
16
bprd is on the
master server
NetBackup Master
or Media Server
bprd
bpcd
EMM
database
Network
Connection
NetBackup Media ID
bptm
e
Tap
ltid
ndmpagent
est
equ
3-way
NDMP Host
NDMP Server
OS
NDMP Host
NDMP Server
OS
Disk
Disk
Tape
Local
17
DAR must be supported by the NDMP host where the NDMP server application
resides.
The backup must have been made by NetBackup 4.5 GA or later, with the catalog in
binary format (binary format is the default).
18
This chapter explains how to install the NetBackup for NDMP application on NetBackup
servers.
Installation Notes
The NetBackup for NDMP master/media server must be running NetBackup 6.0 or
later.
The NetBackup for NDMP 6.0 software supports Solaris, HP-UX, Red Hat Linux, AIX,
and Windows 2000/2003 (including 64-bit) master or media servers.
For a detailed list of NAS platforms supported by NetBackup for NDMP, refer to
NetBackup for NDMP Information on the Web on page x.
For making snapshots of NDMP (NAS) hosts, NetBackup Advanced Client software
must be installed on the NetBackup master server, and on the clients that are used to
perform backups. For more information, refer to the NetBackup Advanced Client System
Administrators Guide.
Drives and robots attached to the NDMP host must be types supported by the NDMP
host and NetBackup. See NDMP Storage Units on page 11 for a list of supported
robot types. For more information on storage devices, see the NetBackup Media
Manager System Administrators Guide (UNIX or Windows).
For notes and tips on your particular NDMP host, refer to NetBackup for NDMP
Information on the Web on page x.
19
4. Insert the CD-ROM containing NetBackup for NDMP software in the drive.
5. Change your working directory to the CD-ROM directory:
cd /cd_rom_directory
Where cd_rom_directory is the path to the directory where you can access the
CD-ROM. On some platforms, it may be necessary to mount this directory.
6. To install NetBackup for NDMP, execute the following:
./install
Since other NetBackup products are included on the CD-ROM, a menu appears.
7. Select NetBackup Add-On Product Software.
a. Select the NetBackup for NDMP option.
b. Enter q to quit the menu.
c. When asked if the list is correct, answer y.
8. If this NetBackup for NDMP server is not your master server, also install your NDMP
license key on the master.
9. In a clustered environment, the above steps must be done on each node in the cluster.
20
Note If you are installing in a cluster environment, unfreeze the active node after the
installation completes. For information about unfreezing a service group, see the
clustering section in the NetBackup High Availability System Administrators Guide for
the cluster software you are running
21
Note If you are installing in a cluster environment, unfreeze the active node after the
installation completes. For information about unfreezing a service group, see the
clustering section in the NetBackup High Availability System Administrators Guide for
the cluster software you are running
./ndmpmoveragent.stop
-f
-f
-f
-f
-f
/usr/openv/lib/libndmp_bpfsmap.s?
/usr/openv/lib/libndmpclient.s?
/usr/openv/volmgr/bin/set_ndmp_attr
/usr/openv/share/version_ndmp
/usr/openv/netbackup/bin/ndmpmoveragent
where ? is a wildcard.
5. Restart ltid.
Note If uninstalling in a cluster environment, unfreeze the active node after the uninstall.
22
This chapter explains how to configure backups on storage devices attached to NDMP
hosts. Only NDMP-specific steps are described.
Note As an alternative to the device configuration procedures in this chapter, you can use
the NetBackup Device Configuration wizard to discover and configure robots and
drives that are attached to an NDMP host (requires NDMP protocol versions V3 or
V4).
To configure and use the NAS_Snapshot method when backing up NDMP host data, see
the NetBackup Advanced Client System Administrators Guide.
The following topics are covered in this chapter:
Enabling/Disabling DAR
Setting Up Clustering
23
Before NetBackup can carry out backups, it must have access to the NDMP host. To
authorize this access, use the following dialog from the NetBackup Administration
Console on your NetBackup for NDMP master server. You can also use the NetBackup
Device Configuration wizard to create this authorization.
Note Do the following on the master server (not media server) if you are going to create
snapshots using the Advanced Client NAS_Snapshot method.
To authorize NetBackup access to the NDMP host (from Administration Console)
1. On the NetBackup server: under Media and Device Management > Devices, click on
NDMP Hosts. Under Actions, choose New > NDMP Host.
The NDMP host name dialog appears.
2. Enter the name of the NDMP server that NetBackup will back up.
Note This NDMP host name is case-sensitive. Whenever this host name is used (such as
when configuring tape drives and storage units for this host), the name must be
identical to the name entered here.
3. Click OK.
24
The term credentials refers to the username and password that NetBackup will use to
access the NDMP host.
Create a login
to this NDMP
host for all
NetBackup
servers.
Specify
different
NDMP logins
for particular
NetBackup
servers.
Username: the user name under which NetBackup will access the NDMP server.
This user must have permission to execute NDMP commands.
25
Note To see if your NDMP host vendor requires a particular username or access level
(such as root), refer to NetBackup for NDMP Information on the Web on page x.
Password and Confirm Password: enter the password for this user.
Use different credentials for this NDMP host on each media server
Select this option to specify NDMP logins for particular NetBackup servers, then click
Advanced Configuration. The Advanced NDMP Credentials dialog appears.
26
6. Select a NetBackup server and specify the username and password it will use to
access the NDMP host.
7. Click OK. NetBackup validates the username and password.
The NetBackup server and username appear in the Advanced NDMP Credentials
dialog.
8. If needed, click Add again to specify other servers and user names.
9. Repeat this procedure for each NDMP host that NetBackup will back up.
Three-way backups: for the NDMP host name, specify the NDMP host that has no
attached tape drive.
NDMP to Media Manager backups: for the NDMP host name, specify the NDMP
host that will be backed up to the media manager storage unit defined on the
NetBackup server. See the chapter titled Configuring NDMP Backup to NetBackup
Media Servers for more information.
27
On the NetBackup for NDMP server, use Media and Device Management in the
Administration Console to add drives and robots. As an alternative, you can use the
NetBackup Device Configuration wizard.
The following procedures and examples treat NDMP configuration issues only. See the
NetBackup Media Manager System Administrators Guide for general information on
configuring NetBackup media.
For more information on configuring storage devices for specific NDMP hosts, refer to
NetBackup for NDMP Information on the Web on page x.
Note These procedures do not apply to setting up devices attached to the NetBackup
media server. To back up NDMP data to Media Manager devices (remote NDMP),
storage units are configured in the same way as ordinary NetBackup (non-NDMP)
devices. For details, refer to Configuring NDMP Backup to NetBackup Media
Servers on page 45, and to the NetBackup Media Manager System Administrators
Guide.
2. Select Media and Device Management > Devices in the left pane.
3. On the Actions menu, select New, then select Robot... from the popup. The Add
Robot dialog appears.
28
Explained in online
help or in the
Media Manager
System
Administrators
Guide.
Explained in the
following steps.
For assistance with the Add Robot dialog, refer to the online help or to the NetBackup
Media Manager System Administrators Guide. The steps below explain the portions that
are unique to configuring NetBackup for NDMP.
4. For Media Manager host, specify the host that manages the EMM database (by
default, this is the NetBackup master server).
5. For Device host, use the pull-down to select the NetBackup media server.
6. Specify Robot type and number as explained in the NetBackup Media Manager System
Administrators Guide.
7. Under Robot control, click Robot control is attached to an NDMP host.
29
8. For Robot device path, enter the device name of the robot. There is no need to include
the NDMP host name as part of the device path.
To determine the device name of the robot, refer to NetBackup for NDMP
Information on the Web on page x for information pertaining to your NDMP host.
9. For NDMP host name, enter the name of the NDMP host to which the robot is
attached.
10. Specify the Bus, Target, and LUN values if they are required by the NDMP host. Refer
to NetBackup for NDMP Information on the Web on page x for information
pertaining to your NDMP host. By default, the bus, target and lun values are 0.
11. Click OK.
A popup message asks if you want to stop and restart the device manager service (or
daemon). Click Yes.
30
Adding a Drive
Using the NetBackup Administration Console:
1. Select Media and Device Management > Devices in the left pane.
2. On the Actions menu, select New, then select New Drive (on UNIX, Tape Drive) from
the popup. The Add Drive dialog appears.
31
b. For Device host, select the name of the NetBackup media server. Use the
pull-down to select media servers already defined, or click Add to enter a new
one.
c. For Path (called No rewind device on UNIX), enter the device file name of the
tape drive, such as nrst2a. Refer to the NAS vendor documentation for your drive
for the correct format of the device file name.
As an alternative, you can use the following command to find the device file
name for the drive, if the NDMP host is running NDMP protocol V3 or later:
tpautoconf -probe ndmp_host_name
32
From the NetBackup Administration Console, use the Device Monitor to ensure that
the drive is in the UP state.
33
os type "NetApp"
host id "0033625811"
34
35
3. For Storage unit name, enter a unique name for the storage unit.
4. For Storage unit type, select NDMP.
5. For On demand only: this specifies whether the storage unit is available only when a
policy or schedule specifically requests it. If this option is not used, the storage unit is
available to any NDMP policy or schedule.
6. For Storage device, select the type of device for this storage unit.
7. For NDMP host, specify the NDMP host where the tape drive is physically attached.
The remaining fields are described in the NetBackup System Administrators Guide.
36
On the NetBackup master server, create an NDMP policy to configure backups of the
NDMP host.
Note You can use the Backup Policy Configuration wizard to create NDMP policies.
Creating an NDMP policy is very similar to creating other NetBackup policy types. The
following topics explain the differences when creating NDMP policies.
See the NetBackup System Administrators Guide for more information on NetBackup
policies and the Policy utility.
Note To configure a policy for the NAS_Snapshot method and SnapVault, see the
NetBackup Advanced Client System Administrators Guide.
Attributes
Specify the following policy attributes:
If the NDMP host has more than one storage unit and you want to direct backups
for this policy to a specific storage unit, specify the name of that storage unit.
For a three-way backup, specify a storage unit that was defined for the target
NDMP host with attached tape.
For NDMP backup to Media Manager devices, specify a Media Manager storage
unit defined for a device connected to a NetBackup media server (see the
Configuring NDMP Backup to NetBackup Media Servers chapter).
Clients
In the client list, specify the following for each client in an NDMP policy:
Hostname
Name of the NDMP host
37
Files
The Backup Selections list must specify directories from the perspective of the NDMP
host.
Two examples:
/home/dir1/
/vol1
The following Backup Selections capabilities are NOT supported for an NDMP policy:
Exclude list (because client software is not installed on the NDMP host). You can,
however, exclude files by using the SET keyword as shown under Using
Environment Variables in Backup Selections list. The SET option allows you to
exclude files on a backup. The format is vendor dependent; refer to the vendors
documentation for more details on which variable can be passed and in what format.
Schedules
You can specify any of the following backup types in a schedule for an NDMP policy:
Full
Cumulative Incremental
Differential Incremental
Specify Override policy storage unit only if this client of NetBackup (the NDMP host) has
more than one storage unit and you want to use a specific storage unit for this schedule. In
this case, the client must be the only client in this NDMP policy.
38
FILESYSTEM
LEVEL
DIRECT
EXTRACT
ACL_START
In NetBackup, environment variables can be set within the Backup Selections list by
specifying one or more SET directives.
Note In the Backup Selections list, the SET directive must be the first in the list, followed
by the file systems or volumes to back up. To obtain up-to-date information on
environment variables relating to particular NAS vendors, refer to NetBackup for
NDMP Information on the Web on page x.
In general, the syntax of a SET directive is as follows:
SET variable = value
Where variable is the name of the environment variable and value is the value that is
assigned to it. The value can be enclosed in single or double quotes, and must be enclosed
in quotes if it contains a space character. For example:
SET ABC = 22
Variables accumulate as the Backup Selections list is processed. For example, if Backup
Selections contains the following entries:
/vol/vol1
SET HIST = N
/vol/vol2
SET DEF = 20
/vol/vol3
39
Enabling/Disabling DAR
The values used in each backup are saved and provided to subsequent restores of the
directory. The NDMP host may have environment variables that are set internally and
these are also saved for restores.
Enabling/Disabling DAR
By default, NetBackup for NDMP is configured to use Direct Access Recovery (DAR). For
each restore, NetBackup automatically determines if the use of DAR will speed up the
restore. NetBackup uses DAR only when it will result in a faster restore.
Note NetBackup can use DAR only if the NDMP NAS host supports it (contact your NAS
vendor for details).
DAR can be turned off if desired. This may be necessary if you are having problems with
DAR and your NDMP host is an older machine or is not running the latest NAS OS
version.
1. In the NetBackup Administration Console, expand Host Properties and click on
Master Servers or Media Servers.
2. Right-click on the name of the server and select Properties.
3. Click on General Server.
40
Enabling/Disabling DAR
41
Enabling/Disabling DAR
4. Uncheck the Use direct access recovery for NDMP restores box, and click Apply.
This disables DAR on all NDMP restores.
42
Setting Up Clustering
Setting Up Clustering
Before configuring NetBackup for NDMP for clustering, the following must be installed
on each node of the cluster:
NetBackup for NDMP software (see Installing NetBackup for NDMP on page 19 of
this manual). Note that for Windows servers, only the NetBackup for NDMP licence
key has to be installed.
1. Configure NDMP-attached robots and drives, and then storage units and policies, just
as you would in a normal, non-clustered environment:
You can use the Device Configuration wizard, or configure devices manually as
described under Authorizing Access to the NDMP Host on page 24 and
following.
To use the same robotic libraries throughout a cluster, robot numbers must be
consistent. The Device Configuration wizard attempts to ensure this
configuration. If you are configuring robots manually as described in this guide,
be sure to use the same robot number for a given robot, from one host to another
in the cluster.
2. When finished configuring devices and policies for NetBackup for NDMP, fail-over to
the next node in the cluster and configure the drives and robots.
Select the same robot number that you used when configuring the robot for the
first node.
Post-Installation Changes
After NetBackup has been configured in a clustered environment, most configuration
information is available to all nodes in the cluster, by means of a shared hard drive.
However, changes made in the Host Properties area of the Administration Console are not
available on the shared drive. Such changes apply only to the active node. Host Properties
changes made on the active node must be manually duplicated on each node, if
NetBackup is to perform exactly the same way in case of failover to another node. Refer to
the NetBackup High Availability Guide for assistance.
43
44
This chapter describes how to configure NetBackup for NDMP to make backups to Media
Manager storage units (remote NDMP). Only NDMP-specific steps are described.
The following topics are covered in this chapter:
Overview
45
Overview
Overview
Using a feature known as remote NDMP, you can back up NDMP data to a drive
configured in a Media Manager storage unit on a NetBackup media server. The drive can
be used for both NDMP backups and for non-NDMP backups. See the following diagram.
NDMP Backup to a Media Manager Storage Unit
LAN / WAN
NetBackup
for NDMP
server
NetBackup
drives in
Media
Manager
storage
unit(s).
46
47
48
This chapter describes the steps for setting up the Shared Storage Option with NetBackup
for NDMP.
The following topics are covered in this chapter:
49
LAN
NetBackup
for NDMP
server 1
NetBackup
for NDMP
server 2
NDMP
host
NDMP
host
50
For each robot, robotic control can be handled by either a NetBackup media sever or
an NDMP server (not both).
This is an outline of the steps for setting up access to a robotic drive shared between
NDMP and NetBackup servers.
For a more complete discussion of SSO, refer to the Shared Storage Option (SSO) Topics
chapter in the NetBackup Media Manager System Administrators Guide.
This procedure assumes the following:
That the requirements for SSO have been met, as described in the NetBackup Media
Manager System Administrators Guide.
That all physical devices, including the NDMP host, are correctly connected to the
network.
That the NDMP host is supported by NetBackup for NDMP. For a document that lists
supported NAS systems, see NetBackup for NDMP Information on the Web on
page x.
The -verify option verifies that the NetBackup server can access the NDMP host;
the -probe option lists the devices that are visible to the NDMP host.
3. From the NetBackup Administration Console, use the Device Configuration Wizard
to configure the devices and storage units. See Using the Device Configuration
Wizard on page 52.
Note An NDMP storage unit must be defined for each NDMP host that will be
sharing a drive. If all hosts have access to the shared drive(s), the Device
Configuration Wizard can create these storage units automatically.
51
3. Under Device Hosts, place a check beside the NetBackup media server that will
access the NDMP host, click on the server name to highlight it, and click Change.
52
53
The NDMP Hosts screen appears, showing the NDMP host(s) on which you can
configure devices.
6. On the NDMP Hosts screen, click Next to configure the NDMP-attached devices.
7. Follow the screens in the wizard to complete the configuration.
54
This chapter describes the procedures for backing up and restoring NDMP-type policies.
For backup and restore of a NAS snapshot, refer to the NetBackup Advanced Client System
Administrators Guide.
55
Only the administrator can perform NDMP backups and restores on the NetBackup
server (master or media). The NDMP protocol does not allow users to initiate a backup or
restore, and there is no NetBackup client software installed on an NDMP host.
2. Click on Policies. Right click on the NDMP policy name and select Manual Backup
from the pop-up menu.
This opens the Manual Backup dialog.
3. In the Manual Backup dialog, select a schedule, then select the clients (NDMP hosts)
that you want to back up.
If you do not select any schedules, NetBackup uses the schedule with the highest
retention level. If you do not select any clients, NetBackup backs up all configured
NDMP hosts.
4. Click OK to start the backup.
56
For the server, select the NetBackup master server. If your configuration has multiple
master servers, specify the master server that has the policy for the NDMP host that
you are restoring. If the server name is not in the pull-down, use Edit Server List to
add it.
For the source and destination clients, select the appropriate NDMP (NAS) hosts.
Note The destination host must be an NDMP host compatible with the data format of the
source (the source and destination must be of the same NAS vendor type).
Caution An NDMP restore always overwrites existing files.
If the desired hosts are not available in the pull-down, use Edit Client List to add the
client.
57
58
Troubleshooting
The following information may be useful in troubleshooting NetBackup.
Troubleshooting NetBackup
Troubleshooting DAR
Testing a Robot
Note For explanations of NetBackup status codes, refer to the NetBackup Status Codes
and Messages chapter in the NetBackup Troubleshooting Guide.
59
A tape created on an NDMP storage unit is in backup format and cannot be restored
from a non-NDMP storage unit. If you duplicate an NDMP backup image the new
copy is still in backup format and cannot be used for restores on a non-NDMP storage
unit.
In the Backup Selections list for an NDMP policy, you can include only directory
paths. Wildcards and individual file names are not allowed.
You cannot back up files where the path length is greater than 1024 characters.
On UNIX systems, the NetBackup avrd process utilizes ICMP (Internet Control
Message Protocol) to ping NDMP hosts to verify network connectivity. This protocol
is required for the NetBackup for NDMP product.
If backup or restore jobs are running slowly, verify that the network interface cards
(NIC) are set to full duplex. Half duplex often causes poor performance. For
assistance viewing and resetting duplex mode for a particular NAS host, consult the
documentation provided by the manufacturer. You may be able to use the ifconfig (or
ipconfig) command, as explained in the NetBackup Troubleshooting Guide.
Notes on DAR
DAR can be used when restoring backups that were made by NetBackup 4.5GA or
later. Starting with NetBackup 4.5GA, NetBackup stores the required DAR offset
information on each backup.
Note For backups made by pre-4.5GA versions of NetBackup, restores cannot use DAR,
because the pre-4.5 versions did not store the DAR offset information.
60
DAR can be used when restoring files, but not when restoring directories.
Backups must have been performed with the NetBackup catalog set to binary mode.
For backups made with the catalog set to ASCII mode, restores cannot use DAR,
because ASCII mode did not store the required DAR offset information on each
backup. Note that all backups made prior to NetBackup 4.5 used ASCII catalog mode.
To use DAR with NetBackup, the NDMP host you want to restore must support DAR.
Some NDMP host vendors do not currently support DAR.
Troubleshooting NetBackup
Troubleshooting NetBackup
Types of Logs
NetBackup uses two types of logging: unified logging, new in this 6.0 release, and legacy
logging as used in previous releases. Both are described in the Using Logs and Reports
chapter in the NetBackup Troubleshooting Guide.
Note:
Use the vxlogview command to examine unified logs (see examples in the next
section):
On UNIX: /usr/openv/netbackup/bin/vxlogview
On Windows: install_path\NetBackup\bin\vxlogview
Refer to the NetBackup Troubleshooting Guide for assistance in using the vxlogview
command. See also the vxlogview man page or the NetBackup Commands Guide.
Troubleshooting Steps
Check the NetBackup All Log Entries report for information about the failed job.
Chapter 7, Troubleshooting
61
Troubleshooting NetBackup
On the NetBackup for NDMP server, create bptm, bpbrm, and ndmpagent legacy
debug log folders in the /usr/openv/netbackup/logs directory (UNIX) or
install_path\NetBackup\logs folder (Windows). NetBackup writes legacy log
files in these directories, if the directories exist.
Note The legacy and unified logging files can consume a lot of disk space; delete the log
files when you are finished troubleshooting and set logging to a lower level of
detail.
To verify that the appropriate services are running, use either the NetBackup Activity
Monitor, the Windows control panel (on Windows systems), or the bpps command
(UNIX systems).
If NDMP host backups terminate with a status code of 154 (storage unit characteristics
mismatched to request), the problem may be one of the following:
There may be a conflict between the policy type and storage unit type (for
example, if the policy type is Standard and the storage unit is of type NDMP).
If your NDMP backup fails with a status code of 99 (NDMP backup failure), none of
the paths in your NDMP policy Backup Selections list were backed up successfully.
Check the NetBackup All Log Entries report for more information. A possible cause of
this status is that none of the backup paths exist on the NDMP host.
backup environment
Environment 1: TYPE=dump
Environment 2:
Environment 3:
Environment 4: LEVEL=0
The NDMP backup LEVEL is modeled after UNIX dump levels. The backup level is a
number in the range of 0 to 9.
62
NetBackup Full
NDMP level 0
NDMP level 1
For legacy logging, enable debug logging by creating reqlib and daemon directories
in the install_path\Volmgr\debug directory on the NetBackup for NDMP server.
Check the Windows Event Viewer Application log for troubleshooting clues. For more
information on the Event Viewer logging option, refer to the NetBackup Troubleshooting
Guide.
Use the Activity Monitor interface or the Windows control panel to verify that the
Media Manager services are running.
Drives can be unexpectedly set to the DOWN state due to communication problems
between avrd on the NetBackup for NDMP server and the NDMP server application
on the NDMP host. Some possible causes for the communication problems are:
NIS (Network Information System) problems on the NetBackup for NDMP server
(NDMP client).
Note Whatever the cause, if the avrd connection to the NDMP host fails, the drive is set
to DOWN and is not automatically set to UP when the communication problem is
corrected.
Chapter 7, Troubleshooting
63
Ensure that syslogd is logging Media Manager messages. For more information on
syslogd, refer to the NetBackup Troubleshooting Guide.
Start ltid with the -v option. Check the systems syslog for troubleshooting clues.
Use vmps to make sure that the appropriate Media Manager daemons are running.
Drives can be unexpectedly set to the DOWN state due to communication problems
between avrd on the NetBackup for NDMP server and the NDMP server application
on the NDMP host. For details, refer to the last main bullet and note under the
Troubleshooting Media Manager on Windows Systems section.
Troubleshooting DAR
In certain situations, one of the following messages may appear in the unified logs for
ndmpagent (originator ID 134) on the NetBackup media server. These are also written to
the progress log.
Message:
DAR disabled - Number of paths n > DAR_MAXIMUM_FILE_LIST_COUNT x
Explanation:
The number of files being restored is greater than the maximum allowed (default is 1024).
You can either select fewer files for the restore, or increase the DAR maximum Backup
Selections list count. (Increasing the maximum is not supported by some NDMP host
vendors.)
To increase the DAR maximum Backup Selections list count, place a
DAR_MAXIMUM_FILE_ LIST_COUNT x entry in the following file and specify x as a
number greater than 1024.
On UNIX:
/usr/openv/netbackup/db/config/ndmp.cfg
On Windows:
install_path\NetBackup\db\config\ndmp.cfg
Message:
DAR disabled - not supported by NDMP host
Explanation:
64
Troubleshooting DAR
Explanation:
Message:
DAR disabled - Backup performed prior to NB 4.5
Explanation:
The DAR feature can be used when restoring backups that were made by NetBackup
4.5GA or later. Starting with NetBackup 4.5GA, NetBackup stores the required DAR offset
information on each backup. For backups made by pre-4.5GA versions of NetBackup,
restores cannot use DAR, because the pre-4.5 versions did not store the DAR offset
information.
Message:
DAR disabled - NDMP host did not provide DAR info during backup
Explanation:
The backup was performed with an NDMP host version that does not support DAR. Ask
the NDMP host vendor if a later NAS software version is available that supports DAR.
Message:
DAR disabled - Optimal DAR parameters exceeded for this image size
Explanation:
NetBackup determined that the restore would take longer with DAR than without it.
Message:
DAR disabled - Directory DAR not supported
Explanation:
DAR is automatically disabled when a restore job specifies a directory to restore. DAR can
be used when restoring files, but not when restoring directories.
Chapter 7, Troubleshooting
65
Troubleshooting DAR
Message:
DAR disabled by DAR config file
Explanation:
DAR was disabled by adding the entry NDMP_DAR_DISABLED to the following file:
On UNIX:
/usr/openv/netbackup/db/config/ndmp.cfg
On Windows:
install_path\NetBackup\db\config\ndmp.cfg
This method of disabling DAR is obsolete. Use the Host Properties dialog as explained
under Enabling/Disabling DAR on page 40.
Message:
DAR disabled by host parameters
Explanation:
66
Testing a Robot
Testing a Robot
Depending on the type of robot, use the tests shown in the following table to exercise the
robot:
Robot Type
Test
TLD
tldtest
TL8
tl8test
TLH
tlhtest
ACS
acstest
inquiry (Displays the vendor and product ID. If you get a UNIT ATTENTION message,
Chapter 7, Troubleshooting
67
Testing a Robot
Note that a TLH robot cannot attach directly to the NDMP host; only a TLH drive can
68
Using Scripts
This chapter explains how to customize the NDMP-specific notify scripts.
Note Before using the notify scripts on UNIX, ensure they are executable by other. Do this
by executing chmod 755 script_name, where script_name is the name of the script.
The UNIX scripts are provided as examples only. You must customize the scripts
before using them. For example, the -ne value in the first if statement must be
modified to reflect the number of parameters passed.
NetBackup for NDMP provides the following scripts (commands on Windows) for
collecting information and providing notification of events.
Scripts to run on the NetBackup for NDMP server
Scripts for UNIX
ndmp_start_notify
ndmp_start_notify.cmd
ndmp_end_notify
ndmp_end_notify.cmd
ndmp_start_path_notify
ndmp_start_path_notify.cmd
ndmp_end_path_notify
ndmp_end_path_notify.cmd
ndmp_moving_path_notify
ndmp_moving_path_notify.cmd
The scripts are similar to those already included in your NetBackup server installation. To
create the scripts on UNIX, copy the bpstart_notify and bpend_notify scripts from
/usr/openv/netbackup/bin/goodies (UNIX)
to
/usr/openv/netbackup/bin
on the NetBackup for NDMP server. Then rename the copied scripts and modify as needed.
You must customize the scripts before using them; see the above note.
69
ndmp_start_notify (UNIX)
Note Before using this script, ensure that it is executable by other on the media server. Do
this by executing chmod 755 script_name, where script_name is the name of the
script.
The UNIX scripts are provided as examples only. You must customize the scripts
before using them. For example, the -ne value in the first if statement must be
modified to reflect the number of parameters passed. For the ndmp_start_notify
script, the -ne value must be set to 5.
On the UNIX media server, NetBackup calls the ndmp_start_notify script each time
the client starts a backup operation. To use this script, create a script similar to
/usr/openv/netbackup/bin/goodies/bpstart_notify
on the UNIX NetBackup for NDMP server. Then, modify the script as desired and ensure
that you have execute permission.
The ndmp_start_notify script executes each time a backup starts and after the tape
has been positioned. This script must exit with a status of 0 for the calling program to
continue and for the backup to proceed. A nonzero status causes the client backup to exit
with a status of ndmp_start_notify failed.
If the /usr/openv/netbackup/bin/ndmp_start_notify script exists, it executes in
the foreground and the bptm process on the NetBackup for NDMP server waits for it to
complete before continuing. Any commands in the script that do not end with an &
character execute serially.
The server expects the client to respond with a continue message within the period of
time specified by the NetBackup CLIENT_READ_TIMEOUT option on the server.
The default for CLIENT_READ_TIMEOUT is 300. If the script needs more time than 300
seconds, increase the value to allow more time.
NetBackup passes the following parameters to the script:
70
Parameter
Description
$1
Parameter
Description
$2
$3
$4
For example:
ndmp_start_notify freddie cd4000s fulls FULL 0
/usr/openv/netbackup/bin/ndmp_start_notify.production.fulls
The first script affects all scheduled backups in the policy named production. The second
script affects scheduled backups in the policy named production only when the schedule
is named fulls.
Note For a given backup, NetBackup uses only one ndmp_start_notify script and
that is the one with the most specific name. For example, if there are both
ndmp_start_notify.production and
ndmp_start_notify.production.fulls scripts, NetBackup uses only
ndmp_start_notify.production.fulls.
The ndmp_start_notify script can use the following environment variables:
BACKUPID
UNIXBACKUPTIME
BACKUPTIME
71
The NetBackup bptm process creates these variables. The following are examples of
strings that are available to the script for use in recording information about a backup:
BACKUPID=freddie_0857340526
UNIXBACKUPTIME=0857340526
install_path\netbackup\bin\ndmp_start_notify.days.cmd
The following script applies only to a schedule named fulls that is in a policy named
days:
install_path\netbackup\bin\ndmp_start_notify.days.fulls.cmd
The first script affects all scheduled backups in the policy named days. The second script
affects scheduled backups in the policy named days only when the schedule is named
fulls.
For a given backup, NetBackup calls only one ndmp_start_notify script and checks
for them in the following order:
ndmp_start_notify.policy.schedule.cmd
ndmp_start_notify.policy.cmd
ndmp_start_notify.cmd
72
Parameter
Description
%1
%2
%3
%4
%5
%6
Results file that NetBackup checks for a return code from the script.
NetBackup uses %6 to pass the file name and then expects the script to create
the file in the same directory as the script.
If the script applies to a specific policy and schedule, the results file must be
named
install_path\netbackup\bin\NDMP_START_NOTIFY_RES.policy.schedule
If the script applies to a specific policy, the results file must be named
install_path\netbackup\bin\NDMP_START_NOTIFY_RES.policy
If the script applies to all backups, the results file must be named
install_path\netbackup\bin\NDMP_START_NOTIFY_RES
An echo 0> %6 statement is one way for the script to create the file.
NetBackup deletes the existing results file before calling the script. After the
script executes, NetBackup checks the new results file for the status. The
status must be 0 for the script to be considered successful. If the results file
does not exist, NetBackup assumes that the script was successful.
73
The server expects the client to respond with a continue message within the period of
time specified by the NetBackup CLIENT_READ_TIMEOUT option on the server. The
default is 300 seconds. If the script needs more than 300 seconds, increase the value to
allow more time.
ndmp_end_notify (UNIX)
Caution The ndmp_end_notify script is executed at the end of the backup. The backup
does not wait for the script to complete.
Note Before using this script, ensure that it is executable by other on the media server. Do
this by executing chmod 755 script_name, where script_name is the name of the
script.
The UNIX scripts are provided as examples only. You must customize the scripts
before using them. For example, the -ne value in the first if statement must be
modified to reflect the number of parameters passed. For the ndmp_end_notify
script, the -ne value must be set to 5.
For a UNIX media server, if you need notification whenever the NDMP host completes a
backup, copy
/usr/openv/netbackup/bin/goodies/bpend_notify
on the UNIX NetBackup for NDMP host. Then, modify the script as desired, and ensure
74
Parameter
Description
$1
$2
$3
Parameter
Description
$4
$5
For example:
ndmp_end_notify freddie cd4000s fulls FULL 0
/usr/openv/netbackup/bin/ndmp_end_notify.production.fulls
The first script affects all scheduled backups in the policy named production. The second
script affects scheduled backups in the policy named production only when the schedule
is named fulls.
Note For a given backup, NetBackup uses only one ndmp_end_notify script and that is
the one with the most specific name. For example, if there are both
ndmp_end_notify.production and
ndmp_end_notify.production.fulls scripts, NetBackup uses only
ndmp_end_notify.production.fulls.
The ndmp_end_notify script can use the following environment variables:
BACKUPID
UNIXBACKUPTIME
BACKUPTIME
The NetBackup bptm process creates these variables. The following are examples of
strings that are available to the script for use in recording information about a backup:
BACKUPID=freddie_0857340526
UNIXBACKUPTIME=0857340526
75
install_path\netbackup\bin\ndmp_end_notify.days.cmd
The following script applies only to a schedule named fulls that is in a policy named
days:
install_path\netbackup\bin\ndmp_end_notify.days.fulls.cmd
The first script affects all scheduled backups in the policy named days. The second script
affects scheduled backups in the policy named days only when the schedule is named
fulls.
For a given backup, NetBackup calls only one ndmp_end_notify script and checks for
them in the following order:
ndmp_end_notify.policy.schedule.cmd
ndmp_end_notify.policy.cmd
ndmp_end_notify.cmd
ndmp_end_notify.policy.schedule.cmd.
Note If you are also using ndmp_start_notify scripts, they can provide a different
level of notification than the ndmp_end_notify scripts. For example, if you had
one of each, they could be ndmp_start_notify.policy.cmd and
ndmp_end_notify.policy.schedule.cmd.
76
When the backup completes, NetBackup passes the following parameters to the script:
Parameter
Description
%1
%2
%3
%4
%5
Status of the operation and is same as sent to the NetBackup server. This is 0
for successful backups and 1 for partially successful backups. If an error
occurs, the status is the value associated with that error.
Results file that NetBackup checks for a return code from the script.
NetBackup uses %6 to pass the file name and then expects the script to create
the file in the same directory as the script.
If the script applies to a specific policy and schedule, the results file must be
named
install_path\netbackup\bin\NDMP_END_NOTIFY_RES.policy.schedule
If the script applies to a specific policy, the results file must be named
install_path\netbackup\bin\NDMP_END_NOTIFY_RES.policy
If the script applies to all backups, the results file must be named
install_path\netbackup\bin\NDMP_END_NOTIFY_RES
An echo 0> %6 statement is one way for the script to create the file.
NetBackup deletes the existing results file before calling the script. After the
script executes, NetBackup checks the new results file for the status. The
status must be 0 for the script to be considered successful. If the results file
does not exist, NetBackup assumes that the script was successful.
77
ndmp_start_path_notify (UNIX)
Note Before using this script, ensure that it is executable by other on the media server. Do
this by executing chmod 755 script_name, where script_name is the name of the
script.
The UNIX scripts are provided as examples only. You must customize the scripts
before using them. For example, the -ne value in the first if statement must be
modified to reflect the number of parameters passed. For the
ndmp_start_path_notify script, the -ne value must be set to 7.
To use this script, create a script similar to
/usr/openv/netbackup/bin/goodies/bpstart_notify
on the UNIX NetBackup for NDMP server. Then, modify the script as desired and ensure
that you have execute permission.
On the UNIX media server, the ndmp_start_path_notify script executes before the
backup process is issued to the NAS machine. This script must exit with a status of 0 for
the calling program to continue and for the backup to proceed. A nonzero status causes
the client backup to exit with a status of 99 (NDMP backup failure).
If the /usr/openv/netbackup/bin/ndmp_start_path_notify script exists, it
executes in the foreground and the bptm process on the NetBackup for NDMP server
waits for it to complete before continuing. Any commands in the script that do not end
with an & character execute serially.
The server expects the client to respond with a continue message within the period of
time specified by the NetBackup CLIENT_READ_TIMEOUT option on the server.
The default for CLIENT_READ_TIMEOUT is 300. If the script needs more time than 300
seconds, increase the value to allow more time.
NetBackup passes the following parameters to the script:
78
Parameter
Description
$1
$2
$3
Parameter
Description
$4
$6
Not used.
$7
For example:
ndmp_start_path_notify freddie cd4000s fulls FULL
/usr/openv/netbackup/bin/ndmp_start_path_notify.production.fulls
The first script affects all scheduled backups in the policy named production. The second
script affects scheduled backups in the policy named production only when the schedule
is named fulls.
Note For a given backup, NetBackup uses only one ndmp_start_path_notify script
and that is the one with the most specific name. For example, if there are both
ndmp_start_path_notify.production and
ndmp_start_path_notify.production.fulls scripts, NetBackup uses only
ndmp_start_path_notify.production.fulls.
The ndmp_start_path_notify script can use the following environment variables:
BACKUPID
UNIXBACKUPTIME
BACKUPTIME
The NetBackup bptm process creates these variables. The following are examples of
strings that are available to the script for use in recording information about a backup:
Chapter 8, Using Scripts
79
BACKUPID=freddie_0857340526
UNIXBACKUPTIME=0857340526
You can create ndmp_start_path_notify scripts that provide notification for all
script:
install_path\netbackup\bin\ndmp_start_path_notify.cmd
To create a script that applies only to a specific policy or policy and schedule combination,
add a .policyname or .policyname.schedulename suffix to the script name.
The following script applies only to a policy named days:
install_path\netbackup\bin\ndmp_start_path_notify.days.cmd
The following script applies only to a schedule named fulls that is in a policy named
days:
install_path\netbackup\bin\ndmp_start_path_notify.days.fulls.cmd
The first script affects all scheduled backups in the policy named days. The second script
affects scheduled backups in the policy named days only when the schedule is named
fulls.
For a given backup, NetBackup calls only one ndmp_start_path_notify script and
checks for them in the following order:
ndmp_start_path_notify.policy.schedule.cmd
ndmp_start_path_notify.policy.cmd
ndmp_start_path_notify.cmd
80
Note If you are also using ndmp_start_notify scripts, they can provide a different
level of notification than the ndmp_start_path_notify scripts. For example, if
you had one of each, they could be ndmp_start_notify.policy.cmd and
ndmp_start_path_notify.policy.schedule.cmd.
When the backup starts, NetBackup passes the following parameters to the script:
Parameter
Description
%1
%2
%3
%4
%5
Status of the operation and is same as sent to the NetBackup server. This is 0
for successful backups and 1 for partially successful backups. If an error
occurs, the status is the value associated with that error.
81
Parameter
Description
%6
Results file that NetBackup checks for a return code from the script.
NetBackup uses %6 to pass the file name and then expects the script to create
the file in the same directory as the script.
If the script applies to a specific policy and schedule, the results file must be
named
install_path\netbackup\bin\NDMP_START_PATH_NOTIFY_RES.policy.sc
hedule
If the script applies to a specific policy, the results file must be named
install_path\netbackup\bin\NDMP_START_PATH_NOTIFY_RES.policy
If the script applies to all backups, the results file must be named
install_path\netbackup\bin\NDMP_START_PATH_NOTIFY_RES
An echo 0> %6 statement is one way for the script to create the file.
NetBackup deletes the existing results file before calling the script. After the
script executes, NetBackup checks the new results file for the status. The
status must be 0 for the script to be considered successful. If the results file
does not exist, NetBackup assumes that the script was successful.
%7
ndmp_end_path_notify (UNIX)
Note Before using this script, ensure that it is executable by other on the media server. Do
this by executing chmod 755 script_name, where script_name is the name of the
script.
The UNIX scripts are provided as examples only. You must customize the scripts
before using them. For example, the -ne value in the first if statement must be
modified to reflect the number of parameters passed. For the
ndmp_end_path_notify script, the -ne value must be set to 7.
For a UNIX media server, if you need notification whenever the NDMP host completes a
backup, copy
82
/usr/openv/netbackup/bin/goodies/bpend_notify
on the UNIX NetBackup for NDMP host. Then, modify the script as desired, and ensure
that you have execute permission.
The ndmp_end_path_notify script executes after the NAS machine has informed
NetBackup that it has completed sending data.
NetBackup passes the following parameters to the ndmp_end_notify script:
Parameter
Description
$1
$2
$3
$4
$6
Not used.
$7
For example:
ndmp_end_path_notify freddie cd4000s fulls FULL 0
/usr/openv/netbackup/bin/ndmp_end_path_notify.production.fulls
83
The first script affects all scheduled backups in the policy named production. The second
script affects scheduled backups in the policy named production only when the schedule
is named fulls.
Note For a given backup, NetBackup uses only one ndmp_end_path_notify script and
that is the one with the most specific name. For example, if there are both
ndmp_end_path_notify.production and
ndmp_end_path_notify.production.fulls scripts, NetBackup uses only
ndmp_end_path_notify.production.fulls.
The ndmp_end_path_notify script can use the following environment variables:
BACKUPID
UNIXBACKUPTIME
BACKUPTIME
The NetBackup bptm process creates these variables. The following are examples of
strings that are available to the script for use in recording information about a backup:
BACKUPID=freddie_0857340526
UNIXBACKUPTIME=0857340526
install_path\netbackup\bin\ndmp_end_path_notify.days.cmd
84
The following script applies only to a schedule named fulls that is in a policy named
days:
install_path\netbackup\bin\ndmp_end_path_notify.days.fulls.cmd
The first script affects all scheduled backups in the policy named days. The second script
affects scheduled backups in the policy named days only when the schedule is named
fulls.
For a given backup, NetBackup calls only one ndmp_end_path_notify script and
checks for them in the following order:
ndmp_end_path_notify.policy.schedule.cmd
ndmp_end_path_notify.policy.cmd
ndmp_end_path_notify.cmd
Parameter
Description
%1
%2
%3
%4
%5
Status of the operation and is same as sent to the NetBackup server. This is 0
for successful backups and 1 for partially successful backups. If an error
occurs, the status is the value associated with that error.
85
Parameter
Description
%6
Results file that NetBackup checks for a return code from the script.
NetBackup uses %6 to pass the file name and then expects the script to create
the file in the same directory as the script.
If the script applies to a specific policy and schedule, the results file must be
named
install_path\netbackup\bin\NDMP_END_PATH_NOTIFY_RES.policy.sched
ule
If the script applies to a specific policy, the results file must be named
install_path\netbackup\bin\NDMP_END_PATH_NOTIFY_RES.policy
If the script applies to all backups, the results file must be named
install_path\netbackup\bin\NDMP_END_PATH_NOTIFY_RES
An echo 0> %6 statement is one way for the script to create the file.
NetBackup deletes the existing results file before calling the script. After the
script executes, NetBackup checks the new results file for the status. The
status must be 0 for the script to be considered successful. If the results file
does not exist, NetBackup assumes that the script was successful.
%7
ndmp_moving_path_notify (UNIX)
Note Before using this script, ensure that it is executable by other on the media server. Do
this by executing chmod 755 script_name, where script_name is the name of the
script.
The UNIX scripts are provided as examples only. You must customize the scripts
before using them. For example, the -ne value in the first if statement must be
modified to reflect the number of parameters passed. For the
ndmp_moving_path_notify script, the -ne value must be set to 7.
To use this script, create a script similar to
86
/usr/openv/netbackup/bin/goodies/bpstart_notify
on the UNIX NetBackup for NDMP server. Then, modify the script as desired and ensure
that you have execute permission.
On UNIX media servers, the ndmp_moving_path_notify script executes once the
backup process has sent data to NetBackup.
If the /usr/openv/netbackup/bin/ndmp_moving_path_notify script exists, it
executes in the foreground and the bptm process on the NetBackup for NDMP server
waits for it to complete before continuing. Any commands in the script that do not end
with an & character execute serially.
The server expects the client to respond with a continue message within the period of
time specified by the NetBackup CLIENT_READ_TIMEOUT option on the server.
The default for CLIENT_READ_TIMEOUT is 300 seconds. If the script needs more than
300 seconds, increase the value to allow more time.
NetBackup passes the following parameters to the script:
Parameter
Description
$1
$2
$3
$4
$6
Not used.
$7
For example:
ndmp_moving_path_notify freddie cd4000s fulls FULL
87
/usr/openv/netbackup/bin/ndmp_moving_path_notify.production.fulls
The first script affects all scheduled backups in the policy named production. The second
script affects scheduled backups in the policy named production only when the schedule
is named fulls.
Note For a given backup, NetBackup uses only one ndmp_moving_path_notify script
and that is the one with the most specific name. For example, if there are both
ndmp_moving_path_notify.production and
ndmp_moving_path_notify.production.fulls scripts, NetBackup uses only
ndmp_moving_path_notify.production.fulls.
The ndmp_moving_path_notify script can use the following environment variables:
BACKUPID
UNIXBACKUPTIME
BACKUPTIME
The NetBackup bptm process creates these variables. The following are examples of
strings that are available to the script for use in recording information about a backup:
BACKUPID=freddie_0857340526
UNIXBACKUPTIME=0857340526
install_path\netbackup\bin\ndmp_moving_path_notify.days.cmd
The following script applies only to a schedule named fulls that is in a policy named
days:
install_path\netbackup\bin\ndmp_moving_path_notify.days.fulls.cmd
The first script affects all scheduled backups in the policy named days. The second script
affects scheduled backups in the policy named days only when the schedule is named
fulls.
For a given backup, NetBackup calls only one ndmp_moving_path_notify script and
checks for them in the following order:
ndmp_moving_path_notify.policy.schedule.cmd
ndmp_moving_path_notify.policy.cmd
ndmp_moving_path_notify.cmd
For example, if there are both ndmp_moving_path_notify.policy.cmd and
ndmp_moving_path_notify.policy.schedule.cmd scripts, NetBackup uses only
ndmp_moving_path_notify.policy.schedule.cmd.
Note If you are also using ndmp_start_notify scripts, they can provide a different
level of notification than the ndmp_moving_path_notify scripts. For example, if
you had one of each, they could be ndmp_start_notify.policy.cmd and
ndmp_moving_path_notify.policy.schedule.cmd.
When the backup starts, NetBackup passes the following parameters to the script:
Parameter
Description
%1
%2
%3
89
Parameter
Description
%4
%5
Status of the operation and is same as sent to the NetBackup server. This is 0
for successful backups and 1 for partially successful backups. If an error
occurs, the status is the value associated with that error.
Results file that NetBackup checks for a return code from the script.
NetBackup uses %6 to pass the file name and then expects the script to create
the file in the same directory as the script.
If the script applies to a specific policy and schedule, the results file must be
named
install_path\netbackup\bin\NDMP_END_NOTIFY_RES.policy.schedule
If the script applies to a specific policy, the results file must be named
install_path\netbackup\bin\NDMP_END_NOTIFY_RES.policy
If the script applies to all backups, the results file must be named
install_path\netbackup\bin\NDMP_END_NOTIFY_RES
An echo 0> %6 statement is one way for the script to create the file.
NetBackup deletes the existing results file before calling the script. After the
script executes, NetBackup checks the new results file for the status. The
status must be 0 for the script to be considered successful. If the results file
does not exist, NetBackup assumes that the script was successful.
%7
90
Index
UNIX 70
Windows 72
ndmp_start_path_notify script
UNIX 78
Windows 80
overview 14
procedure 56
types allowed 38
Numerics
10000, port (used by NDMP) 60
A
accessibility features ix
acstest 67
adding
drives 31, 35
robots 28
volumes 33
Advanced Client 3
authorization
avrd 60
C
client list 37
clustering 3, 43
configuration
add volumes 33
adding drives/robots 28
client list 37
for clustering 43
NDMP policy 37
policy type 37
schedules 38
testing 44
B
backup
automatic 56
format 60
ndmp_end_notify script
UNIX 74
Windows 76
ndmp_end_path_notify script
UNIX 83
Windows 84
ndmp_moving_path_notify script
UNIX 87
Windows 88
ndmp_start_notify script
D
DAR 3, 18
defined 4
debug logs 62
deinstallation
91
server 22
Device Configuration Wizard 2, 23, 52
Device Monitor 33
different client restore 5
Direct Access Recovery (see DAR)
drive
add to Media Manager 35
adding, for NDMP-attached host 31
duplex mode and performance 60
E
environment variables, in Backup Selections
list 38
exclude
files, using SET directive 38
list, using 38
F
fail over 43
file list 38
file names (not allowed in Backup Selections
list) 38, 60
H
High Availability 3, 43
I
ICMP protocol 60
installation 19
deinstallation 22
load from media 20
prerequisites 19
instant recovery 3
J
jnbSA 56
L
LEVEL (NDMP backup) 62
log directories 62, 63, 64
M
Media Manager
configuring 28
storage units 46
troubleshooting 63, 64
N
NAS snapshot 3, 23, 24, 37, 47, 55
nbjm 61
nbpem 61
nbrb 61
NDMP
92
attributes 37
clients 37
files 38
schedules 38
configuration 37
overview 10
protocol 4, 6, 60
restore 57
restrictions 60
server application, definition of 4
storage unit, adding 35
storage unit, definition of 5
to media server 4, 27, 37, 46
how to configure 47
ndmp logging 61
NDMP to media server 2, 9
ndmp_end_notify script
UNIX 74
Windows 76
ndmp_end_path_notify script
UNIX 83
Windows 84
ndmp_moving_path_notify script
UNIX 87
Windows 88
ndmp_start_notify script
UNIX 70
Windows 72
ndmp_start_path_notify script
UNIX 78
Windows 80
ndmpagent
legacy debug log 62
unified logging 61
NetBackup Administration Console 56
NetBackup for NDMP
NetBackup for NDMP System Administrators Guide
configuration 23
definition 1
features 2
installation 19
server, definition 4
troubleshooting 61
notification scripts 69
verifying 34
S
schedules 38
scripts
notification 69
SET directive 39
snapshots 3
SnapVault 3, 37
SSO 2
configuration overview 51
storage devices
auto discovery 2, 23
storage unit
adding 35
supported robots 11
O
on demand storage unit 36
overwriting files 57
P
password
verifying 27, 34
path-based history 3
ping 60
point-in-time snapshots 3
policy
attributes 37
T
tape libraries supported 11
testing configuration 44
three-way backup 5
configuring for 27
tl8test 67
tldtest 67
tlhtest 67, 68
tpautoconf 34, 51
troubleshooting 59
type
of backup allowed 38
of policy 37
of storage unit 36
R
remote NDMP 46
restart
device manager 30
Media Manager 32
restore
overview 16
overwriting files 57
procedure 57
three-way 16
to different client 5, 10
restrictions
robot
adding 28
robotic control 29
supported types 11
robot connection
Index
U
unified logging 61
uninstalling NetBackup 22
user-directed
variables, environment 38
93
94
W
web access to product info x
web access to recent Advanced Client info x
wildcards, in Backup Selections list 38, 60
Windows control panel 63