NetBackup Commands for Windows

Transcription

VERITAS NetBackup™ 6.0
Commands
for Windows
N152618
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 © 1998 - 2005 VERITAS Software Corporation. All rights reserved. VERITAS, the VERITAS
Logo, and VERITAS 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
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Finding NetBackup Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Accessing the VERITAS Technical Support Web Site . . . . . . . . . . . . . . . . . . . . . . . . . . x
Contacting VERITAS Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Accessibility Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Comment on the Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xii
Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xii
Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xii
NetBackup Command Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
NetBackup Media Manager Command Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv
Chapter 1. NetBackup Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
acsd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
add_media_server_on_clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
backupdbtrace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
backuptrace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
beconv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
bmrc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
bmrconfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
bmrepadm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
bmrprep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
bmrs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
iii
bmrsrtadm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
bparchive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
bpauthorize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
bpauthsync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
bpbackup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
bpbackupdb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
bpcatarc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
bpcatlist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
bpcatres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
bpcatrm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
bpcd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
bpchangeprimary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
bpclient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
bpclntcmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
bpcompatd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
bpconfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
bpdbjobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
bpdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
bpduplicate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
bperror . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
bpexpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
bpfis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
bpgetconfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
bpgetdebuglog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
bpimage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
bpimagelist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
bpimmedia . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
bpimport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
bpinst . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
bpkeyfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
iv
bpkeyutil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
bplabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
bplist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
bpmedia . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
bpmedialist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
bpminlicense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
bpnbat
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
bpnbaz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
bpplclients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
bppldelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
bpplinclude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
bpplinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
bppllist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
bpplsched . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
bpplschedrep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
bppolicynew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
bpps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
bprecover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
bprestore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
bpschedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
bpschedulerep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
bpsetconfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
bpstsinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
bpstuadd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
bpstudel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
bpstulist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
bpsturep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
bptestbpcd(1M)
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
bpup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
bpverify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
Contents
v
cat_convert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
create_nbdb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
duplicatetrace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
importtrace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
nbdb_admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
nbdb_backup
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
nbdb_move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
nbdb_ping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
nbdb_restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
nbdb_unload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
nbemm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
nbemmcmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
nbjm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
nbnos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
nbpem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
nbpemreq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
nbpushdata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
nbrb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
restoretrace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
set_ndmp_attr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
tl4d . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384
tl8d . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
tldd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
tlhd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
tlmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
tpautoconf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
tpclean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
tpconfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
tpreq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
tpunmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
vi
verifytrace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
vltcontainers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
vlteject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
vltinject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
vltoffsitemedia . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
vltopmenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
vltrun . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
vmadd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
vmchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
vmcheckxxx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
vmdelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
vmoprcmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
vmphyinv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
vmpool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
vmquery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
vmrule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
vmupdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
vopie_util . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
vopied . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
vxlogcfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
vxlogmgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
vxlogview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .501
Contents
vii
viii
Preface
The purpose of this document is to provide you with a book that contains all of the
NetBackup “man page” commands. This enables you to find a printable version of the
command quickly and easily without searching through multiple books in the NetBackup
Library.
This document contains detailed information about each NetBackup command pertinent
to a Windows system. 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.
In addition, some commands contain notes and examples to help the user understand
how to use the command.
Getting Help
You can find answers to questions and get help from the NetBackup documentation and
from the VERITAS technical support web site.
Finding NetBackup Documentation
A list of the entire NetBackup documentation set appears as an appendix in the NetBackup
Release Notes. All NetBackup documents are included in PDF format on the NetBackup
Documentation CD.
For definitions of NetBackup terms, consult the online glossary.
▼
To access the NetBackup online glossary
1. In the NetBackup Administration Console, click Help > Help Topics.
2. Click the Contents tab.
3. Click Glossary of NetBackup Terms.
Use the scroll function to navigate through the glossary.
ix
Getting Help
Accessing the VERITAS Technical Support Web Site
The address for the VERITAS Technical Support Web site is http://support.veritas.com.
The VERITAS Support Web site lets you do any of the following:
◆ Obtain updated information about NetBackup, including system requirements,
supported platforms, and supported peripherals
◆ Contact the VERITAS Technical Support staff and post questions to them
◆ Get the latest patches, upgrades, and utilities
◆ View the NetBackup Frequently Asked Questions (FAQ) page
◆ Search the knowledge base for answers to technical support questions
◆ Receive automatic notice of product updates
◆ Find out about NetBackup training
◆ Read current white papers related to NetBackup
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.
x
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:
◆ Select a language of your preference
◆ Select a product and a platform
◆ Provide additional contact and product information, and your message
◆ Associate your message with an existing technical support case
b. After providing the required information, click Send Message.
Contacting VERITAS Licensing
For license information, you can contact us as follows:
◆ Call 1-800-634-4747 and select option 3
◆ Fax questions to 1-650-527-0952
◆ In the Americas, send e-mail to [email protected].
In the Asia and Pacific areas, send email to [email protected].
In all other areas, send email to [email protected].
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
For more information, see the NetBackup Installation Guide.
Preface
xi
Comment on the Documentation
Comment on the Documentation
Let us know what you like and dislike about the documentation. Were you able to find the
information you needed quickly? Was the information clearly presented? You can report
errors and omissions or tell us what you would find useful in future versions of our
manuals and online help.
Please include the following information with your comment:
◆
The title and product version of the manual on which you are commenting
◆
The topic (if relevant) on which you are commenting
◆
Your comment
◆
Your name
Email your comment to [email protected].
Please only use this address to comment on product documentation. See “Getting Help” in this preface for information on how to contact Technical Support about our software.
We appreciate your feedback.
Conventions
The following section explains the various conventions used in this guide.
Command Usage
The following conventions are frequently used in the synopsis of command usage.
brackets [ ]
The enclosed command line component is optional.
Vertical bar or pipe (|)
Separates optional arguments from which the user can choose. For example, when a
command has the following format:
command arg1|arg2
In this example, the user can use either the arg1 or arg2 variable.
Navigating Multiple Menu Levels
When navigating multiple menu levels, a greater-than sign (>) is used to indicate a
continued action.
xii
Conventions
The following example shows how the > is used to condense a series of menu selections
into one step:
◆ Select Start > Programs > VERITAS NetBackup > NetBackup Administration
Console.
The corresponding actions could 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 VERITAS 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 these commands in the “Command Prompt” to see the results.
◆ Brackets [ ] indicate that the enclosed component of the command line is optional.
◆ Curly braces {} indicate an association between the enclosed options. For instance,
{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
◆ 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
Preface
xiii
Introduction
NetBackup Media Manager Command Notes
In addition, Media Manager has a set of commands that are for device management and
are started or stopped by the NetBackup Device Manager service (ltid) 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, and vmquery, vmrule, and
vmupdate are administrative commands for media management.
Introduction
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 only information that only applies to one
NetBackup product.
xiv
1
NetBackup Commands
This chapter describes all of the NetBackup commands that can be referenced on a
Windows platform in alphabetical order.
acsd
NAME
acsd - Automated Cartridge System (ACS) process
SYNOPSIS
install_path\Volmgr\bin\acsd
DESCRIPTION
acsd interfaces with Media Manager to automatically mount and unmount tapes that are
under Automated Cartridge System (ACS) control. It is initiated by the NetBackup Device
Manager service (ltid), if the Media Manager device configuration shows drives in an
ACS robot. Stopping ltid stops acsd.
acsd performs its tasks by sending requests to the STK LibAttach service which
communicates with the server that controls the Automated Cartridge System.
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 Automated
Cartridge System errors exist, acsd changes the robot to the DOWN state. In this state,
acsd is still running and returns the robot to the UP state when the problem no longer
exists.
Drives are addressed and defined in Media Manager using the following: ACS number,
LSM number, Panel number, and Drive number.
Drive cleaning for ACS robots must be configured using ACS library software. Cleaning
volumes cannot be defined using Media Manager. In addition, you cannot use the
tpclean command for cleaning operations on drives under ACS robotic control.
1
acsd
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.
You must have administrator privileges to execute this command.
NOTES
This command applies only to NetBackup Enterprise Server.
ERRORS
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.
2
add_media_server_on_clients
add_media_server_on_clients
NAME
add_media_server_on_clients - Add Media Server on Clients
SYNOPSIS
install_path\NetBackup\bin\add_media_server_on_clients
DESCRIPTION
You can run the add_media_server_on_clients command from a NetBackup server
to attempt 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 attempts to connect to all configured
clients (clients listed in backup policies).
For each client that it can connect to, add_media_server_on_clients updates the
client's configuration, if necessary, to include all the servers from the server's
configuration.
Chapter 1, NetBackup Commands
3
backupdbtrace
backupdbtrace
NAME
backupdbtrace – trace debug logs of backupdb (NetBackup image catalog backup) job[s]
SYNOPSIS
install_path\NetBackup\bin\admincmd\backupdbtrace [-server name] [-job_id number] [-start_time hh:mm:ss] [-end_time hh:mm:ss] [-install_path path] mmddyy
[mmddyy ...]
DESCRIPTION
backupdbtrace consolidates the debug log messages for the specified backup database
job[s] and writes them to standard output. The messages will be sorted by time.
backupdbtrace will attempt to compensate for time zone changes and clock drift
between remote servers and clients.
At a minimum, you must enable debug logging for administrator on the master server,
and for bptm and bpbkar on the media server. For best results, set the verbose logging
level to 5 and enable debug logging for bpdbm on the master server and bpcd on all
servers in addition to the processes already identified.
If -job_id is specified, backupdbtrace uses this option as the sole criterion for selecting
the backupdb job to trace. If option -job_id is not used, then backupdbtrace selects all
the backupdb jobs executed on all the days specified by day stamps (mmddyy). If
–start_time/-end_time options are used then the debug logs in the specified time interval
are examined.
backupdbtrace writes error messages to standard error.
OPTIONS
-server
Name of the media server where the backupdb command is executed.
The default is the local host name.
-job_id
Job ID number of the backupdb job to analyze. Default is any job ID.
-start_time
Earliest time stamp to start analyzing the logs. Default is 00:00:00.
-end_time
Latest time stamp to finish analyzing the logs. Default is 23:59:59.
4
backupdbtrace
mmddyy
One or more day stamps. This identifies the log file names (log.mmddyy
for UNIX, mmddyy.log for Windows) that will be analyzed.
OUTPUT FORMAT
The format of an output line is:
<daystamp>.<millisecs>.<program>.<sequence> <machine> <log_line>
daystamp
The day of the log in yyyymmdd format.
millisecs
The number of milliseconds since midnight on the local machine.
program
The name of program (ADMIN, BPBKAR, BPCD, etc.) being logged.
sequence
Line number within the debug log file.
machine
The name of the NetBackup server or client.
log_line
The line that actually appears in the debug log file.
EXAMPLES
Example 1
The following example analyzes the log of backupdb job with job ID 5 executed on
August 6, 2002.
backupdbtrace -job_id 5 080602
Example 2
The following example analyzes the log of all backupdb jobs that are executed on August
5, 2002 and August 17, 2002.
backupdbtrace 080502 081702
5
backuptrace
backuptrace
NAME
backuptrace – consolidate the debugs logs for a NetBackup job.
SYNOPSIS
install_path\NetBackup\bin\admincmd\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...]
DESCRIPTION
The backuptrace utility can be used to consolidate the debug logs for a specified
NetBackup job[s]. The debug log messages relevant to the specified backup job[s] will be
written to standard output. The messages will be sorted by time. The backuptrace utility
will attempt to compensate for time zone changes and clock drift between remote servers
and clients. The output is formatted so that it should be relatively easy to sort or grep by
time stamp, program name, and/or server/client name.
At a minimum, you must enable debug logging for nbpem on the master server, for
bpbrm, bptm/bpdm on the media server and bpbkar on the client. For best results, set the
verbose logging level to 5 and enable debug logging for bpdbm and bprd on the master
server and for bpcd on all servers and clients in addition to the processes already
identified.
The backuptrace utility can be used 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.
-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.
6
backuptrace
-start_time hh:mm:ss
Earliest time stamp to start analyzing the logs.
-end_time hh:mm:ss
Latest time stamp to finish analyzing the logs.
mmddyy [mmddyy] One or more day stamps. This identifies the log file names (log.mmddyy
NOTES
Media Manager logs are not analyzed.
EXAMPLES
C:\Program Files\VERITAS\NetBackup\bin\admincmd\backuptrace policy weekly_bkups 051205 >/tmp/jobs.weekly_bkups
This invocation of the utility will consolidate logs for all jobs started for the policy
weekly_bkups on 05/12/05. Use the -start_time/-end_time arguments to limit the
window for which the jobs are to be evaluated.
7
beconv
beconv
NAME
beconv - Convert Backup Exec on-disk catalogs to NetBackup on-disk catalogs.
SYNOPSIS
install_path\NetBackup\bin\admincmd\beconv -all [-L
output_file] [-non_interactive] [-auto_correct]
install_path\NetBackup\bin\admincmd\beconv -rn robot_number [-L output_file] [-non_interactive] install_path\NetBackup\bin\admincmd\beconv -tbs [-rn robot_number] [-L output_file] [-non_interactive] install_path\NetBackup\bin\admincmd\beconv -m media_id [-h volume_database_host] [-L output_file] [-non_interactive] [-f]
install_path\NetBackup\bin\admincmd\beconv -check_consistency
install_path\NetBackup\bin\admincmd\beconv -show_mappings
DESCRIPTION
The beconv command converts Backup Exec on-disk catalogs to NetBackup catalogs. It
also converts Backup Exec media records to NetBackup Media Manager records with the
media being assigned to NetBackup. The media is kept in a frozen state so that NetBackup
does not accidentally use it for backups.
The expiration date for Backup Exec images is the current date plus a retention level of 2
weeks. For example, if Backup Exec catalogs are converted on 7 August 2003, the
expiration date for converted NetBackup catalogs will be 21 August 2003.
When the images expire, run beconv to regenerate the images.
OPTIONS
-all
All media belonging to the Backup Exec server are converted and the
corresponding images are generated.
-auto_correct
Use this option to take corrective actions (if any). Use it only when
indicated during an earlier run of beconv.
-check_consistency
Use this option to check the consistency of Enterprise Media Manager
Database.
8
beconv
With this option specified, no conversion takes place. In this mode,
beconv searches for Media Manager records with ambiguous GUIDs and
media ids in all the volume databases belonging to locally configured
devices, then displays the list.
-f
-f denotes the family to which the media belongs. -f converts all the
media belonging to the same Backup Exec family. Use for backups which
span more that one media.
-h volume_database_host
Specifies the EMM server name where the media is actually present. If
this is not specified, the local host name is taken.
-L output_file
Specifies the name of a file in which to write progress information. The
default is to not use a progress file.
-m media_id
Specifies the media id of the Backup Exec media which needs to be
converted.
-non_interactive
Do not prompt for user input and carry on with the changes. Default is
interactive mode, during which the user is prompted before any actual
image generation.
-rn robot_number
Specifies the NetBackup robot number for which the media need to be
converted.
-show_mappings
This option lists the current mappings between Backup Exec and
NetBackup robots. With this option specified, no conversion takes place
and only the mappings are displayed.
-tbs
Trust By Slot. This mode is only for non-barcoded robotic media. In this
mode, a match between a Backup Exec media record and a NetBackup
Media Manager record is done on the basis of physical location of the
media in the robot. In order for a match to be successful, physical
inventory of the robot should be done prior to running beconv in this
mode. The -tbs option can be combined with the -rn option to convert
media for the specified robot only.
EXAMPLES
Example 1
To run the catalog converter to convert all the media present on a Backup Exec server:
9
beconv
beconv -all
Example 2
To run the catalog converter to convert only one media present on a Backup Exec server:
beconv -m A00000 -h volume_database_host
Where:
A00000 is the media record corresponding to the Backup Exec media which needs to be
converted.
volume_database_host is the machine where the NetBackup volume manager database
resides.
10
bmrc
bmrc
NAME
bmrc - submit requests to the server daemon
SYNOPSIS
install_path\NetBackup\bin\bmrc -operation change -resource { restoretask | discovertask } [-client clientName] -state numericStateCode -progress numericProgressCode
install_path\NetBackup\bin\bmrc -operation complete -resource { restoretask | discovertask } [-client clientName] -state numericStateCode
install_path\NetBackup\bin\bmrc -operation create -resource log [-client clientName]
install_path\NetBackup\bin\bmrc -operation create -resource message [-client clientName] -msg messageText
install_path\NetBackup\bin\bmrc -operation pull -resource { info | procedure } [-client clientName] -source sourceFileName -destination destinationFileName
DESCRIPTION
The bmrc client program runs on a BMR client and submits requests to the Bare Metal
Restore server daemon. The operation and resource are specified as arguments.
When invoked from an external procedure in the repair environment on a restoring client,
you must specify the path to the bmrc command as follows:
%SystemDrive%\BMR\NBU\bin
At the first boot external procedure point, bmrc is in
install_path\VERITAS\NetBackup\bin.
OPTIONS
-client clientName
Name of the Bare Metal Restore client.
-destination destinationFileName
On pull operation, pathname of file to be created on the local host.
-msg messageText
Text message to be added to the log on the server.
11
bmrc
-operation operationName
An operation to perform:
change
complete
create
pull
-progress numericProgressCode
A numeric progress code, 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 numericStateCode
A numeric state code, used internally by Bare Metal Restore.
EXAMPLES
Example 1
Change the status of a discovery task:
bmrc -operation change -resource discovertask -client clientName
-state numericStateCode -progress numericProgressCode
Example 2
Change the status of a restore task:
bmrc -operation change -resource restoretask -client clientName
-state numericStateCode -progress numericProgressCode
Example 3
Complete a discovery task and set a final status code:
bmrc -operation complete -resource discovertask -client clientName
-status numericStatus
Example 4
12
bmrc
Complete a restore task and set a final status code:
bmrc -operation complete -resource restoretask -client clientName
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 NetBackup Access Management is used in your environment, you have to renew your
user credentials and the machine credentials if the credentials expired before you perform
prepare to restore operations. Use the bpnbat command and -Login option to renew
your user credentials, and use the bpnbat command and -LoginMachine option to
renew the machine credentials.
Specifying -? displays the command’s usage statement when it is the only option on the
command line.
13
bmrconfig
bmrconfig
NAME
bmrconfig - change configuration settings
SYNOPSIS
install_path\NetBackup\bin\bmrconfig -help [-resource resourceType
[-platform win | hp | aix | solaris | linux]
[-manager ldm | lvm | native | sfw | svm | vxvm]
[-operation add | change | clearAll | delete | display | list | map]]
install_path\NetBackup\bin\bmrconfig -operation verify -client clientName -configuration configName
install_path\NetBackup\bin\bmrconfig -operation initialize
-resource disk | network | all
-client clientName -configuration <configName>
-sourceconfiguration source_configName
install_path\NetBackup\bin\bmrconfig -operation initialize -resource disk | network | all
-client clientName -configuration configName
-sourceclient source_clientName -sourceconfiguration
source_configName
install_path\NetBackup\bin\bmrconfig -operation add | change | clearAll | delete | display | list | map
-resource resourceType [-name resourceName]
[-manager ldm | lvm | native | sfw | svm | vxvm]
-client clientName -configuration configName
[-attributes "key=value" ["key=value" ...]]
DESCRIPTION
The bmrconfig command changes a configuration's system, network, volume, driver
and NetBackup settings. The read-only current and discovered configurations cannot be
changed; use the bmrs command to create a copy of a configuration that you can change.
14
bmrconfig
OPTIONS
-attributes
Attributes of the resource are specified as name-value pairs. The name
will always be 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.
-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.
-help
Prints a command line usage message when -help is the only option on
the command line.
-manager The volume manager that controls the resource. Volume managers are:
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 valid characters in a resource
name are determined by the various volume managers.
-operation operation_name
The operation to perform. Operations are:
add – adds a resource to the configuration
change – changes specific attributes of a resource
clearAll – 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 required and optional attributes and values
initialize – intitialize a configuration’s hardware from a discovered
configuration
15
bmrconfig
list – prints all the instances of the specified resource type
map – maps a resource, including dependent resources, from the original
configuration to the working configuration
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:
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 hot fix
hotsparepool – a set of slices 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 – a 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
network – a sub network
nic – a network interface card
nicpkg – a network interface card driver
partition – Windows primary partition
physicalvolume – an AIX or HP-UX physical volume
slice – a Solaris slice; equivalent to volume
softpart – a SVM soft partition
volume – a logical division of a disk or disk group
16
bmrconfig
volumegroup – an AIX or HP-UX volume group
-sourceconfiguration source_configName
The configuration that is the source in an initialize configuration
operation.
-sourceclient source_clientName
The client that serves as the source in an initialize 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 physicalvolume -configuration current -client aixp31
Example 2
Display the attributes of a physical volume for client aixp31:
bmrconfig -operation display -resource physicalvolume -configuration current -client aixp31 -name hdisk0
Example 3
List the volume groups in a configuration for client aixp31:
bmrconfig -operation list -resource volumegroup -configuration current -client aixp31
Example 4
Display the attributes of a volume group for client aixp31:
bmrconfig -operation display -resource volumegroup -configuration current -client aixp31 -name rootvg
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 volumegroup -name rootvg -attributes physicalvolume=hdisk1
17
bmrconfig
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 mynew -client aixp31 -resource volumegroup -name rootvg -attributes physicalvolume=hdisk1 physicalvolume=hdisk0
Example 8
Remove a physical volume from a volume group for client aixp31:
bmrconfig -operation modify -configuration mynew -client aixp31 -resource volumegroup -name rootvg -attributes physicalvolume=hdisk0
Example 9
Map a volume group from the original configuration for client aixp31:
bmrconfig -operation map -configuration mynew -client aixp31 -resource volumegroup -name rootvg
NOTES
Specifying -? displays a synopsis of command usage when it is the only option on the
command line.
SEE ALSO
bmrs
18
bmrepadm
bmrepadm
NAME
bmrepadm - manage external procedures
SYNOPSIS
install_path\NetBackup\bin\bmrepadm [-data] -list [pattern]
install_path\NetBackup\bin\bmrepadm [-data] -delete
procedureName
install_path\NetBackup\bin\bmrepadm [-data] -extract procedureName
install_path\NetBackup\bin\bmrepadm [-data] -add fileName
DESCRIPTION
The bmrepadm command lists, adds, extracts, or deletes external procedures from the
database. The bmrepadm command is installed and runs on the NetBackup master server
that is licensed for BMR.
A procedure name (procedureName) 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.
OPTIONS
-add pathName
Add the external procedure in pathName to the database. The last
component of pathName must be a valid external procedureName.
19
bmrepadm
-data
Normally bmrepadm manipulates an external procedure. When -data is
specified, an arbitrary user-supplied data file is manipulated instead.
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 proceudure name.
-delete procedureName
Delete the procedureName external procedure from the database. The
procedureName must be a valid external procedure name.
-extract procedureName
Extract an external procedure from the database and write it to the
current directory. The procedure name must be a valid external
procedureName.
-list [pattern]
Lists entries (external procedures or user-supplied data files) in the
database. Only 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).
command line.
EXAMPLES
Example 1
To add a data file:
bmrepadm -data -add nameNotMatchingEPname
Example 2
To list the data files:
bmrepadm -data -list
Example 3
20
bmrepadm
To add an external procedure that runs for all Solaris clients after the NetBackup restore
phase of restoration:
bmrepadm -add /example/path/postrestore.sol
Example 4
To add an external procedure that runs before disks are formatted on a client named
zanzibar:
bmrepadm -add ../relative/path/zanzibar_preformat
21
bmrprep
bmrprep
NAME
bmrprep - prepare a client for restore or discovery
SYNOPSIS
<install_path>\NetBackup\bin\bmrprep -restore -client clientName -config configurationName -srt srtName
[-policy policyName] [-logging] [-runep] [-systemOnly] [-import] [-enddate enddate] [-quickformat]
<install_path>\bin\bmrprep-discover -newconfig configurationName -srt srtName [-client clientName
-config configurationName] -address clientAddress
-default defaultGateway -netmask netmask -mac clientMacAddress -server serverAddress -console consoleDeviceName -architecture architectureName
[-gateway serverGateway] [-logging] [-runep]
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.
-console consoleDeviceName
(UNIX and Linux clients only.) Name of the console device to use during
discovery. Required only for a -discover operation; optional if
-client and -config options are specified or if using media boot.
22
bmrprep
-default defaultGateway
(UNIX and Linux clients only.) Default gateway address, in dotted decimal
and -config options are specified or if using 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 date and time format depend on yourregional settings.
-gateway serverGateway
(UNIX and Linux clients only.) Gateway to a NetBackup server, in dotted
decimal notation. Required only for a -discover operation.
-import
Import nonsystem volume groups. For more information about using this
flag, see “Prepare to Restore Client Dialog” in the Bare Metal Restore
System 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 will be
configured during initial program load (IPL)); optional if -client and
-config options are specified or if using media boot.
-netmask netmask
(UNIX and Linux clients only.) Netmask of the client, in dotted decimal
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
(Microsoft Windows clients only.) Quick format Windows partitions.
-restore
Perform a normal restore. Cannot be used with -discover.
23
bmrprep
-runep
Run external procedures.
-server serverAddress
(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
Restore system volume groups only. For more information about using
this option, see “Prepare to Restore Client Dialog” in the Bare Metal
Restore System Administrator's Guide.
NOTES
The format that you must use for date and time values in NetBackup commands varies
according to your regional settings. To access the regional settings, double-click Regional
Settings in the Windows Control Panel. For more information about regional settings, see
the Microsoft documentation.
command line.
SEE ALSO
bpnbat
24
bmrs
bmrs
NAME
bmrs - manage resources in the Bare Metal Restore database
SYNOPSIS
<install_path>\NetBackup\bin\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
<install_path>\NetBackup\bin\bmrs -operation complete -resource discovertask -client clientName -status numericStatus
-resource restoretask -client clientName -status numericStatus
<install_path>\NetBackup\bin\bmrs -operation verify -resource srt -name srtName [-client clientName]
<install_path>\NetBackup\bin\bmrs -operation copy -resource config -name configName -client clientName -destination newConfigName
<install_path>\NetBackup\bin\bmrs -operation retrieve -resource config -client clientName -destination newConfigName
[-enddate date] [-epochenddate eEnddate] [-policy policyName]
<install_path>\NetBackup\bin\bmrs -operation import -resource config -path bundlePath [-client clientName] [-destination newConfigName]
<install_path>\NetBackup\bin\bmrs -operation list -resource resourceName
DESCRIPTION
The bmrs command manages resources in the Bare Metal Restore database. The bmrs
command runs on the master server.
25
bmrs
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.
The date and time format depend on yourregional settings.
-epochenddate eEnddate
The date for point-in-time restore configurations 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, either
discoverTaskLogId or restoreTaskLogId.
-name value
Name of the resource to use for this operation: clientName, configName, packageName, or srtName .
-operation operationName
An operation to perform:
complete
copy
delete
import
list
retrieve
verify
-path bundlePath
Pathname to a bundle file created by the bmrsavecfg command.
-policy policyName
Name of the policy to be used.
-resource resourceName
A resource on which to perform the operation. The allowed resource
names vary with operation specified. For -operation list, the
following resources are supported:
bootserver
26
bmrs
client
config
discovertask
discovertasklog
package
restoretask
restoretasklog
srt
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
command line.
27
bmrs
according to your locale or regional settings. To access the regional settings, double-click
Regional Settings in the Windows Control Panel.
SEE ALSO
bmrc
28
bmrsrtadm
bmrsrtadm
NAME
bmrsrtadm - create and manage shared resource trees and create bootable CD images
SYNOPSIS
<install_path>\NetBackup\bin\bmrsrtadm
DESCRIPTION
The bmrsrtadm command launches the Create Shared Resource Tree wizard. Use the
Create Shared Resource Tree wizard on a BMR boot server 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.
29
bparchive
bparchive
NAME
bparchive - This command archives files to the NetBackup server.
SYNOPSIS
install_path\NetBackup\bin\bparchive [-p policy] [-s schedule][-L
progress_log [-en]] [-S master_server[,master_server,...]] [-t
policy_type] [-w [hh:mm:ss]] [-help] [-k "keyword_phrase"]
-f listfile | filenames
DESCRIPTION
bparchive processes files listed on the command line or in the file specified with the -f
listfile option. Any file path entered can be a file or directory name. If the list of files
includes a directory, bparchive archives all files and subdirectories of that directory
starting at the directory itself.
By default, you are returned 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 this behavior so bparchive works in the
foreground and returns 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 prior to running 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 an install_path\NetBackup\logs\bparchive\ directory with write
access, bparchive creates a debug log file in this directory to use for troubleshooting.
The following restrictions apply to this command:
◆ To archive a file with the bparchive command, 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.
◆ bparchive does not archive the "." or ".." directory entries, and does not archive
disk-image backups.
OPTIONS
-p p
olicy
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.
30
bparchive
-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 is using (see the -p option).
-S master_server
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. To display this dialog, start the Backup, Archive, and
Restore user interface on the client and click Specify NetBackup
Machines on the File menu.
-t policy_type
Specifies one of the following numbers corresponding 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
10 = NetWare
13 = MS-Windows
14 = OS/2
15 = MS-SQL-Server
16 = MS-Exchange-Server
19 = NDMP
Note 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
-L progress_log [-en]
Specifies the name of an existing file in which to write progress
information. For example: c:\proglog.
The default is to not use a progress log.
31
bparchive
Include the -en option to generate a log in English. The name of the log
will contain the string _en. This option is useful to support personnel
assisting in a distributed environment where differing locales may create
logs of various languages.
-w [hh:mm:ss]
Causes NetBackup to wait for a completion status from the server before
returning you to the system prompt.
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.
-help
the command line.
-k keyword_phrase
Specifies a keyword phrase that NetBackup associates with the image
created by this archive operation. You can then 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) containing 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 format required for the file list depends on whether the files have spaces or returns in the names.
To archive files that do not have spaces or returns in the names, use this
format:
filepath
Where filepath is the path to the file you are archiving. For example:
c:\Programs
c:\winnt
c:\documents\old_memos
To archive files that have spaces or returns in the names, use this format:
32
bparchive
filepathlen filepath
Where filepath is the path to the file you are archiving and filepathlen is
the number of characters in the file path.
For example:
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
To archive a single file, enter:
bparchive c:\usr\user1\file1
Example 2
To archive files listed in a file named archive_list, enter:
bparchive -f archive_list
Example 3
To associate the keyword phrase “Archive My Home Directory 02/02/02” to the archive
of the directory c:\home\kwc and use a progress log named c:\home\kwc\arch.log
enter the following:
bparchive -k "Archive My Home Directory 02/02/02" -L
c:\home\kwc\arch.log c:\home\kwc
FILES
install_path\NetBackup\logs\bparchive\*.log
33
bpauthorize
bpauthorize
NAME
bpauthorize - Manage the authorize.txt file on remote servers.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpauthorize [-M nb_server]
[-g user_if_host] [-debug] [-verbose] [-get_privileges]
file
[-debug] [-verbose] -get_authorize file
[-debug] [-verbose] -set_authorize file
DESCRIPTION
This command is available only on NetBackup master servers and sets up authentication
files on NetBackup servers and clients according to the options that are specified on the
command. This command will not longer be supported at the next major release of
NetBackup after the release of NetBackup 6.0.
This command can be executed by any authorized users. For more information about
NetBackup authorization, refer to "Enhanced Authorization and Authentication" in the
NetBackup System Administrator's Guide.
OPTIONS
-debug
Issues debug messages to standard error.
-g user_if_host
When used with -get_privileges, indicates the job monitoring
capabilities of the specified host:
MONITOR_OK = 0 | 1
Where 1 indicates that the host specified can use the more efficient job monitoring capabilities of NetBackup 4.5.
-g option is used internally by the Java interface (jnbSA).
-get_privileges file
Displays the privileges you have on the remote server. If file is specified, output is written to this file. By default, output is
written to standard output.
34
bpauthorize
If -verbose is not indicated, the output would look similar to the
following example:
1 1 1 1 0
The privileges appear in the following order: (-verbose indicated)
IS_SERVER = 0 | 1
Where 1 indicates that the local host name is in the remote machine’s
SERVER list in bp.conf.
IS_MEDIA_SERVER = 0 | 1
Where 1 indicates that the local host name is in the remote machine’s
MEDIA_SERVER list in bp.conf.
IS_ADMIN =0 | 1
Where 1 indicates that the user is an administrator according to the
authorize.txt file on the remote machine.
IS_OPERATOR =0 | 1
Where 1 indicates that the user is an operator according to the
authorize.txt file on the remote machine.
AUTHENTICATION_REQUIRED = 0 | 1
1 = Authentication to the server is required
0 = Authentication to the server is not required
Note If the server is a NetBackup version prior to 4.5, authentication required returns 1.
-get_authorize file
Displays the contents of the authorize.txt file on the remote server.
If file specified, output is written to this file. By default, output is written
to standard output.
-M nb_server
Indicates the remote server to check. The default is the master server.
-set_authorize file
Updates the contents of the authorize.txt file on the remote server.
If file is specified, input is read from this file. By default, input is read
from standard input.
To use, first write the authorize.txt file from a NetBackup server to a
temporary file:
./bpauthorize -M nb_server -get_authorize
/tmp/filename.txt
Then, edit and save the file:
vi /tmp/filename.txt
35
bpauthorize
Finally, use -set_authorize to update the authorize.txt file of the
NetBackup server with the edited file:
./bpauthorize -M nb_server -set_authorize
/tmp/filename.txt
-verbose
Select verbose mode to include more detailed descriptions when using
bpauthorize with -get_privileges or -get_authorize options.
36
bpauthsync
bpauthsync
NAME
bpauthsync - Synchronize authentication files on NetBackup servers and clients.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpauthsync [-verbose]
[-methods] [-names] [-vopie] [-methods_allow path_name]
[-methods_deny path_name] [-names_allow path_name ]
[-names_deny path_name] [-clients [client1 client2 ...
clientN] ] [-servers [server1 server2 ... serverN] ]
DESCRIPTION
This command is available only on NetBackup master servers and sets up authentication
files on NetBackup servers and clients according to the options that are specified on the
command. This command will not longer be supported at the next major release of
NetBackup after the release of NetBackup 6.0.
OPTIONS
-verbose
Issue additional messages.
-methods
Push the methods_allow.txt and methods_deny.txt files to the
specified clients and servers.
-names
Push the names_allow.txt and names_deny.txt files to the
specified clients and servers.
-vopie
Synchronize the VOPIE key files between the specified servers and the
specified clients.
Note If none of -methods, -names, and -vopie is specified, all three are default.
-methods_allow path_name
Specifies the local copy of the methods_allow.txt file to push to the
servers and clients. If this option is not included, NetBackup uses the
install_path\NetBackup\var\auth\methods_allow.txt file.
37
bpauthsync
-methods_deny path_name
Specifies the local copy of the methods_deny.txt file to push to the
install_path\NetBackup\var\auth\methods_deny.txt file.
-names_allow path_name
Specifies the local copy of the names_allow.txt file to push to the
install_path\NetBackup\var\auth\names_allow.txt file.
-names_deny path_name
Specifies the local copy of the names_deny.txt file to push to the
servers and clients. If this option not included, NetBackup uses the
install_path\NetBackup\var\auth\names_deny.txt file.
-clients [ client1 client2 ... clientN ]
Names the clients to update. If -clients is specified without listing any
client names, all unique client names in the NetBackup catalog are
updated. A client name can also be specified in this format:
name:host
Where name is the client name and host is the network host name of the
client. This is useful for specifying NetBackup clients that use dynamic
network addressing like DHCP.
-servers [ server1 server2 ... serverN ]
Names the servers to update.
If -servers is specified but no server names are listed, all server names
in the NetBackup configuration are updated.
Note The following cases also apply to using the -clients and -servers options:
If neither -clients nor -servers is used, all clients and all servers are updated.
If -servers is used but -clients is not, no clients are updated.
If -servers is not used but -clients is used along with vopie (either specifically or by default), the local server is updated.
If -servers is not used but -clients is used along with -names or
-methods, no servers are updated.
FILES
install_path\NetBackup\var\auth\methods.txt
install_path\NetBackup\var\auth\methods_allow.txt
install_path\NetBackup\var\auth\methods_deny.txt
38
bpauthsync
install_path\NetBackup\var\auth\names_allow.txt
install_path\NetBackup\var\auth\names_deny.txt
install_path\NetBackup\var\auth\vopie\*
SEE ALSO
vopied, vopie_util
39
bpbackup
bpbackup
NAME
bpbackup - Back up files to the NetBackup server.
SYNOPSIS
install_path\NetBackup\bin\bpbackup [-p policy] [-s schedule] [-S
master_server...] [-t policy_type] [-L progress_log [-en]] [-w
[hh:mm:ss]] [-help] [-k "keyword_phrase"] -f listfile |
filenames
install_path\NetBackup\bin\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"]
install_path\NetBackup\bin\bpbackup -dssu DSSUname
DESCRIPTION
bpbackup starts either of the following processes:
On clients
Using the first form of the command above, bpbackup starts a user backup that is the
equivalent to what is performed by using the interface on the client. This type of backup
can be started from any NetBackup client in order to back up files from that client.
The bpbackup command 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 or directory name.
If the named files include a directory, bpbackup backs up all files and subdirectories of
that directory starting at the directory itself.
On master servers
Using the second form of the command shown above, bpbackup starts an
immediate-manual backup of a client. This variation requires the -i option on the
bpbackup command and is available only to the administrator on the master server. It is
the equivalent of starting a manual backup from the NetBackup administrator’s interface.
Use the -h option to specify the host.
Since progress logs are written only on clients, and since this form of the bpbackup
command 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.
40
bpbackup
◆ You can back up files and directories owned by other users if you have the necessary
permissions.
◆ bpbackup does not back up the "." or ".." directory entries.
By default, you are returned to the system prompt after bpbackup is successfully
directly to you. The -w option lets you change this behavior so the command works in the
bpbackup writes informative and error messages to a progress-log file if you create the
file prior to running the bpbackup command and then specify the file with the -L
progress_log option. If bpbackup cannot back up the requested files or directories, use
the progress log to determine the reason for the failure.
If you create a directory named install_path\NetBackup\logs\bpbackup with
write access, bpbackup creates a debug log file in this directory that can be used for
troubleshooting.
OPTIONS
-p p
olicy
Names the policy to use for the backup.
If this option is not specified for a user backup, 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. This is the equivalent of starting 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 starts an immediate running of the schedule associated with
the disk staging storage unit. The -i option is the implied behavior and
therfore is not necessary.
-h h
ostname
It 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 s
chedule
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 it is using (see the -p option).
41
bpbackup
-S master_server [,master_server,...]
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. To display this dialog, start the Backup,
Archive, and Restore user interface on the client and click Specify
NetBackup Machines on the File menu.
-t 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
10 = NetWare
13 = MS-Windows
14 = OS/2
15 = MS-SQL-Server
19 = NDMP
17 = SAP
18 = DB2
20 = FlashBackup
21 = Split-Mirror
22 = AFS
Specifies the name of a file in which to write progress information.
NetBackup creates the file if it doesn’t exist.
For example: c:\proglog
42
bpbackup
-w [hh:mm:ss]
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.
It is possible to start a manual or 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 will still only return one return code to the shell.
If you use the -i with the -w option and more than one job begins,
NetBackup waits until all of the jobs have completed before returning a
status. However, because only one status code will be returned to the shell, it is unknown which jobid the status code belongs to.
If the multiple jobs are due to there being more than one client and the
policy does not have Allow Multiple Data Streams selected, you can
include the -h option to restrict the operation to one client and obtain
predictable status. However, if the policy has Allow Multiple Data
Streams selected and there is more than one job from the selected client, the returned status code is again, unknown.
-help
the command line.
-k keyword_phrase
Specifies a keyword phrase that NetBackup associates with the image
being created by this backup operation. You can then 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. All printable characters are
permitted including space (" ") and period ("."). Enclose the phrase in
double quotes ("...") or single quotes ( ‘...’).
43
bpbackup
-f listfile
Specifies a file (listfile) containing a list of files to be backed up. This
option can be used instead of the filenames option, but cannot be used
with the -i option. List each file on a separate line.
The format required for the file list depends on whether the files have spaces or returns in the names.
To back up files that do not have spaces or returns in the names, use this
format:
filepath
Where filepath is the path to the file you are backing up. For example:
c:\Programs
c:\winnt
c:\documents\old_memos
To back up files that have spaces or returns in the names, use this format:
Where filepath is the path to the file you are backing up and filepathlen is
the number of characters in the file path. For example:
11 c:\Programs
8 c:\winnt
22 c:\documents\old memos
filenames
Names one or more files to be backed up. This option can be used instead
of the -f option, but cannot be used with the -i option. Any files that
you specify must be listed at the end, following all other options.
EXAMPLES
Example 1
To perform a user backup of a single file, enter:
bpbackup c:\users\user1\file1
Example 2
The following command starts a user backup of the files that are listed in a file named
backup_list.
bpbackup -f backup_list
Example 3
44
bpbackup
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.
bpbackup -p cis_co -i -h diablo -S hoss -t 0
Example 4
The following command (all on one line) associates the keyword phrase “Backup My
Home Directory 01/01/01” to the user backup of the directory c:\home\kwc . The
progress log is:
bpbackup -k "Backup My Home Directory 01/01/01" -L c:\home\kwc\bkup.log c:\home\kwc
Example 5
The following command (all on one line) 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.
bpbackup -k "Policy Win 01/01/01" -i -h slater -p win_nt_policy -t 13
FILES
install_path\NetBackup\logs\bpbackup\*.log
45
bpbackupdb
bpbackupdb
NAME
bpbackupdb - Back up NetBackup image catalogs.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpbackupdb [{-dpath
disk_path}] | {-tpath tape_device_path [-m media_ID]} |
{-opath optical_device_path [-m media_ID]}] [-nodbpaths]
[-v] [path...]
install_path\NetBackup\bin\admincmd\bpbackupdb [-p policy_name -s sched_label]
DESCRIPTION
bpbackupdb initiates a backup of one or more NetBackup image catalogs specified on the
bpbackupdb command line. bpbackupdb also backs up the default set of NetBackup
catalogs, unless the command line contains -nodbpaths. If the command line specifies a
destination, the backup is stored there.
Otherwise, the backup is stored at the default location for backups of the NetBackup
internal databases, which are called catalogs.
You can specify the default set of catalogs and the backup destination:
◆ The default paths to the NetBackup image catalogs are part of the NetBackup
configuration. bpbackupdb uses the set of configured NetBackup catalog paths as
the default value for the path option.
◆ The NetBackup configuration includes two destinations (media IDs or disk
pathnames) for NetBackup catalog backups. bpbackupdb uses the less-recently used
of the two destinations as its default value for the backup destination.
The NetBackup System Administrator’s Guide explains how to configure and display these
values.
Only one copy of bpbackupdb can run at a time. The bpbackupdb command fails if it
determines that a NetBackup catalog backup is already running. If bpbackupdb fails
because other backups are in progress, retry when no other NetBackup activity is
occurring.
If bpbackupdb fails with the message “cannot find Internet service bpcd/tcp,” then the
service/protocol pair bpcd, tcp is not among the set of services defined on the local
system. On Windows, look for a bpcd/tcp entry in the
install_path\system32\drivers\etc\services file.
46
bpbackupdb
The NetBackup System Administrator’s Guide provides additional information on backing
up NetBackup catalogs. The NetBackup utility bprecover recovers catalogs that
bpbackupdb has backed up. The NetBackup troubleshooting guide (Windows version)
provides information on restoring the NetBackup catalogs if a disaster recovery is
required.
OPTIONS
You can either specify a list of NetBackup image catalogs with the following options or
default to the catalogs specified in the NetBackup configuration:
-dpath disk_path
-tpath tape_device_path
-opath optical_device_path
-tpath specifies a tape raw device path as the destination for the
backup.
-opath specifies an optical raw device path as the destination for the
backup.
-dpath Specifies a raw disk path as the destination for the backup.
If the media for the catalog backup is non-robotic, a mount request occurs
and the catalog backup waits until the mount request is either granted or
denied. The MEDIA_MOUNT_TIMEOUT attribute does not apply to this
request.
The NetBackup Device Manager service and NetBackup Volume
Manager service need not be active when you use the -dpath option.
If -tpath or -opath is used, the device name can be an NDMP device
name. The syntax for an NDMP device name is client:drivename. An
NDMP device name can contain / but it cannot contain /ndmp.
-m media_ID
This is option specifies the media ID for the NetBackup database backup.
This option is meaningful when either -tpath or -opath is used.
Media Manager uses the media ID for removable media to verify that the
correct media is mounted. The media ID string length is between one and
six characters and the string can be either uppercase or lowercase.
-help
the command line.
47
bpbackupdb
-nodbpaths
Do not back up the configured NetBackup catalogs. If this option is
present, you must specify at least one catalog path on the command line.
If this option is absent, bpbackupdb backs up the catalogs configured by
NetBackup for catalog backups, as well as any catalog listed by the path
option.
-p policy_name -s sched_label
The -p and -s options are used to launch a policy-based, hot catalog
backup.
-v
Selects verbose mode. This option causes bpbackupdb to log additional
information for debugging purposes. The information goes into the
NetBackup administration daily debug log. This option is meaningful
only when NetBackup has debug logging enabled
(install_path\netbackup\logs\admin directory defined).
path...
Back up these NetBackup catalogs. This is a list of absolute pathnames.
To back up a NetBackup catalog on the master server, specify the catalog backup path as an absolute pathname, for instance, install_path\Volmgr\database.
If the backup path contains special characters, such as blank(" "), the pathname must be enclosed in quotes ("). Use a blank to separate two pathnames, not a comma. The complete list of pathnames to be backed up must also be enclosed in quotes. See Example 3.
To back up a NetBackup catalog on a media server other than the master server (this configuration is supported only by NetBackup Enterprise Server), specify the catalog backup path as hostname:pathname. For instance, hostname:install_path\Volmgr\database.
There must be at least one path specified if -nodbpaths is present. RETURN VALUES
An exit status of 0 means that the backup ran successfully.
Any exit status other than 0 means that an error occurred.
EXAMPLES
Examples 1 and 2 assume that NetBackup has been configured so that bpbackupdb can
use the default values for catalogs and destination. Example 3 uses the path... option to
specify the catalogs to back up.
Example 1
The following example backs up the NetBackup catalogs
48
bpbackupdb
bpbackupdb
If the backup succeeds, the NetBackup mail administrator receives an email that contains
the details of the backup.
If the backup fails, the NetBackup mail administrator receives an email that contains the reason for the failure.
Example 2
The following example backs up the NetBackup catalogs to the tape device \\.\Tape1.
bpbackupdb -tpath \\.\Tape1
Example 3
This example backs up the catalogs specified in the path... option in addition to the configured NetBackup catalogs.
bpbackupdb ""C:\catalog A" "C:\catalog B""
MESSAGES
If bpbackupdb succeeds, it logs one of the following messages:
NB database backup to path destination SUCCEEDED
NB database backup to media id destination SUCCEEDED
NB database backup SUCCEEDED
If bpbackupdb fails, it logs one of the following messages:
NB database backup to path destination FAILED
NB database backup to media id destination FAILED
NB database backup FAILED
bpbackupdb also sends mail to the NetBackup administrator reporting the results of the
backup.
FILES
install_path\NetBackup\db\*
install_path\NetBackup\logs\admin\log.mmddyy
install_path\Volmgr\database\*
SEE ALSO
bprecover
49
bpcatarc
bpcatarc
NAME
bpcatarc - Back up NetBackup catalog.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpcatarc [-version] [-help]
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
Display the bpcatarc version and exit.
-help
Display the help text.
SEE ALSO
bpcatlist, bpcatres, bpcatrm 50
bpcatlist
bpcatlist
NAME
bpcatlist - List selected parts of the NetBackup catalog.
SYNOPSIS
install_path\NetBackup\bin\admincmd\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] [-help] [-online |
-offline]
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 wish to work. All
files-file (also called image .f files), the largest files in a NetBackup catalog, selected for
bpcatarc, bpcatres, or bpcatrm, are first selected with bpcatlist. The output of
bpcatlist is piped to the action you wish 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
Create 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]]
List backup images since the specified time expressed in ctime (for
example, Fri Sep 13 00:00:00 2004). If no year is specified, bpcatlist uses the current year by default. The following command lists all images after December 31, 2004:
bpcatlist -since 2004
51
bpcatlist
Additional examples are found in the following “Examples” section.
-before [ctime | [-since-days nnn | -since-weeks nnn |
-since-months nnn | -before-days nnn | -before-weeks
nnn | -before-months nnn]]
List backup images before the specified time expressed in ctime (for
example, Fri Sep 13 00:00:00 2004). If no year is specified,
bpcatlist uses the current year by default. For example:
-date ctime
List of backup images for the specified date expressed in ctime (for
example, Fri Sep 13 00:00:00 2004). If no date is specified,
bpcatlist uses the current date by default.
Additional examples are found in the following “Examples” section.
-catarc catarc_id
List the files-file that were archived with the specified catarc_id. For
example:
-catarc 1022754972 -policy policy_name
List the backups created by the indicated policy_name for the specified
client.
-sched sched_name
List the backups created following schedule_name for the specified
client.
-id backup_id
Create a list for the specified backup_id.
-online
List only files-file that are online.
-offline
List only files-file that are offline.
-version
Display the bpcatlist version and exit.
-help
EXAMPLES
Dates are displayed and must be specified in ctime() 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 16 14:16:28 2004
52
bpcatlist
(When no year is specified, the current year is used by default.)
To list all backups between two dates of the current year, specify:
bpcatlist -before Mon Sep 10 00:00:00 2004 -since Fri Oct 4 00:00:00 2004
To list backups that are two to three months old, specify:
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 following setting: -since-days 14
is equivalent to: -since-weeks 2
SEE ALSO
bpcatarc, bpcatres, bpcatrm Chapter 1, NetBackup Commands
53
bpcatres
bpcatres
NAME
bpcatres - Restore NetBackup catalog.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpcatres [-version] [-help]
DESCRIPTION
bpcatres processes the output of bpcatlist to restore the selected catalog image .f
files.
OPTIONS
-version
Display the bpcatres version and exit.
-help
SEE ALSO
bpcatarc, bpcatlist, bpcatrm 54
bpcatrm
bpcatrm
NAME
bpcatrm - Delete NetBackup catalog
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpcatrm [-version] [-help]
DESCRIPTION
bpcatrm processes the output of bpcatlist or bpcatarc to delete the selected catalog
image .f files which have a valid catarc id in their image file.
OPTIONS
-version
Display the bpcatrm version and exit.
-help
SEE ALSO
bpcatarc, bpcatlist, bpcatres Chapter 1, NetBackup Commands
55
bpcd
bpcd
NAME
bpcd - NetBackup client daemon. Enables NetBackup clients and servers to accept
requests from NetBackup servers.
SYNOPSIS
install_path\NetBackup\bin\bpcd.exe [-standalone] [-debug] [-portnum number] [-keyfile] [-restrict_if host_or_ip]
DESCRIPTION
bpcd is communications daemon that is activated by the NetBackup Client Service
bpinetd(1M) on Windows systems. Typically, bpcd is activated by inetd(1M) on
UNIX systems.
The bpcd daemon accepts requests from NetBackup servers. Requests include initiating
backup and restore jobs and getting and setting NetBackup configuration parameters.
When you install NetBackup on a Windows client, the installation process adds entries for
bpcd to %SystemRoot%\system32\drivers\etc\services.
The services entry looks like this:
bpcd 13782/tcp
bpcd
The inetd.conf entry on UNIX looks like this:
bpcd stream
tcp
nowait
root
/usr/openv/netbackup/bin/bpcd bpcd
OPTIONS
-standalone
Available only on UNIX clients and specifies that bpcd will run
continuously rather than being started by inetd.
-debug
Available only on UNIX clients and implies -standalone. This option
prevents bpcd from forking and does not disconnect it from standard
input, output, and error.
-portnum number
Available only on UNIX clients and implies -standalone. Specifies the
port number where bpcd listens for requests. The default is the bpcd
entry in: /etc/services.
56
bpcd
-restrict_if host_or_ip
Available only on UNIX clients and implies -standalone. Specifies the
local network interface that bpcd will accept connections from. Default is
to accept connections from all local network interfaces. You can specify
either a host name or an IP address.
-keyfile
Available only on UNIX clients and implies "-standalone". When
specified, you will be prompted for the NetBackup key file pass phrase
that will allow bpcd to access the NetBackup encryption key file. See the
section "Additional Key File Security (UNIX clients only)" in the VERITAS
NetBackup Encryption System Administrator's Guide for additional
information.
SEE ALSO
bpclient, bpkeyfile
57
bpchangeprimary
bpchangeprimary
NAME
bpchangeprimary - Promote a copy of a backup to be the primary copy.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpchangeprimary -copy
number | -pool volume_pool | -group volume_group [-id
backup_id] [-M master_server]
install_path\NetBackup\bin\admincmd\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] [-ed
date] [-M master_server]
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 has been sent
offsite, change the primary copy to be the copy that remains on site.
The bpchangeprimary command finds all backups that match the specified criteria, and
for those images found, 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 and changes to primary, all copies that reside on
those media.
OPTIONS
One of the following three options is required; using one precludes use of the others.
-copy number
Specifies that copy_number is the number of the backup copy you want
to promote to primary.
58
bpchangeprimary
-pool volume_pool
Specifies that the copy that is on media belonging to volume_pool should
be promoted to primary.
-group volume_group
Specifies that the copy that is on media belonging to volume_group
should be promoted to primary.
Combinations of one or more of the following criteria can be applied to specify which
copies will be made primary. None of the following options are required.
-cl client_name
Specifies that backups of client_name will be affected. This name must
be as it appears in the NetBackup catalog. For those backup images, the
copy that corresponds to the specified -pool, -group, or -copy option
will be promoted to primary. The default is all clients.
-sd date
-ed date
Specifies the start date (-sd) or end date (-ed) of the backup images for
which the primary copy will be changed.
The default start date is January 1, 1970, effectively causing a search for
all images. If you run bpchangeprimary without using the -sd option,
you are prompted for confirmation that you want to change the primary
copy for backups created after January 1, 1970.
The format of date depends on the user's locale setting. See the NOTES
section for more information. For the C locale, the date syntax is as
follows:
mm/dd/yy [hh[:mm[:ss]]]
The default end date 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.
-id backup_id
Specifies the backup id of the backup image for which the primary copy
will be changed. For that backup image, the copy that corresponds to the
specified -pool, -group, or -copy option will be changed.
If you specify this option, you can specify an alternate master server
(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 identifying
backup images for which the primary copy will be changed.
59
bpchangeprimary
-M master_server
Specifies that backups belonging to master_server will be affected. For
those backup images, the copy that corresponds to the specified -pool,
-group, or -copy option will be promoted to primary.
If you use this option, then any other options you specify determine
which backup images on the specified master server will be affected. The
master_server must allow access by the system issuing the
bpchangeprimary command. The default is the master server for the
system running the bpchangeprimary command.
-pn policy_name
Specifies the name of the backup policy of the backups for which the
primary copy will be changed. The default is all policies.
-pt policy_type
Specifies the type of the backup policies of the backups for which the
primary copy will be 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
Auspex-FastBackup
DataTools-SQL-BackTrack
DB2
FlashBackup
SAP
Split-Mirror
-sl schedule_name
Specifies the schedule name (label) for the selection of the backup images
for which the primary copy will be changed.
By default, the bpchangeprimary command uses all schedules.
60
bpchangeprimary
-st schedule_type
Specifies the schedule type for the selection of the backup images for
which the primary copy will be 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)
NOTES
according to your locale setting.
If you are uncertain of the NetBackup command requirements for your locale, enter the
command with the -help option and check the USAGE. For example, the following is
the output for the -sd and -ed options:
[-sd mm/dd/yyyy HH:MM:SS] [-ed mm/dd/yyyy HH:MM:SS]
Notice the month/day/year and hours:minutes:seconds requirements. These are for a
locale setting of C and can be different for other locales.
EXAMPLES
Example 1
The following command will promote all copies on media belonging to the volume pool,
SUN, created after 08/01/2003 to be the primary copy.
bpchangeprimary -pool SUN -sd 08/01/2003
Example 2
The following command will promote copy 2 of all backups of client, oak, created after
01/01/2003 to be the primary copy:
bpchangeprimary -copy 2 -cl oak -sd 01/01/2003
Example 3
The following command will promote copy 4 of all backups that were created by the
backup policy, Offsite, after 08/01/2003 to be the primary copy:
bpchangeprimary -copy 4 -pn Offsite -sd 08/01/2003
61
bpclient
bpclient
NAME
bpclient - Manage client entries on a master server.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpclient [-All] [-M
master_server] [-l|-L|-H]
install_path\NetBackup\bin\admincmd\bpclient -client client_name
[-M master_server] [-l|-L|-H]
[-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]}}
[-M master_server] -delete
DESCRIPTION
The bpclient command describes how a NetBackup server connects to NetBackup
clients.
OPTIONS
-add
Add a new client entry.
-All
List all client entries. Only client entries added explicitly using the
bpclient command are displayed.
-client client_name
Where client_name is the name of the client to list or update.
-connect_options 0|1|2 0|1|2 0|1|2|3
First set of arguments, Ports, represent the following:
0 = Reserved Port: Use a reserved port number
62
bpclient
1 = Non-reserved Port: Connect to the client’s bpcd using a non-reserved
port number. If you select this option, enable Allow Nonreserved Ports
for the selected client. (See the Universal Settings dialog under Host
Properties > Clients.)
2 = Use Default: Use Default is the default. Use the value defined by the DEFAULT_CONNECT_OPTIONS configuration entry on the server.
The second set of arguments, BPCD Connect Back, represent 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: This is the default option. Use the value defined by the DEFAULT_CONNECT_OPTIONS configuration entry on the server.
The third set of arguments, Daemon Connection Port, represent the following:
0 = Automatic: This option means VNETD is used is possible, otherwise
Legacy will be used.
1 = Use the VNETD port.
2 = Use the Legacy port number.
3 = Use Default: This is the default option. Use the value defined by the DEFAULT_CONNECT_OPTIONS configuration entry on the server.
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/IP address of the client. This is only meaningful in the
situation where 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/IP address.
-delete
Delete an existing client entry.
-dynamic_address 0|1
0 = The client name is assumed to be a valid host name for the client
(default).
63
bpclient
1 = The client is assumed to have a dynamic host name (such as DHCP).
-free_browse 0|1|2
-free_browse is a method that allows users to get around the checking
that the server does when browsing images (owner/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). In
order to free browsing to occur, either the client or the server must be
setup to 2 (use) and neither can be setup for 1 (deny).
-H
List host specific client information.
-l
Lists limited client information.
-L
List all client information in a VERBOSE format.
-M master_server
Name of the master server containing the client entries. The first server
name in the local configuration is the default master server.
-list_restore 0|1|2|3
-list_restore can be set up on the server to disallow list and/or
restore requests from a particular client. The value that is found 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]
Specify the maximum number of jobs allowed to run concurrently on this
client, up to 99. This item can be configured in the NetBackup-Java
Administration Console and is labeled “Maximum data streams”. To
perform this function using this GUI, select the following: Host
Properties > Master Servers > (double-click the master server name) >
Client Attributes > Then select the client.
-update
Update an existing client entry.
64
bpclient
-WOFB_enabled 0|1
0 = disable Windows Open File Backup for the client specified in
client_name. 1 = enable Windows Open File Backup for the client specified in
client_name.
-WOFB_FIM 0|1
0 = Use Volume Snapshot Provider (VSP) as the snapshot provider for the
Windows Open File Backups
1 = Use Microsoft's Volume Shadow Service (VSS) as the snapshot
provider for Windows Open File Backups
-WOFB_usage 0|1
0 = Individual Drive Snapshot. The Individual Drive Snapshot property
specifies that the snapshot should be of an individual drive. When this
property is enabled, snapshot creation and file backup is done
sequentially on a per volume basis.
1 = Global Drive Snapshot. The Global Drive Snapshot property specifies
that the snapshot be of a global drive, where all the volumes that require
snapshots for the backup job (or stream group for multi-streamed
backups) are taken at one time.
-WOFB_error 0|1
0=Abort Backup on Error. The Abort Backup on Error property specifies
that a backup aborts if it fails for a snapshot-related issue after the
snapshot is created and while the backup is using the snapshot to back up
open or active files on the file system.
1=Disable Snapshot and Continue. The Disable Snapshot and Continue
property 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.
NOTES
65
bpclntcmd
bpclntcmd
NAME
bpclntcmd - Tests the functionality of a NetBackup system.
SYNOPSIS
install_path\bin\bpclntcmd[-check_vxss] [-check_vxss_with_host
hostname] [-gethostname] [-get_bpx_port hostname]
[-get_remote_host_version hostname] [-hn hostname]
[-ip ip_address] [-is_local_host hostname] [-pn] [-self]
[-server NBU_master] [-sv]
DESCRIPTION
The bpclntcmd command tests functionality and displays information about a NetBackup
system.
You must have administrative privileges to execute this command.
OPTIONS
-check_vxss
Check if NBAC is configured (or not configured) correctly on the local
system.
-check_vxss_with_host hostname
Check if NBAC is configured (or not configured) correctly on the local
system to connect to the remote host, hostname.
-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.
-get_remote_host_version hostname
Returns the version of NetBackup that is running on the system identified
in the hostname variable.
-hn hostname
Returns the host name, alias, and IP address information about the host
name identified in the hostname variable.
66
bpclntcmd
-ip ip_address
Returns the host name, alias, and IP address information about IP
address, ipaddress.
-is_local_host hostname
Check if hostname is a network interface on the local system.
-pn
Returns what the master server considers your host name (or peer name)
to be.
-self
Returns 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
67
bpcompatd
bpcompatd
NAME
bpcompatd - A NetBackup compatibility service.
SYNOPSIS
install_path\NetBackup\bin\bpcompatd [-max_time seconds] [-console] [-debug]
install_path\NetBackup\bin\bpcompatd -help [-debug]
install_path\NetBackup\bin\bpcompatd -alive [-debug]
install_path\NetBackup\bin\bpcompatd -terminate [-debug]
install_path\NetBackup\bin\bpcompatd -bpcd_connect clientname
[-debug]
install_path\NetBackup\bin\bpcompatd -vmd_connect hostname
[-debug]
install_path\NetBackup\bin\bpcompatd -robot_connect hostname
robot_type [-debug]
install_path\NetBackup\bin\bpcompatd -bpjobd_connect hostname
[-debug]
install_path\NetBackup\bin\bpcompatd -bpdbm_connect hostname
[-debug]
install_path\NetBackup\bin\bpcompatd -bprd_connect hostname
[-debug]
DESCRIPTION
This command is used internally by new NetBackup services to communicate with legacy
NetBackup services.
OPTIONS
-help
Display options available with the bpcompatd command.
-alive
Test the local bpcompatd daemon/service to see if it is running.
-terminate
Terminate the local bpcompatd daemon/service if it is running.
68
bpcompatd
-bpcd_connect clientname
Test a bpcd connection to clientname using the bpcompatd
command.
-vmd_connect hostname
Test a vmd connection to hostname using the bpcompatd command.
-robot_connect hostname
Test a robot daemon connection to hostname for robot type <robot_type>
via bpcompatd.
-bpjobd_connect hostname
Test a bpjobd connection to hostname using the bpcompatd command.
-bpdbm_connect hostname
Test a bpdbm connection to hostname using the bpcompatd command.
-bprd_connect hostname
Test a bprd connection to hostname using the bpcompatd command.
If you specify -debug, information that is normally logged in the debug log file of
bpcompatd will be written to standard error.
If you do not specify one of the above 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/service:
-max_time seconds
The maximum time bpcompatd waits for a new connection before
performing housekeeping tasks. The default is 60 seconds for
UNIX/Linux and 1 second for Windows.
-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, information that is normally logged in thedebug
log file of bpcompatd will be written to standard error. For Windows,
this option implies the -console option. For UNIX/Linux, this option
prevents the bpcompatd service from running in the background.
69
bpconfig
bpconfig
NAME
bpconfig - Modify or display the global configuration attributes for NetBackup.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpconfig [-cd seconds
86400...2147472000 or 0 (Compress OFF)] [-ha hours 1...32767]
[-kl days 1...32767 or 0 (Keep Logs OFF)] [-kt days 1...32767
or 0 (TIR Info OFF)] [-ma [address]] [-mdtm drives] [-mj
number 1...32767] [-period hours 1...24] [-prep hours] [-to
seconds] [-max_copies 2...10] [cleanup_int hours] [-tries
times 1...32767] [-wi minutes 1...1440] [-v] [-M
master_server,...]
install_path\NetBackup\bin\admincmd\bpconfig [-L | -l | -U [-v]
[-M master_server,...]]
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
should be adequate for most installations. The section on NetBackup Global Attributes, in
the NetBackup System Administrator’s Guide describes the implications of setting the
attribute values.
◆ 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 the section DISPLAY FORMATS for more detail on the
displays.
Errors are sent to stderr. A log of the command's activity is sent to the NetBackup admin
log file for the current day.
This command can be executed by authorized users. For more information about
70
bpconfig
OPTIONS
-cd seconds 86400...2147472000 or 0 (Compress OFF)
The number of seconds that is the Compress-image-Database time
interval. When seconds is a positive integer, an image will be compressed
after this number of seconds has elapsed since the creation of the image.
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 less disk space is needed for the image
database. However, when browsing the image database for restoring, the
images need to be decompressed before they can be searched. While
browsing for a restore, the compressed images will not be found. To
decompress the images, you must use bpimage(1M).
The default is 0, which means no compression is done.
-cleanup_int hours This option enables you to run cleanup on a database image and in the
background so jobs can run at the same time. You can configure the
interval in which the database image cleanup will run.
-mdtm drives
The maximum drives for this master, the maximum number of drives for
this master and remote media server cluster that the master server should
consider available when scheduling backups. An appropriate value for
this attribute is the physical number of drives, counting shared drives
only once, in the master and media server cluster. drives must be less than
or equal to the number permitted by the version of NetBackup that is
installed on the server (that is, 2 for NetBackup Server and unlimited for
NetBackup Enterprise Server). drives is a non-negative integer. The
default is 0 (unlimited).
-ha hours 1...32767
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 instance, if hours ago is 24 and if you request a Backup
Status report at 10:00 a.m., the report includes all backups run 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. The
default value is 24 hours.
-kl days 1...32767 or 0 (Keep Logs OFF)
The number of days to keep logs. This determines how long the
NetBackup master server keeps its Error database and debug logs.
NetBackup derives its Backup Status, Problems, All Log Entries, and
71
bpconfig
Media Log Entries reports from the Error database, so this value limits the
period that these reports can cover. The default is 28 days. A 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 or 0 (TIR Info OFF)
The number of days to Keep True-image-recovery (TIR) data. This
determines how long to keep TIR information for those policies that have
specified that TIR information is to be collected. The default is 1 day.
-L
The list type is long. See the section DISPLAY FORMATS for more detail.
-l
The list type is short. This 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,...
A list of master servers. This 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 issuing
the command. If an error occurs for any master server, processing stops
at that point in the list. The default is the master server for the system
where the command is entered.
-ma [address]
The mail address for the NetBackup administrator. This is the email
address to which NetBackup sends notification of failed automatic
backups, administrator-directed manual backup operations, and
automatic database backups. The default is NULL (no email address).
If no address is provided, the current setting of the Admin Mail Address
is cleared. This means that notification no longer will be sent by email to
the NetBackup administrator.
-max_copies 2...10
Specify the maximum number of copies per backup. Copies can range
from between 2 and 10. The default is 2.
-mhto seconds
The multihosted-media-mount timeout, the length of time, in seconds,
that NetBackup waits for a shared medium to be mounted, positioned,
and become ready on backups and restores. Use this timeout to eliminate
excessive waits when a shared medium is being used by another server.
The default is 0, which means no timeout (unlimited wait time).
72
bpconfig
-mj number 1...32767
Specifies the maximum jobs per client. This is the maximum number of
jobs that a client may perform concurrently. number must be a positive
integer. The default is 1.
-period hours 1...24
The time interval associated with the configured number of tries for a
backup (see -tries). This is the period, in hours, during which
NetBackup will attempt a backup job for a client/policy/schedule
combination for as many tries as configured. hours must be a positive
integer. The default is 12 hours.
Note This attribute does not apply to user-directed backups and archives.
-prep hours
The preprocessing interval. This is the minimum time in hours between
client queries to discover new paths if NetBackup is using
auto-discover-streaming mode. For additional information, see the
“Setting the Preprocess Interval for Auto Discovery” section in the topic
on File-List Directives for Multiple Data Streams in the NetBackup System
Administrator’s Guide.
The default Preprocessing Interval value is 4 hours. If the preprocessing
interval is changed, it can be changed back to the default by specifying
-prep -1.
The preprocessing interval can be set for immediate preprocessing by
specifying 0 as the preprocess interval for auto discovery on the
bpconfig command line.
The maximum Preprocessing Interval is 48 hours.
-to seconds
This is the media-mount timeout, the length of time, in seconds, that
NetBackup waits for the requested media to be mounted, positioned, and
become ready on backups and restores. Use this timeout to eliminate
excessive waits when it is necessary to manually mount media (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 must be 300 (5 minutes) or greater.
-tries times
The number of retries for a backup, during the configured time period
(see -period). NetBackup tries to run a backup job for a given
client/policy/schedule combination this many times in the configured
period. This allows you to limit the number of backup attempts should
repeated failures occur.
73
bpconfig
Note This attribute does not apply to user-directed backups and archives.
Usually the number of tries should be greater than 0. Specifying 0 for the
number of tries is legal but stops all scheduled backups. The default is 2
tries. If defaults are used for both -tries and -period, NetBackup will
attempt the backup 2 times in 12 hours.
-U
The list type is user. See the section DISPLAY FORMATS for more detail.
-v
Select verbose mode for logging. This is only meaningful when running
with debug logging turned on (the
install_path\NetBackup\logs\admin directory is defined).
-wi minutes
This is the wakeup Interval, the length in time in minutes that the
scheduler waits before checking if any automatic backups are scheduled
to begin. A long wakeup interval can cause the scheduler to miss too
much of the backup window to complete its backups. The default is 10
minutes.
DISPLAY FORMATS
bpconfig uses 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 listing with one global attribute per line. Each line has the form global attribute
descriptor: value. This listing is similar to the -L format, except that the global attribute
descriptors are more explicit:
Admin Mail Address
Job Retry Delay
Max Simultaneous Jobs/Client
Backup Tries (x tries in y hours)
Keep Error/Debug Logs
Max drives this master
Keep TrueImageRecovery Info
Compress Image DB Files
Maximum Backup Copies
74
bpconfig
Media Mount Timeout
Display Reports
Preprocess Interval
◆
Long Format (-L)
If the command line contains -L, the display format is long. This option produces a listing
with one global attribute per line, in the format global attribute descriptor: value. The
fields in this display are as follows:
Mail Admin
Job Retry Delay
Max Jobs/Client
Backup Tries (x in y hours)
Keep Logs
Max drives/master
Compress DB Files
Maximum Backup Copies
Media Mnt Timeout
Postprocess Image
Display Reports
Keep TIR Info
Prep Interval
◆
Short Format (-l)
If the bpconfig command line contains -l or contains no list-format option, the display
format is short. This produces a terse listing. This option can be useful for scripts or
programs that rework the listing into a customized report format. The listing layout is a
single line containing the values for all global attributes. The attributes appear in the
following order, separated by blanks. For those attributes that are expressed in units of
time, the time units follow the attributes in parentheses:
NetBackup administrator email address
Job Retry Delay (minutes)
Time period (hours)
Maximum simultaneous jobs per client
Tries per period
75
bpconfig
Keep logs (days)
Maximum drives this master
Compress 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 immediate)
Display reports from <x> hours ago (hours)
Keep TIR information (days)
Preprocessing interval (hours)
◆
Example of How the Formats Differ
Here is an 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 this:
bpconfig -U
Admin Mail Address:
Job Retry Delay:
Max Simultaneous Jobs/Client:
Backup Tries:
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:
10
1 minutes
1
2 time(s) in 12 hour(s)
28 days
0
1 days
(not enabled)
0 minutes (unlimited)
24 hours ago
0 hours
The second display format, -L, looks like this:
bpconfig -L
Mail Admin:
Job Retry Delay:
Max Jobs/Client:
Backup Tries:
Keep Logs:
Max drives/master:
Compress DB Files:
Media Mnt Timeout:
Postprocess Image:
Display Reports:
76
*NULL*
1 minutes
1
2 in 12 hours
28 days
0
(not enabled)
immediately
24 hours ago
bpconfig
Keep TIR Info:
1 days
Prep Interval:
0 hours
Maximum Backup Copies: 10
The third display format, -l, looks like this:
bpconfig -l
*NULL* 1 12 1 2 28 0 0 0 0 1 24 1 0
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 1 day
Preprocessing interval is 0 hours
RETURN VALUES
An exit status of 0 means that the command ran successfully.
If administrative logging is enabled, the exit status is logged in the administrative daily
log under the directory install_path\NetBackup\logs\admin in the form:
bpconfig: EXIT status = exit status
If an error occurred, a diagnostic precedes this message.
EXAMPLES
Example 1
77
bpconfig
While running on the master server kiwi, 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:
6 days
0
Keep TrueImageRecovery Info: 1 days
(not enabled)
30 minutes
Display Reports:
24 hours ago
0 hours
10 Example 2
Set the Compress-image-database interval to 604800 seconds, so that NetBackup
compresses images more than 7 days old:
bpconfig -cd 604800
bpconfig -U
Admin Mail Address:
Job Retry Delay:
Backup Tries:
Display Reports:
10 minutes
1
28 days
0
2 days
older than 7 day(s)
24 hours ago
0 hours
10
Example 3
Set the Media Mount Timeout to 1800 seconds.
bpconfig -to 1800
bpconfig -U
Admin Mail Address:
Job Retry Delay:
Backup Tries:
78
[email protected]
10 minutes
1
bpconfig
Display Reports:
3 days
0
24 days
(not enabled)
30 minutes
24 hours ago
0 hours
10
FILES
install_path\NetBackup\logs\admin\*
install_path\NetBackup\db\config\behavior
SEE ALSO
bpimage
See the NetBackup Media Manager System Administrator’s Guide for information on Multi
Hosted Drives.
79
bpdbjobs
bpdbjobs
NAME
bpdbjobs - Interact with the NetBackup jobs database.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpdbjobs [-report] [-M
master_servers] [-vault | -lvault | -all_columns |
-most_columns | -gdm] [-file pathname] [-append]
[-noheader] [-mastertime] [-jobid job1,job2,...jobn]
install_path\NetBackup\bin\admincmd\bpdbjobs -summary [-M
master_servers] [-U | -L | -all_columns] [-file pathname]
[-append]
install_path\NetBackup\bin\admincmd\bpdbjobs {-resume |
-suspend | -delete | -cancel | -restart} {job1,job2,...jobn
|type=jobtype|type=all} [-M master_server] [-quiet]
install_path\NetBackup\bin\admincmd\bpdbjobs -cancel_all [-M
master_server]
install_path\NetBackup\bin\admincmd\bpdbjobs -clean [-M
master_server] [-keep_hours hours | -keep_days days]
[-keep_successful_hours hours | -keep_successful_days
days] [-verbose]
install_path\NetBackup\bin\admincmd\bpdbjobs -version
install_path\NetBackup\bin\admincmd\bpdbjobs -help
DESCRIPTION
bpdbjobs interacts with the jobs database and is useful in scripts or as a command line
administration tool. Use bpdbjobs to print the entire jobs database, print a summary,
delete done jobs, cancel uncompleted jobs, and clean old jobs.
It is possible to customize the output of bpdbjobs by adding column definition entries
(BPDBJOBS_COLDEFS) in the bp.conf file. For more information about the bp.conf file and
a complete list of the definitions and the BPDBJOBS_COLDEFS entries, refer to the
NetBackup System Administrator's Guide for UNIX and Linux, Volume II.
NetBackup System Administrator's Guide for UNIX and Linux, Volume II.
80
bpdbjobs
OPTIONS
-all_columns
Summary displays all columns. Some of the more useful fields of this
command are:
field2 = jobtype (0=backup, 1=archive, 2=restore, 3=verify, 4=duplication, 5=import,
6=dbbackup, 7=vault, 8=label, 9=erase, 10=tpreq, 11=tpclean, 12=tpformat, 13=vmphyinv, 14=dqts, 15=dbrecover, 16=mcontents)
field3 = state (0=queued, 1=active, 2=waiting for retry, 3=done)
field5 = policy
(The policy that this job is associated with.)
field6 = schedule (The schedule that this job is associated with.)
field21 = subtype (0=immediate, 1=scheduled, 2=user-initiated)
field24 = priority
(The priority 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:
jobid,jobtype,state,status,class,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,fileslastwritten,filelistcount,[files]..., trycount,[trypid,trystunit,tryserver,trystarted,tryelapsed, tryended,trystatus,trystatusdescription,trystatuscount, [trystatuslines]...,trybyteswritten,tryfileswritten]...
Refer to Example 1 for an example on how to interpret the -all_colums
output.
-append
Appends the output to the file specified by the -file option. If no
-file option is provided, the output goes to stdout.
-cancel job1,job2,...jobn |type=jobtype|type=all
Causes bpdbjobs to cleanly cancel active jobs with a Status 150, displayed in the Activity Monitor. For example:
bpdbjobs -cancel 11328
bpdbjobs -cancel 11328,11329,11330
81
bpdbjobs
-cancel_all
Causes bpdbjobs to cleanly cancel all uncomplete jobs with a Status 150,
displayed in the Activity Monitor. For example:
bpdbjobs -cancel_all
-clean
Causes bpdbjobs to delete done 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
Causes completed jobs that are displayed in the Activity Monitor to be
deleted. Multiple jobids can be deleted in one command. For example:
bpdbjobs -delete 11328 bpdbjobs -delete 11328,11329,11330
Or, delete jobs specified by job1,job2,...jobn, or all eligible jobs indicated
by jobtype, or all eligible jobs if type=all is specified.
Enter one of the following as jobtype. (The letters following the
capitalized letters are ignored):
ALL | *
REStore
BACkup
ARChive
VERify
DUPlicate
IMPort
LABel
ERAse
VAUlt
TPReq
CLEan
FORmat
INVentory
QUAlification
DBbackup | CATalogbackup
-file pathname
Names a file to which the output of bpdbjobs will be written. If no
-file option is provided, the output goes to stdout.
82
bpdbjobs
-gdm
Displays less information than -most_columns.
-help
the command line.
-jobid job1,job2,...jobn |type=jobtype|type=all
This option reports on multiple job ID’s.
-keep_days days
Use with the -clean option to specify how many days bpdbjobs keeps
done jobs. Default is 3 days.
-keep_hours hours
Use with the -clean option to specify how many hours bpdbjobs
keeps done jobs. Default is 72 hours.
-keep_successful_days days
Use with the -clean option to specify how many days bpdbjobs keeps
successful done jobs. Default is 3 days.
This value must be less than the -keep_days value.
-keep_successful_hours hours
Use with the -clean option to specify how many hours bpdbjobs
keeps successful done jobs. Default is 72 hours.
This value must be less than the -keep_hours value.
-L
Report in long format.
-lvault
Displays additional columns specific to Vault jobs.
-M master_servers
Applies to an environment where there are multiple masters servers. Use the -M option to:
Summarize jobs for a specific master server. Delete jobid(s) for a specific master server. Cancel jobid(s) for a specific master server.
Cancel all active jobids for a specific master server.
-mastertime
By default, bpdbjobs translates the start/end times to be relative to the
local clock so a job that starts 3 minutes ago looks like it starts 3 minutes
ago regardless of any time zone and clock differences with the master
server. This option circumvents that translation so time values are
consistent between admin clients.
83
bpdbjobs
-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
This option prevents the header from being printed.
-quiet
Use this option when you do not want to report the number of jobs
resumed/suspended/deleted/canceled.
-report
Provides a report of data 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
Allows bpdbjobs to cleanly restart a job indicated by the jobtype. This
command 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 specified by job1,job2,...jobn, all eligible checkpointed
backups or restore jobs indicated by jobtype, or all eligible jobs if
type=all is specified.
ALL | *
REStore
BACkup
ARChive
VERify
DUPlicate
IMPort
LABel
ERAse
VAUlt
TPReq
CLEan
FORmat
INVentory
QUAlification
84
bpdbjobs
-summary [-U | -L | -all_columns]
Causes a summary line to be printed to stdout of all jobs 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/filename. For
example:
bpdbjobs -summary -U -file /tmp/summary.out
-suspend job1,job2,...jobn |type=jobtype|type=all
Suspends the jobs specified by job1,job2,...jobn, or all eligible
checkpointed backups or restore jobs indicated by jobtype, or all eligible
jobs if type=all is specified.
ALL | *
REStore
BACkup
ARChive
VERify
DUPlicate
IMPort
LABel
ERAse
VAUlt
TPReq
CLEan
FORmat
INVentory
QUAlification
-U
Report in user format. This is the report format used by NetBackup
report-generating tools such as the NetBackup-Java Reports application.
-vault
Displays 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:
install_path\NetBackup\logs\bpdbjobs\*
85
bpdbjobs
-version
Causes bpdbjobs to print the version string, then halt. Any other
switches are ignored.
EXAMPLES
Example 1
The following is a sample of the logic that you can use to decode the output of the -all_columns option to produce the backup initiation time of a successful backup job that succeeded, but not on the first try.
Field 9 = start time
(The time the job was first queued.)
This time is virtually worthless, 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 there are in
the filelist fields.
Field 32 = filelistcount
(The number of files that are listed in the filelist.)
Then, if you add that value to 33, you'll get the field that shows you the number of tries.
Field 33 + filelistcount = trycount (The number of tries that have occurred.)
If there's only one try, and you want its start-time, then add 33, filelistcount + 4, and
you've got the field that shows you the start-time of the first try:
Field 33 + filelistcount + 4 = [first]trystarted
(The start time of the first try.)
But, if there were _two_ tries, then you have go past the status entries. First, you need the number of entries in the status field. To get that number, add 9 to 33 and the filelistcount:
Field 33 + filelistcount + 9 = trystatuscount
(The number of status entries in the first try.)
Then, to get the start-time of the second try, add 33, filelistcount, 9, trystatuscount, and 6:
Field 33 + filelistcount + 9 + trystatuscount+6 = [second]trystarted (The start time of the second try)
FILES
install_path\NetBackup\logs\bpdbjobs\*
86
bpdown
bpdown
NAME
bpdown - Shuts down the NetBackup services on Windows systems.
SYNOPSIS
install_path\NetBackup\bin\bpdown [-h] [-S|v] [-f] [-a] [-c] [-d] [-m] [-n] [-s] [-r]
DESCRIPTION
The bpdown command is used to shut 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.
OPTIONS
-h
This option displays the help screen.
-S
This option selects the silent mode. No listing is generated and no
confirmation is requested.
-v
Using the selected verbose mode generates a detailed listing.
-f
This option forces a shutdown of the NetBackup services without
prompting the user for a confirmation.
-c
This option shuts down the client.
-d
This option shuts down the NetBackup database.
-m
This option shuts down Media Manager.
-n
This option shuts down the NetBackup server and not the client.
-s
This option shuts down the server (NetBackup and Media Manager).
-r
This option shuts down the robotic control daemons.
87
bpdown
SEE ALSO
bpup
88
bpduplicate
bpduplicate
NAME
bpduplicate - Create a copy of backups created by NetBackup.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpduplicate -npc
new_primary_copy -backupid backup_id [-local] [-client
name]
install_path\NetBackup\bin\admincmd\bpduplicate [-number_copies
number] [-dstunit
destination_storage_unit_label[,copy2,...,copyn] [-dp
destination_pool_name[,copy2,...,copyn] [-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,...,rl-copyn]] [-fail_on_error
0|1[,...,0|1]] [-mpx] [-priority number] [-set_primary
copy_index]
DESCRIPTION
The bpduplicate command allows a copy of a backup to be created. The bpduplicate
command can also change the primary copy in order 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.
89
bpduplicate
OPTIONS
-altreadhost hostname
Specify an alternate host from which to read the media. The default 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.
-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 is ignored.
In addition, the file specified with the -Bidfile parameter is removed
during the execution of that command line interface (CLI). This happens
because the NetBackup GUI’s commonly use this parameter and 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 will
remove 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 specified with the -npc option in order to change the primary
copy, this indicates that NetBackup will first search for the backup ID
belonging to the specified client. This 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 indicates to bpduplicate to search or duplicate the primary
copy.
-dp destination_poolname [,copy2,...,copyn]
Specifies the volume pool for the duplicates. NetBackup does not verify
that the media ID 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 specified.
90
bpduplicate
-dstunit destination_storage_unit_label [,copy2,...,copyn]
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 specified.
-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 prior to the current date and
time.
-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 other copies
Specify one for each copy specified.
-hoursago hours
Specifies number of hours prior to 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.
-L output_file [-en]
-local
When bpduplicate is initiated from a host other than master server and
the -local option is not used (default), bpduplicate starts a remote
copy of the command on the master server.
91
bpduplicate
The remote copy allows the command to be terminated from the Activity
Monitor.
Use the -local option to prevent the creation of a remote copy on the master server and to run the 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: 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 NetBackup Server master 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.
-mpx
Specifies that when duplicating multiplexed backups, NetBackup will
create multiplexed backups on the destination media. This reduces the
time to duplicate multiplexed backups.
Multiplexed duplication is not supported for:
- Non-multiplexed backups
- Backups from disk type storage units
- Backups to disk type storage units
- FlashBackup or NDMP backups
If backups in the above categories are encountered during duplication,
NetBackup duplicates them first and uses non-multiplexed duplication.
Then, the multiplexed backups are duplicated by using multiplexed
duplication.
If all the backups in a multiplexed group are not duplicated, the
duplicated multiplexed group will have a different layout of fragments.
(A multiplexed group is a set of backups that were multiplexed together
during a single multiplexing session.)
If this option is not specified, all backups are duplicated using
non-multiplexed duplication.
For more information on multiplexing, see the NetBackup System
92
bpduplicate
-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 installed, the value can only
be set to 1. 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
-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 the backups are sorted and displayed by
date and time (newest to oldest).
-PM
Displays 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 why (for example,
because the backup already has two copies). It then 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 (0 or 1):
1 = Primary copy
0 = Not primary copy
-policy name
Search for backups to duplicate in the specified policy. The default is all
policies.
-priority number
Enables you to configure backup policies to run at a lesser or a higher
priority than disk staging duplication.
93
bpduplicate
-pt policy_type
Search for backups created by the specified policy type. The default is any policy type.
Valid values are:
Informix-On-BAR
Oracle
Macintosh
MS-Exchange-Server
MS-Windows
MS-SQL-Server
NDMP
Netware
OS/2
Standard
Sybase
AFS
DB2
FlashBackup
SAP
Split-Mirror
-rl retention_level[,rl-copy2,...,rl-copyn]
Provides a retention level for each copy specified.
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 November 14, 2003, and its
retention period is one week, the new copy’s expiration date is November 21, 2003. 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)
94
bpduplicate
1 = First new copy will be the primary copy
2 = Second new copy will be the primary copy
3 = Third new copy will be the primary copy, and so on.
copy_index cannot be greater than the bpduplicate -number_copies value.
If the copy specified to be the primary copy fails, but other copies are successful, the primary copy will not change from its current value.
-shost source_host
Specifies that only the backups 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 were created by the specified
schedule. The default is all schedules.
-st sched_type
Search for backups to duplicate that were created by the specified
schedule type. The default is any schedule type.
Valid values are:
FULL (full backup)
INCR (differential-incremental backup)
UBAK (user backup)
UARC (user archive)
-v
Selects verbose mode. When specified, the debug and progress logs
include more information.
NOTES
the output for the -s and -e options:
[-s mm/dd/yyyy HH:MM:SS] [-e mm/dd/yyyy HH:MM:SS]
locale setting of C and can be different for other locales.
95
bpduplicate
EXAMPLES
Example 1
The following command (all on one line) lists backups with a copy number of 1, that were
backed up by the policy named stdpolicy, and created between July 1, 2003, and August 1,
2003.
bpduplicate -PM -cn 1 -policy stdpolicy -s 07/01/01 -e 08/01/01
Example 2
The following command (all on one line, or using a backslash continuation character)
duplicates copy 1 of the backups listed in file C:\tmp\bidfile. The destination storage
unit is unit1 and the destination pool is dup_pool. Progress information is written to
C:\tmp\bpdup.ls.
bpduplicate -dstunit unit1 -Bidfile C:\tmp\bidfile
-L C:\tmp\bpdup.ls -dp dup_pool -cn 1
Example 3
The following command (all on one line, or using a backslash continuation character) is
the same as the prior example, except multiplexed backups are duplicated using
multiplexed duplication.
bpduplicate -dstunit unit1 -Bidfile C:\tmp\bidfile
-mpx -L C:\tmp\bpdup.ls -dp dup_pool -cn 1
FILES
install_path\NetBackup\db\images\*
96
bperror
bperror
NAME
bperror - Display NetBackup status and troubleshooting information or entries from the
NetBackup error catalog.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bperror {-S | -statuscode
status_code} [-r|-recommendation] [[-p Unx |
NTx]|[-platform Unx | NTx]] [-v]
install_path\NetBackup\bin\admincmd\bperror [-all | -problems
|-media | {-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]
install_path\NetBackup\bin\admincmd\bperror [-s
{severity[+]}|severity ...] [-t 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]
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/or 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
install_path\NetBackup\logs\admin directory. You can use the information in
this directory for troubleshooting.
The output of bperror goes to standard output.
97
bperror
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.
For -all: The type is ALL, and severity is ALL. Running bperror with
this option and -U produces an All Log Entries report.
For -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. Running bperror with this option and -U produces a Backup Status report.
For -media: The type is MEDIADEV, and severity is ALL. Running bperror with this option and -U produces a Media Logs report.
For -problems: The type is ALL, and severity is the union of
WARNING, ERROR, and CRITICAL. Running bperror with this option
and -U produces 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 attempt 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 and end date range for the listing.
98
bperror
-d specifies a start date and time for the listing. The resulting list shows
only images in back ups or archives that occurred at or after the specified
date and time. The format of date depends on the user's locale setting.
See the NOTES section for more information. For the C locale, the date
syntax is as follows:
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.
The method you use to specify the date and time is dependent on the
locale setting for your system. See NOTES.
-e specifies an end date and time for the listing. The resulting list shows
only files from backups or 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 end date must be greater than or
equal to the start date.
-help
the command line.
-hoursago hours
Specifies a start time of this many hours ago. This is equivalent to
specifying a start time (-d) of the current time minus hours. Hours is an
integer. The default is 24, meaning 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.
-L
Report in long format.
-l
Report in short format. This produces a terse listing. This option is useful
for scripts or programs that rework the listing contents into a customized
report format. This is the default list type.
-M master_server
in this list. The master servers must allow access by the system issuing the
command. If an error occurs for any master server, processing stops at
that point in the list. The default is the master server for the system
99
bperror
-p Unx | NTx
-platform Unx | NTx
Display 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 using this option.
-r | -recommendation
Display the recommended action for the specified status code from the
troubleshooting guide. The default is not to display the recommended
action. The -S or -statuscode option must be specified when using
this option.
-S status_code
-statuscode status_code
Display the message that corresponds to the status code. There is no
default for this option.
-s severity
-s severity+
Specifies the severity of log messages to display. The defined values are
ALL, DEBUG, INFO, WARNING, ERROR, and CRITICAL.
There are two ways to specify severity. 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
between the elements in the list must be a blank (" "). The second way is a
single severity value with "+" appended, meaning 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 either upper or lower
case.
-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 messages
logged for this server, which also satisfy the other criteria specified by
bperror options. For instance, if -server plim and -hoursago 2 are
bperror options, the display contains messages logged for the media
server plim in the past two hours.
The server name must match the server name recorded in the log
messages. For instance, if the logs record the server name as
plim.null.null.com, specifying -server plim will not display the
logs, but -server plim.null.null.com will.
100
bperror
The query goes to the error catalog residing on the master server (either
the local master server or the master server specified by -M). The master
server must allow access by the system running bperror.
The default is to display log messages for all media servers 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 in either upper or
lower case. The type value 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 elements
in the list must be a blank (" ").
-U
Report in user format. This is the report format used by NetBackup
report-generating tools such as the NetBackup-Java Reports application.
-v
Selects verbose mode. This option causes bperror to log additional
NetBackup-administration daily debug log. This option is meaningful
(install_path\NetBackup\logs\admin directory defined). The
default is not to be verbose.
DISPLAY FORMATS
◆
Status code display (for example, bperror -S status_code):
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 or -recommendation 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 returned from
querying the error catalog on the master server(s). The results are limited to catalog
entries that satisfy all the bperror options. For instance, if the bperror command
line contains options for client, start time, and end time, then bperror reports only
the jobs run for that client between the start and end times. For the display variant
that shows individual message entries from the error catalog, the display can appear
101
bperror
in long (-L), user (-U), or short (-l) format. For the display variant that categorizes by
status code, the display can appear in user (-U) format only. The display content for
each of these formats is as follows:
◆ 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 multi-streaming is enabled for a policy, the job
group ID is the job ID of the first job that spawned a collection of multi-streaming
backups; if multi-streaming 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 (beginning of the log message text, continued on succeeding lines if
necessary)
◆ Error catalog display, individual message entries, user format (for example., bperror
-media -U). The user format produces a header line showing column names, and
then one or more lines per log entry, with the following contents:
Line 1: Date and time
Server
Client
Text (beginning of the log message text, continued on succeeding lines if necessary)
◆ 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
102
bperror
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 categorized by status code. 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 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 succeeding lines if
necessary)
Line 2: The list of clients for which this status occurred.
NOTES
the part of the bperror usage output:
USAGE: bperror ...
[-d mm/dd/yyyy hh:mm:ss|-hoursago hours]
[-e mm/dd/yyyy hh:mm:ss] [-client client_name] ...
Notice the month/day/year and hours:minutes:seconds requirements for the -d and -e
options. These are for a locale setting of C and can be different for other locales.
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 recommended for NetBackup status code 9.
bperror -d 12/23/2003 16:00:00 -e 12/23/2003 17:00:00 -t backstat -U
STATUS
CLIENT
POLICY
SCHED
SERVER
TIME COMPLETED 9
plim
dhcrypt
user
plim
12/23/2003 16:38:09
(an extension package is needed, but was not installed)
103
bperror
bperror -S 9 -r
an extension package is needed but was not installed
A NetBackup extension product is required in order to perform the requested operation.
Install the required extension product.
Example 2
Here bperror reports, in User format, the problems that have occurred in the previous 24
hours.
bperror -U -problems
TIME
SERVER CLIENT - TEXT
11/23/2003 16:07:39 raisins - no storage units configured
11/23/2003 16:07:39 raisins - scheduler exiting - failed reading storage unit database information (217)
11/23/2003 16:17:38 raisins -
no storage units configured
11/23/2003 16:17:38 raisins - scheduler exiting - failed reading storage unit database information (217)
11/23/2003 16:26:17 raisins is currently disabled
WARNING:
NetBackup database backup 11/23/2003 18:11:03 raisins nut bpcd on nut exited with status 59: access to the client was not allowed
11/23/2003 18:11:20 raisins is currently disabled
WARNING:
NetBackup database backup Example 3
The following example displays status for type backstat for jobs run in the previous 24
hours. The option -by_statcode produces a display organized by status code.
The display shows that one or more jobs for each of the clients chive, gava, plim, and
raisins completed successfully (the status code is 0). In addition, one or more jobs for
client nut failed because nut did not allow access by the master or media server (the status
code is 59).
bperror -U -backstat -by_statcode
0
the requested operation was successfully completed
chive gava plim raisins
59
access to the client was not allowed nut
104
bperror
Example 4
The following 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 2002 -L | grep 'S:' | egrep 'J\:[1-9]'
12/21/2003 17:24:14 V1 S:plim C:plim J:1 (U:0,0)
12/23/2003 16:31:04 V1 S:plim C:plim J:1 (U:0,0)
12/23/2003 16:31:06 V1 S:plim C:plim J:1 (U:0,0)
12/23/2003 16:38:04 V1 S:plim C:plim J:3 (U:0,0)
12/23/2003 16:38:07 V1 S:plim C:plim J:3 (U:0,0)
12/23/2003 16:38:08 V1 S:plim C:plim J:3 (U:0,0)
12/23/2003 16:38:09 V1 S:plim C:plim J:3 (U:0,0)
01/07/2002 13:12:31 V1 S:plim C:plim J:34 (U:0,0)
01/07/2002 13:12:36 V1 S:plim C:plim J:34 (U:0,0)
01/07/2002 13:12:40 V1 S:plim C:plim J:34 (U:0,0)
01/07/2002 13:12:41 V1 S:plim C:plim J:34 (U:0,0)
bperror -d 1/7/2002 -jobid 34 -U
TIME
01/07/2002 13:12:31 plim plim started backup job for client plim, policy jdhcrypt, schedule user on storage unit jdhcrypt
01/07/2002 13:12:36 plim plim begin writing backup id plim_0947272350, copy 1,fragment 1
01/07/2002 13:12:40 plim plim successfully wrote backup id plim_0947272350,copy 1, fragment 1, 32 Kbytes at 11.057 Kbytes/sec
01/07/2002 13:12:41 plim plim CLIENT plim POLICY jdhcrypt
SCHED user EXIT STATUS 0 (the requested operation was successfully completed)
Example 5
The following example shows the media entries in the error catalog for the past 2000
hours.
105
bperror
bperror -hoursago 2000 -media -U
TTIME
12/23/2003 16:31:04 plim plim Media Manager terminated during mount of media id A00000, possible media mount timeout
12/24/2003 04:31:20 plim - media id A00000 removed from Media Manager database (manual deassign)
Example 6
The following example tallies and reports 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
bperror -all -hoursago 24 | grep "successfully wrote backup id" | grep fragment | awk '{bytes+=$20} END {printf "backed up fragmented", bytes }'
bperror -all -hoursago 24 | grep "successfully wrote backup id" | grep -v fragment | awk '{bytes+=$18} END {printf "backed up unfragmented", bytes}'
Example 7
The following example reports the performance, in Kbytes per second, for each of today's
backups:
bperror -all | grep Kbytes
0912013673 1 4 4 hatt 0 0 0 hatt bptm successfully wrote backup id hat_0912013584, copy 1, fragment 1, 32256 Kbytes at 891.222 Kbytes/sec
106
bperror
Example 8
Here bperror displays the status message and the recommended action for status code 0:
bperror -S 0 -r
the requested operation was successfully completed
There were no problems detected with the requested operation.
None, unless this was a database backup performed through a database extension product (for example, NetBackup for Oracle or NetBackup for SQL Server). In those instances, code 0 means the backup script that started the backup ran without error. However, you must check other status as explained in the related NetBackup manual to see if the database was successfully backed up.
FILES
install_path\NetBackup\db\error\log files
install_path\NetBackup\bin\NbwTroub.dll install_path\NetBackup\msg\.conf
107
bpexpdate
bpexpdate
NAME
bpexpdate - Change the expiration date of backups in the image catalog and media in
the media catalog.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpexpdate -m media_id -d date
[-host name] [-force] [-M master_server[,...,]]
install_path\NetBackup\bin\admincmd\bpexpdate -deassignempty
[-m media_id] [-host name] [-force] [-M
master_server[,...,]]
install_path\NetBackup\bin\admincmd\bpexpdate -backupid
backup_id -d date |0|infinity [-client name] [-copy
number] [-force] [-M master_server[,...,]]
install_path\NetBackup\bin\admincmd\bpexpdate -recalculate
[-backupid backup_id] [-copy number] -d date |0|infinity]
[-client name] [-policy name] [-ret retention_level]
[-sched type] [-M master_server[,...,]]
DESCRIPTION
NetBackup maintains internal databases with backup image and media information.
These internal databases are called catalogs. Both an image record in the image catalog
and a media ID in the media catalog contain an expiration date. The expiration date is the
date and time when NetBackup removes the record for a backup or 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. It 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 deassigned in the Enterprise
Media Manager Database, regardless of the media's prior state (FROZEN, SUSPENDED,
and so on).
Changing the expiration can be done on a media ID basis or on an individual backup ID
basis. Changing the expiration date of a media ID also causes the expiration date of all
backups on the media to be changed. bpexpdate also provides options to deassign
media from the media catalog if they no longer contain valid backups and to recalculate
the expiration date based on the configured or a supplied retention level.
The different formats of the command are described below.
108
bpexpdate
◆
-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 the media ID is removed
from the media catalog by specifying a zero date, the media ID is also deassigned in
the Enterprise Media Manager Database.
◆
-deassignempty
Searches the catalog for removable media that no longer contain valid backups,
removes it from the media catalog, and deassigns the media IDs in the Media
Manager catalog. The media is then available to be used again. You can use the
NetBackup Images on Media report to determine if there are assigned media that no
longer contain valid backups.
◆
-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 expiration date
given by the -d option is greater than the current expiration of the media ID, the
expiration date of the media ID in the media catalog is also changed. 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.
◆
-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 is changed
according to retention level, the new date is calculated based on the creation date of
the backup plus the value of the retention level. The expiration can be changed for a
single backup, or for all backups for a particular client, policy, or schedule type.
If the backup is on removable media, the expiration date of the media ID in the media
catalog is changed, providing the expiration date on this command is greater than the
current expiration of the media ID.
OPTIONS
-client name
Specifies the client name for the -backupid and -recalculate
operations.
109
bpexpdate
For the backupid operation, this option causes NetBackup to first search
for the backup ID for the specified client, which is useful if the client
name has changed.
For the recalculate operation, this option causes NetBackup to
recalculate the expiration date 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
or
0
or
infinity
If 0 is specified, the backup or media is expired immediately. If
infinity is specified the backup is never expired.
-deassignempty
Expires removable media from the media catalog when that media no
longer contains valid backups and also deassigns the media ID in the
Media Manager catalog.
-force
Prior to running the specified operation, bpexpdate queries before
starting the operation. This option forces bpexpdate to carry out the
operation without querying the user.
-host name
Note For NetBackup Server this option is not required because there is only one server
(the master), so if you do use the option specify the host name of that server.
Specifies the host name of the server where the media catalog resides.
This option is required only if the master has remote media servers and
the volume was not written on the server where you run the bpexpdate
110
bpexpdate
command. In this case, the media ID is in the NetBackup media catalog
on the server where the media was written and you must specify the
name of that server on the bpexpdate command.
For example, assume you have a master server named whale and a media
server named eel. You run the following bpexpdate command on whale
in order to manually remove media ID BU0001 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 is affected by the expiration date change. The
expiration dates of the backups on the media ID are also changed. 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 less characters and must be in the
NetBackup media catalog.
-M master_server,...,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.
If the command is run on a media server that is not the master, then the
master for that media server is the default.
-policy name
Specifies the policy name and is valid with the -recalculate option.
When specified, the expiration is recalculated based on the retention level
for all backups created in this policy.
111
bpexpdate
-recalculate
Recalculates the expiration of backups based on the retention level or you
can specify a new expiration date. Other options can be included in order
to change the expiration for a single backup, or for 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 recalculating expiration dates
and is valid with the -recalculate option. Levels range from 0 to 24.
The new expiration date is determined by adding the configured
retention level value to the backup's creation date. Either the -backupid
or -policy option must be specified with this option.
-sched type
Specifies the schedule type and is valid with the -recalculate option.
When specified, the expiration is recalculated based on the retention level
for all backups 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
the output for the -d option:
-d <mm/dd/yyyy HH:MM:SS | 0 | infinity>
locale setting of C and can be different for other locales. See the locale(1) man page for
detailed information.
Some options in large environments can take a significant amount of time to complete.
Changes that cause backups or media to expire are irrevocable; importing backups and
(or) recovering previous versions of the catalogs can be required if mistakes are made
using this command.
112
bpexpdate
EXAMPLES
Example 1
The following command, run on the master server, removes media ID BU0002 from the
media catalog, and 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.
The expiration of copy 1 of the backup is not affected.
bpexpdate -backupid eel_0904219764 -d 12/20/2003 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
The following command checks for all media in host cat's media catalog that are still
assigned but no longer contain valid backups. If any such media are found, the command
removes them from the media catalog and deassigns them in the Media Manager catalog.
bpexpdate -deassignempty -host cat
FILES
install_path\NetBackup\db\media\*
113
bpfis
bpfis
NAME
bpfis - creates or deletes a snapshot, or returns information about existing snapshots.
SYNOPSIS
install_path\bin\bpfis create [-rhost host] [-id id] [-v] [-V] [-owner owner] [-help] -fim fim_name[:option=value,option=value, ...] file1 [file2
...]
install_path\bin\bpfis delete [-force] -id id
install_path\bin\bpfis query [-id id]
DESCRIPTION
The bpfis command can create, delete, or query snapshots of a client system (filesystem
or volume).
Note To store the image on tape or other media requires running a separate backup job.
For more detailed examples and procedures for using bpfis, refer to the NetBackup
Advanced Client System Administrator’s Guide.
You must have root privileges to execute this command.
OPTION
-rhost
The remote host or alternate client on which the snapshot is made
accessible. The default is the local host. -rhost can be used with the
FlashSnap, method only.
-id
For bpfis create, this is a user-defined snapshot identifier. The default id is
a time stamp showing when the image was created.
For bpfis delete, this designates the ID of the snapshot to be deleted. For bpfis query, this is the ID of the snapshot for which to return information.
-v -V Indicates verbosity levels in the log files. -V is a higher level of verbosity
than -v. Default is non-verbose.
-owner
owner of this snapshot (default is GENERIC).
114
bpfis
-help
Displays bpfis usage statement.
-fim fim_name[:option=value,option=value, ...]
This is a required parameter. It specifies the snapshot method to use
when creating the image. Valid methods are: FlashSnap, NAS_Snapshot,
VSP, VSS, vxvm.
Select the method based on the type of data and hardware used by the
client. Refer to the NetBackup Advanced Client System Administrator’s Guide
for details on each of these snapshot methods.
The available options depend on the snapshot method. For a list of the
options, refer to the <opt_params> area of each snapshot method (FIM)
listed in the install path\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
where keep_fi= is the option, and the value is boolean (0 for no, 1 for
yes). For an example of the bpfis command using option=value, refer to
bpfis in the NetBackup Advanced Client System Administrator’s Guide.
file1 file2
Specify the path of the filesystem or volume from which the snapshot is
to be made.
-force
Specifies force delete.
EXAMPLES
◆
Example 1
To create a snapshot of E:\ on hostB 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> OPTIONS:ALT_PATH_PREFIX=/tmp/_vrts_frzn_img_26808,FITYPE=MIRROR
,MNTPOINT=E:\,FSTYPE=NTFS
INF - EXIT STATUS 0: the requested operation was successfully completed
Example 2
115
bpfis
To obtain information about a particular snapshot on the local host:
install_path\bin\bpfis query -id 1034037338
Sample output (on a Windows client):
INF - Frozen image host : ricochet
INF - Frozen image owner: GENERIC
INF - Time created
: Mon Oct
7 19:35:38 2002
INF - REMAP FILE BACKUP E:\ USING <GUID> OPTIONS:ALT_PATH_PREFIX=/tmp/_vrts_frzn_img_26808,FITYPE=MIRROR
,MNTPOINT=E:\,FSTYPE=NTFS
Example 3
To delete a snapshot on the local host:
install_path\bin\bpfis delete -id 1034037338
Sample output:
116
bpgetconfig
bpgetconfig
NAME
bpgetconfig - A helper program for backuptrace and restoretrace to obtain
configuration information.
SYNOPSIS
install_path\bin\admincmd\bpgetconfig -M master [-x|X] [config_item ...] install_path\bin\admincmd\bpgetconfig [-u|h] [-x|X]
[config_item ...]
install_path\bin\admincmd\bpgetconfig -g server [-L|U|l] install_path\bin\admincmd\bpgetconfig -s server [-L|U|l] install_path\bin\admincmd\bpgetconfig -H [config_item]
DESCRIPTION
The bpgetconfig command can be used as a standalone program or as a helper
program for the backuptrace and restoretrace commands to obtain configuration
information. This command is available for all NetBackup server platforms. This
command is used to display the configuration information of a specified server in various
formats.
OPTIONS
-M master
Specifies the master server (master) whose host configuration will be
displayed.
-h
Displays the default, local host configuration.
-u
Displays the current user configuration.
-x
Excludes items not explicitly listed in the 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.
117
bpgetconfig
”config_item” ...
If the config_item is specified, it displays on the specified
configuration items.
-g server
This option selects the host server (server) for which general Backup Exec and NetBackup information will be displayed. Currently:
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 installed)
Installed OS for host server
-s server
This option selects the host server (server) for which general NetBackup
specific system information will be displayed. Currently:
Master or Client
NetBackup Client Platform
NetBackup Client Protocol Level
Product Type (NetBackup)
Version Name
Version Number
Installed Path for NetBackup Bin
Installed OS for host server
-L
Displays a long user readable listing.
-U
Displays a brief user readable listing (default).
-l
Displays a compact machine readable listing. The -L, -U, and -l options
may be used with the -g or -s option.
-H
Displays the help screen.
-H config_item
Displays the vaild configuration items.
118
bpgetdebuglog
bpgetdebuglog
NAME
bpgetdebuglog - helper program for backuptrace and restoretrace. It can also be useful as
a standalone program. It is available for all NetBackup server platforms.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpgetdebuglogremote_machine [remote_program mmddyy]
DESCRIPTION
If all three arguments are specified, bpgetdebuglog will print to standard output the
contents of the specified debug log file. If only the remote_machine is specified,
bpgetdebuglog will print 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.
bpgetdebuglog must be in the install_path\NetBackup\bin\admincmd directory
in order to be used by backuptrace and restoretrace.
You must have privileges to execute 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 used to identify the log file (log.mmddyy for UNIX,
mmddyy.log for Windows) to be read.
EXAMPLES
C:\Program Files\VERITAS\NetBackup\bin\admincmd\bpgetdebuglog peony
119
bpimage
bpimage
NAME
bpimage - Enables users to perform different functions to stored images in a database.
SYNOPSIS
install_path\NetBackup\bin\bpimage -[de]compress [-allclients | -client name] install_path\NetBackup\bin\bpimage [-M
master_server,...,master_server]
install_path\NetBackup\bin\bpimage -npc copy # -backupid backupid [-client name]
install_path\NetBackup\bin\bpimage -newserver newserver_name [-oldserver oldserver_name] [-id id]
install_path\NetBackup\bin\bpimage -deletecopy # -backupid backupid
install_path\NetBackup\bin\bpimage -testlock # -backupid backupid
install_path\NetBackup\bin\bpimage -prunetir [-allclients | -client name] -cleanup
install_path\NetBackup\bin\bpimage -create_image_list -client name
install_path\NetBackup\bin\bpimage -index index_number -client name
install_path\NetBackup\bin\bpimage -wff path_bytes -backupid backupid [-client name]
install_path\NetBackup\bin\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 backup_id]
DESCRIPTION
This command can be use to do many different functions to images stored in a database.
Some of the functions that a user can use bpimage to perform are:
120
◆
Compress and de-compress stored images
◆
Remove existing images from the database
bpimage
◆
Test the locking capability on an image
◆
Create an image list file that can be used to qualify an image
◆
Index a client.
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 this is a media report.
-allclients Specifies the selection of all NetBackup clients that have already been
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
This command deletes expired images, compresses the images that are
scheduled to be compressed, and prunes the TIR information from the
images specified.
Note: This command enables a user to manually accomplish the same
tasks that are performed by the scheduler on a regular basis. It can be
used when there is not 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
-d specifies a start date and time for the listing. The resulting list shows only images in backups or archives that occurred at or after the specified
date and time. The format of date depends on the user's locale setting. See the NOTES section for more information. For the C locale, the date syntax is as follows:
03:14:07. The default is the previous midnight.
121
bpimage
-[de]compress
This command initiates an action to compress or de-compress a specified
client, or all clients.
-deletecopy #
This command removes images that are specified by the copy number (#)
and the backup_id.
-filesysonly 0|1
Depending on the setting, this option limits bpimage to querying only
the local file system.
-id backup_id
Specifies the backup ID when using the update command.
-index n
This command 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 applies only to ASCII.
-keyword "keyword_phrase"
Specifies a keyword phrase for NetBackup to use when searching. The
phrase must match the one that has been previously associated with the
image.
-objdesc string
This command specifies the object description string of the Informix
client type when using the -update command.
-newserver name | -oldserver name
Specifies the name (new or old) of a NetBackup server.
-npc copy #
This command sets the specified image as the primary image based on
the copy number of the image.
-numfiles number
Specifies the number of files when using the -update command.
A list of alternative master servers. This 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, processing
stops at that point.
The report is the composite of the information returned by all the master
servers in this list. bpimage 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 issuing the
bpimage command.
122
bpimage
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
This command 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 using 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
AFS
DB2
FlashBackup
SAP
Split-Mirror
-update
This command updates an image based on the chosen parameter.
123
bpimage
-wff path bytes
This command writer the specified Files file.
124
bpimagelist
bpimagelist
NAME
bpimagelist - Queries the NetBackup catalog and produces a report on the status of the
NetBackup images.
SYNOPSIS
install_path\NetBackup\bin\bpimagelist -l | -L | -U | -idonly [-d
date | -hoursago hours] [-e date] [-keyword "keyword
phrase"] [-client client_name] [-backupid backup_id]
[-option option_name] [-policy policy_name] [-pt
policy_type] [-rl retention_level] [-sl sched_label] [-st
sched_type] [-M master_server[,...,]] [-v]
install_path\NetBackup\bin\bpimagelist [-media] [-l | -L | -U |
-idonly] [-d date | -hoursago hours] [-e date] [-server
server_name] [-keyword "keyword phrase"] [-client
client_name] [-option option_name] [-policy policy_name]
[-pt policy_type] [-rl retention_level] [-sl sched_label] [-st
sched_type] [-M master_server[,...,]] [-v]
DESCRIPTION
bpimagelist uses a specified format to report the images that match the attributes that
are sent from the commands options. bpimagelist lists NetBackup catalog image
information. The bpimagelist command writes its debug log information to the
install_path\NetBackup\logs\admin directory. You can use the information in this
directory for troubleshooting.
The output of bpimagelist goes to standard output.
NetBackup authorization, refer to the NetBackup System Administrator's Guide.
OPTIONS
Report-type options
-media Specifies that the listing reports on removable media satisfying a set of
criteria. If -media is not present, the report is on images, not media,
satisfying a set of criteria.
Report-format options:
125
bpimagelist
-U Report in User mode. The report is formatted, it includes a banner listing
the column titles, and the status is a descriptive term instead of a number.
-L 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, and the density value is provided as both a descriptive term and a
number.
-l Report in Short mode. This produces a terse listing. This option is useful
report format.
-idonly Produce an abbreviated listing. For an image listing, the listing contains
the creation time, backup ID, and schedule type of each image. For
instance, if the listing criterion is a window of time image listing contains,
for each image created in this window, only the creation time, backup ID,
and schedule type of the image.
For a media listing, the listing contains only the applicable media IDs.
For instance, if the listing criterion is a window of time, the listing
contains only the media IDs 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 this is a media report.
-hoursago hours
Include images written up to this many hours ago. This is equivalent to
specifying a start time (-d) of the current time minus hours. hours must
be 1 or greater.
-option option_name
Specifies a criterion for finding images to list. option_name is one of the
following character strings, in either upper-or lower-case:
INCLUDE_PRE_IMPORT - Include images that have completed phase one
of an import. Refer to the bpimport command description or the
NetBackup System Administrator’s Guide for more information.
ONLY_PRE_IMPORT - Include only images that have completed phase
one of an import.
INCLUDE_TIR - Include images that were created by
true-image-recovery backups. Refer to the bpcpinfo command
description or the NetBackup System Administrator’s Guide for more
information on this topic.
126
bpimagelist
ONLY_TIR - Include only images that were created by true-image-recovery backups.
The default is that there are no restrictions on the images selected.
-backupid backup_id
Specifies a backup ID to use for finding applicable images (applies only to
image listing).
-client client_name
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. This option applies to
the media report (-media). If -server specifies a server name, the
media in the report are only the media which reside on that server and
which also satisfy the other criteria specified by bpimagelist. For
instance, if -hoursago 2 is specified, the media must contain an image
created in the past two hours.
The query goes to the image catalog residing on the local master server.
The master server must allow access by the system running
bpimagelist.
The default is to report all media in the image catalog on the local master
server. This is equivalent to specifying -server ALL.
bpimagelist command. If an error occurs for any master server,
processing stops at that point.
servers in this list. 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 issuing 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-Windows
127
bpimagelist
NetWare
Oracle
OS/2
Standard
Sybase
NDMP
AFS
DB2
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
-d specifies a start date and time for the listing. The resulting list shows only images in backups or archives that occurred at or after the specified
date and time. The format of date depends on the user's locale setting. See the NOTES section for more information. For the C locale, the date syntax is as follows:
03:14:07. The default is the previous midnight. -e specifies an end date and time for the listing.
The resulting list shows only files from backups or 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.
Specifies a keyword phrase for NetBackup to use when searching. The
phrase must match the one that has been previously associated with the
image. For instance, the -k option of the bpbackup or bparchive
command associates a keyword with the image when the image is
created.
128
bpimagelist
-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:
FULL (full backup)
UBAK (user backup)
UARC (user archive)
-policy name
Searches for backups to import in the specified policy. The default is all
policies.
Other options:
-help Prints a command line usage message when it is the only option on the
command line.
-v
Selects 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 NetBackup has debug logging enabled
(install_path\NetBackup\logs\admin directory defined).
EXAMPLES
Example 1
The first example shows the last time each media ID available to a server had a backup
image written today:
bpimagelist -media -U
Media ID
-------IBM000
AEK800
C0015
Last Written
Server
----------------------
01/06/2003 01:06
hatt
01/06/2003 03:01
hatt
01/06/2003 02:01
hatt
Example 2
129
bpimagelist
The following example shows the last time the media IDs available to the server had a
backup image written during the specified time:
bpimagelist -media -d 01/05/2003 18:00:46 -e 01/06/2003 23:59:59 -U
Media ID
-------IBM000
AEK800
C0015
143191
Last Written
Server
----------------------01/06/2003 01:06
hatt
01/06/2003 03:01
hatt
01/06/2003 02:01
hatt
01/05/2003 23:00
hatt
The following example lists all images written today:
C:\VERITAS\NetBackup\bin\admincmd\bpimagelist -U
Backed Up
Expires
Files
KB C Sched Type Policy
-------------- -------- -------- -------- - ----------------------01/27/2003 01:08 02/03/2003
1122
202624 N Full Backup
3590Grau
01/27/2003 01:01 02/03/2003
1122
IBM3590policy
01/27/2003 03:01 02/03/2003
531 1055104 N Full Backup
DELLpolicy
01/27/2003 02:01 02/03/2003
961
31776 N Full Backup
QUALpolicy
01/27/2003 01:08 02/03/2003
2063
IBM3590policy
01/27/2003 01:01 02/03/2003
2063
3590Grau
Example 3
The following example lists media written information for 01/05/2003:
bpimagelist -media -d 01/05/2003 -e 01/05/2003 -U
Media ID
Last Written
Server
-----------------------------IBM000
01/05/2003 01:13
hatt
143191
01/05/2003 23:00
hatt
AEK800
01/05/2003 03:07
hatt
C0015
01/05/2003 02:06
hatt
FILES
install_path\NetBackup\db\images
130
bpimagelist
SEE ALSO
bparchive, bpbackup, bprestore
131
bpimmedia
bpimmedia
NAME
bpimmedia - Display information about the NetBackup images on media.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpimmedia [-l | -L]
[-policy policy_name] [-client client_name] [-d date] [-e
date] [-mediaid media_id | path_name] [-mtype image_type]
[-option option_name] [-rl retlevel] [-sl sched_label] [-t
sched_type] [-verbose] [-M master_server,...]
install_path\NetBackup\bin\admincmd\bpimmedia -spangroups
[-mediaid media_id] [-U] [-cn copy_number]
DESCRIPTION
bpimmedia queries the NetBackup image catalog and reports on the NetBackup images.
bpimmedia produces two reports:
◆
An Images-on-Media report
◆
A Spangroups report
The first form of bpimmedia in the SYNOPSIS displays a set of NetBackup images in the
Images-on-Media report. The Images-on-Media report lists the contents of media as
recorded in the NetBackup image catalog. You can generate this report for any medium
(including disk), filtering the report contents according to client, media ID or path, and so
on. Refer to the section on NetBackup Reports in the NetBackup System Administrator’s
Guide for more information, including details about the fields in the Images on Media
report. The Images on Media report does not show information for media used in backups
of the NetBackup catalogs.
The second form of bpimmedia in the SYNOPSIS uses the -spangroups option to list
media id groups 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 spanning images.
The -spangroups form of bpimmedia must be run on the NetBackup master server that
administers the volumes. (See the Spanning Media topic in the NetBackup System
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.
132
bpimmedia
OPTIONS
-policy policy_name
Policy name. By default, bpimmedia searches for images for all policies.
-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 -spangroups.
-d date
-e date
The start and end date. These specify the time range during which an
image must have been created to be included in the report. -d specifies a start date and time. The resulting list shows only images from backups or archives that occurred at or after the specified date and time. The format of date depends on the user's locale setting. See the NOTES section for more information. For the C locale, the date syntax is as follows:
mm/dd/yyyy [hh[:mm[:ss]]]
03:14:07. The default is the previous midnight.
-e specifies an end date and time. The resulting list shows only images
from backups or 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.
-help
the command line.
-L
The list type is long. See the section DISPLAY FORMATS for more detail.
-l The list type is short. This is the default if the command line has no
list-type option (for instance, if you enter bpimmedia and a carriage
return). See the section DISPLAY FORMATS for more detail.
A list of alternative master servers. This 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
133
bpimmedia
system issuing the command. If an error occurs for any master server,
processing 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 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 filesystem for a disk storage unit.
When -mediaid is specified, the Images-on-Media report displays only
images stored on this VSN or pathname. By default, the report displays
images stored on all media IDs and pathnames.
For the Spangroups report (-spangroups), -mediaid can only be
followed by a VSN. If -mediaid is omitted when -spangroups is
present, bpimmedia displays all media in all spanning groups.
-mtype image_type
Image type. The defined values, and their interpretations, are
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 upper-or lower-case:
INCLUDE_PRE_IMPORT - Include images that have completed phase one of an import. Refer to the bpimport command description or the
NetBackup System Administrator’s Guide for more information.
ONLY_PRE_IMPORT - Include only images that have completed phase one of an import.
The default is INCLUDE_PRE_IMPORT.
-rl retention_level
The retention_level. The retention_level is an integer between 0 and 24.
By default, bpimmedia searches for all retention levels.
-sl sched_label
The schedule label. By default, bpimmedia searches for images for all
schedule labels.
-spangroups
Specifies that bpimmedia should create a Spangroups report. The default
is to create an Images-on-Media report.
-t sched_type
Specifies a schedule type for the image selection. The default is any
schedule type. Valid values, in either upper- or lower-case, are:
134
bpimmedia
FULL (full backup)
UBAK (user backup)
UARC (user archive)
-U
The list type is user. This option is used only in combination with
-spangroups. See the section DISPLAY FORMATS for more detail.
-verbose
install_path\NetBackup\logs\admin directory is defined).
DISPLAY FORMATS
IMAGES-ON-MEDIA REPORT
For the Images-on-Media report, there are two formats, short (-l or default) and long
(-L).
Note, if you want to process and use the output of bpimmedia, VERITAS recommends
that you use the -l option. The output of bpimmedia using 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, for example, want to obtain a quick and more readable view of the NetBackup
images on media.
◆
Long Display Format (-L)
If the command line contains -L, the display format is long. The -L display format
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 in the table below. The first line of the entry contains the fields
Backup_ID...Expires. Then, for each fragment in the image, there is a line containing
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 bpduplicate for more information on the terms 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.)
135
bpimmedia
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 is Regular (scheduled or user-directed backup)
P is Pre-imported backup (phase 1 completed)
I is Imported backup
PC - Primary copy, 1 or 2. Designates which copy of the backup NetBackup
chooses when restoring.
Expires - Expiration date of the first copy to expire, which is indicated by the
Expires field of the fragment which is described below
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.
Type - Media type (Rmed for removable media; Disk otherwise)
Density - Density of the device that produced the backup (applies only to removable media)
Fnum - File number; this is the n-th backup on this medium (applies only to removable media)
Off - The byte offset on the medium where the backup begins (applies only to
optical disk; ignore this value for tapes and magnetic disk)
Host - Server whose catalog contains this image
DWO - 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 indicating whether this copy is multiplexed, Y or N (applies only
when fragment number is 1)
Expires - Expiration date of this copy (applies only when fragment number is 1)
MediaID - Media ID or absolute path where the image is stored
136
bpimmedia
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 Off Host DWO MPX Expires MediaID
---------------------------------------------------------------gava_0949949902 regr1_guav FULL 3
25 N N R 1 12:58 03/09/2003
1
1
256 RMed dlt
13
0
plim 0
Y
12:58 03/09/2002 A00002
◆
Short Display Format (-l)
If the bpconfig command line contains -l or contains no list-format option, the
display format is short. This produces a terse listing. This option can be useful for
scripts or 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 for an entry is n+1, where n is the number of fragments for the image. The layout
of an entry is a first line, containing information about the image, followed by a line
containing information about each fragment of the image. The attributes appear in the
following order, separated by blanks.
Fields and Meanings 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(1M) to interpret the policy-type value as a policy-type name.
Schedule - Schedule name
Type - Schedule type (full, etc.)
RL - Retention level (0..24)
Files - Number of files
Expires - Expiration date of the first copy to expire, which is indicated by the Expires field of the fragment which is described below (system time); 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
137
bpimmedia
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
(Internal) Internal value, not documented
Type - Media type (2 for removable media; 0 for 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; this is the n-th backup on this medium (applies only to 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 dateTime this medium was allocated (system time)
DWO - Device Written On (applies only to removable media)
(Internal) - Internal value, not documented
(Internal) - Internal value, not documented
Expires - Expiration date of this copy in system time (applies only when fragment
number is 1)
MPX - Flag indicating whether this copy is multiplexed, 1(yes) or 0(no) (applies
only when fragment number is 1)
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
SPANGROUPS REPORT
For the Spangroups report, there are two formats: user (-U option) and short (the default).
Both formats list, for each server, the server name, and the group data for that server. For
each group of media that share spanned backup images, the media Ids are listed. When
-mediaid appears on the command line, only the server and media group related to that
media ID are displayed.
138
bpimmedia
Note, if you want to process and use the output of bpimmedia, VERITAS recommends
that you use the -l option. The output of bpimmedia using 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, for example, want to obtain a quick and more readable view of the NetBackup
images on media.
The user (-U) display format looks like this:
bpimmedia -spangroups -U
Related media groups containing spanned backup images, server plim:
Group:
A00002 A00003
Group:
400032
The short display format looks like this
bpimmedia -spangroups
SERVER plim
GROUP A00002 A00003
GROUP 400032
NOTES
command with the -help option and check the USAGE. The following is part of the
usage statement for bpimmedia that shows the -d and -e options:
[-d mm/dd/yyyy hh:mm:ss] [-e mm/dd/yyyy hh:mm:ss] Notice the month/day/year and hours:minutes:seconds requirements for the -d and -e
options. These are for a locale setting of C and can be different for other locales.
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
1 IDX
844 RMed dlt
2
5909
N
0
N
R
1
15:58 07/18/2004 almond
3
CB7514 139
bpimmedia
1
1
9136 RMed dlt
◆
1
0
almond
3
N
15:58 07/18/2004 CB7514 Example 2
The following example displays the tapes required to restore a particular file. If the
bpimmedia command line provides the criteria to identify an individual backup, the
output shows which media were 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/2002 -t UBAK Backup-ID
Policy
Type RL Files
C E T PC Expires Copy Frag
Off
Host
DWO MPX Expires
MediaID --------------------------------------------------------------------------------------------gava_0949949686
regr1_guav UBAK
1
1
10256 RMed dlt
11
3
25
N N
plim
0
R
1
0
12:54 03/09/2004 Y
12:54 03/09/2004 A00002 Example 3
List, in long format, all the backups in the image catalog on the master server gava.
bpimmedia -L -M gava Backup-ID
Policy
Type RL Files
Off
Host
DWO MPX Expires
MediaID --------------------------------------------------------------------------------------------gava_0949599942
test-policy FULL 1
15
N N R 1
11:45 02/17/2004 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
Off
Host
DWO MPX Expires
MediaID --------------------------------------------------------------------------------------------toaster1_0929679294 tort_policy FULL 3
5898
N N R 1
23:14 07/18/2004 1 IDX
839 RMed dlt
4
0
almond
6
CB7514 1
1
27154 RMed dlt
3
0
almond
6
N
23:14 07/18/2004 CB7514 toaster1_0929653085 NDMP_policy FULL
1 IDX
844 RMed dlt
2
1
1
9136 RMed dlt
1
140
3
0
0
5909
N N
almond
almond
R
1
3
3
15:58 07/18/2004 CB7514 N
15:58 07/18/2004 CB7514 NetBackup Commands for Windows
bpimmedia
RETURN VALUES
bpimmedia: EXIT status = exit status
FILES
install_path\NetBackup\db\images
SEE ALSO
bpbackup, bpduplicate, bpimport
141
bpimport
bpimport
NAME
bpimport - Import NetBackup and Backup Exec backups that are expired or are from
another NetBackup or Backup Exec server.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpimport -create_db_info
-id media_id [-server name] [-L output_file [-en]]
[-passwd][-local]
install_path\NetBackup\bin\admincmd\bpimport [-l] [-p] [-pb]
[-PD] [-PM] [-v] [-local] [-client name] [-Bidfile
file_name] [-M master_server] [-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]
DESCRIPTION
The bpimport command allows backups to be imported. This command is useful for
importing backups that have expired or are from another NetBackup server.
The import operation consists of two steps:
◆ Step 1 is performed with the first form of the command shown above
(-create_db_info option) and recreates catalog entries for the backups that are on
the specified media.
◆ Step 2 is performed with the second form of the command shown above and 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 2004 and its retention level is one week,
its new expiration date is 21 November 2004.
You can import a backup only if all copies of it are expired. For more information on
importing backups, see the NetBackup System Administrator’s Guide.
OPTIONS
-backupid backup_id
Specifies the backup ID of a single backup to import.
142
bpimport
-Bidfile file_name
file_name specifies a file that contains a list of backup IDs to be imported.
List one backup ID per line in the file. If this option is included, other
selection criteria is ignored.
remove 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 backups that are already in the catalog. This
option only creates information about backups that are candidates for
import, and does not perform the import operation. The bpimport
command must be run with this option prior to importing any backups.
The -id parameter is required with this option.
-e enddate
-s startdate
The default for the end date is the current date and time; the default for
the start date is 24 hours prior to the current date and time.
-hoursago hours
Specifies number of hours to search prior to the current time for backups.
Do not use with the -s option. The default is the previous midnight.
-id media_id
For step 1 (-create_db_info), this option specifies the media ID that
has the backups you are going 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 by step
1 of the import operation.
143
bpimport
A backup ID that begins on a media ID that was not processed by step 1 is
not imported. A backup that ends on a media ID that was not processed
by step 1 will be incomplete.
-l Produces output in the progress log that lists each file imported.
-local
When bpimport is initiated from a host other than master server and the
-local option is not used (default), bpimport starts a remote copy of
the command on the master server.
Monitor.
Use the -local option to prevent the creation of a remote copy on the master server and 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 For NetBackup Server, this option is not required because there is 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 media server that is not the master, then the
master for that media server is the default.
-p
Previews backups to be imported according to the option settings, but
does not perform the import. Displays the media IDs, server name, and
information about the backups to be imported.
144
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 password given 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 being 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 are sorted by date and time
(newest to oldest).
-PM
Displays 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.
-pt policy_type
Search for backups created by the specified policy type. The default is any policy type.
Valid values are:
Informix-On-BAR
MS-Exchange-Server
MS-SQL-Server
MS-Windows
NDMP
NetWare
Oracle
OS/2
Standard
Sybase
145
bpimport
AFS
DB2
FlashBackup
SAP
Split-Mirror
-server name
Note For NetBackup Server there is only one server (the master). When using 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 be
imported. The default is the media server where the command is run.
-sl sched_label
Search for backups to import which were created by the specified
schedule. The default is all schedules.
-st sched_type
Search for backups to import which were created by the specified
schedule type. The default is any schedule type.
Valid values are:
FULL (full backup)
UBAK (user backup)
UARC (user archive)
-v
Selects verbose mode. When specified, the debug and progress logs
display more information.
EXAMPLES
Example 1
The following command (all on one line) creates catalog information for backups on
media ID A00000. The media host hostname is cat. The progress file is
\tmp\bpimport.ls.
bpimport -create_db_info -id A00000 -server cat -L \tmp\bpimport.ls
146
bpimport
Example 2
The following command (all on one line) displays information about the backups that are
candidates for import. The backups displayed would have been created between
11/01/2002 and 11/10/2002. The bpimport command with the -create_db_info
option must be run prior to this command.
bpimport -PM -s 11/01/2002 -e 11/10/2002
Example 3
The following command imports the backups specified in the /tmp/import/images
file. The progress is entered in the /tmp/bpimport.ls file.
bpimport -Bidfile \tmp\import\image -L \tmp\bpimport.ls
FILES
147
bpinst
bpinst
NAME
bpinst - installs and configures NetBackup Encryption to provide file-level encryption of
backups and archives.
SYNOPSIS
install_path\NetBackup\bin\bpinst -ENCRYPTION [-force_install] [-verbose] [-policy_names] name1 [name2 ... nameN]
install_path\NetBackup\bin\bpinst -LEGACY_CRYPT [-update_libraries] [-crypt_option option][-crypt_strength strength] [-passphrase_prompt |-passphrase_stdin] [-verbose] [ [-policy_encrypt 0 | 1] -policy_names] name1 [name2 ... nameN]
Note You must have NetBackup Encryption, a separately priced product, in order to use
this command.
DESCRIPTION
NetBackup Encryption provides file-level encryption of backups and archives. There are
two versions:
◆
-ENCRYPTION is the Standard Encryption method (recommended)
Provides the ability to encrypt data using 128-bit or 256-bit OpenSSL ciphers.
◆
-LEGACY_CRYPT is the Legacy Encryption method
Provides the user with the encryption strength choices previously available (40-bit
DES and 56-bit DES).
The bpinst command, used with the -LEGACY_CRYPT or the -ENCRYPTION option,
installs and configures the NetBackup Encryption product on NetBackup clients that can
support encryption.
Before using this command, install the encryption software on the server as explained in
the NetBackup Encryption System Administrator’s Guide. Then, execute bpinst
-LEGACY_CRYPT or -ENCRYPTION on the master server to install and configure
NetBackup Encryption on the clients. A single execution copies the required files to the
selected clients and also makes the necessary configuration changes on both the clients
and the master server.
148
bpinst
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 install and
configure the software on the client.
See the OPTIONS section for an explanation of all options used with bpinst
-ENCRYPTION or -LEGACY_CRYPT. (Pay special attention to the -passphrase_prompt
option.)
Note You can also configure encryption for a client that is installed on the master server
host.
OPTIONS
The following options apply to the -ENCRYPTION command.
-ENCRYPTION
Required if using 128- or 256-bit OpenSSL ciphers. This option must be
the first option specified to use the bpinst command to install or
configure Cipher-based encryption. The order is important and do not
omit this option.
-force_install
Installs the client files on the client machine without checking the version
of any existing files on the the client machine.
-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 or -ENCRYPTION installs and configures all the clients in each policy
specified.
If you omit the -policy_names option, the names are assumed to be NetBackup client names.
name1 [ name2 ... nameN ]
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.
-verbose
Prints the current encryption configuration of each client and what gets
installed and reconfigured on each client.
149
bpinst
The following options apply to the -LEGACY_CRYPT command.
-LEGACY_CRYPT
Required if using 40- or 56-bit DES encryption. This option must be the
first option specified to use the bpinst command to install or configure
DES encryption. The order is important and do not omit this option.
-update_libraries
Installs the encryption libraries on NetBackup clients. This option applies
to the -LEGACY_CRYPT option only.
-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 below).
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.
This is the default.
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 40-bit DES encryption. This is the default value for a client that
has not been configured for encryption.
DES_56 | des_56 | 56
Specifies 56-bit DES encryption.
-passphrase_prompt | -passphrase_stdin
Caution Do not forget the pass phrase. If the key file is damaged or lost, you may need
the pass phrase in order to regenerate the key file. Without the proper key file,
you cannot restore encrypted backups.
150
bpinst
NetBackup uses a pass phrase to create data that it places in a key file on
each client. NetBackup then uses the data in the key file to create the
encryption keys 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 are using 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. Encryption keys generated from the
pass phrase are used for subsequent backups. Old encryption keys are
retained in the key file in order 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 is the default for 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.
151
bpinst
If you include the -policy_names option, bpinst -LEGACY_CRYPT
or -ENCRYPTION installs and configures all the clients in each policy
specified.
If you omit the -policy_names option, the names are assumed to be
NetBackup client names.
name1 [ name2 ... nameN ]
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 list of notes applies to both the -ENCRYPTION and the -LEGACY_CRYPT
option. For additional information about NetBackup encryption, refer to the NetBackup
Encryption System Administrator’s Guide.
◆ If you are running NetBackup in a clustered environment, pushing software to the
client is only allowed from the active node.
◆ If you are pushing the encryption software to clients located in a cluster, specify the
hostnames of the individual nodes (not virtual names) in the list of clients.
◆ In a clustered environment, after you have successfully installed the add-on, unfreeze
the node.
◆ When you finish restoring encrypted files from a client, rename or delete the key file
created, and 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/name, you may not be able to
restore your own encrypted backups.
◆
Existing 40- or 56-bit encryption license keys are valid for upgrades.
The following list of notes applies to the -LEGACY_CRYPT option only.
◆ The pass phrase that bpinst -LEGACY_CRYPT sends over the network to a client is
encrypted by a privately defined NetBackup 40-bit DES key.
◆ The key file on each NetBackup client is encrypted with a privately defined
NetBackup DES key. The key can be 40 bit or 56 bit, depending on how the client is
configured. Restrict access to the key file to the administrator of the client machine.
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.
152
bpinst
◆ It is important to 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 named orca has been performing 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 in order to restore your backups.
The following is the basic procedure for disaster recovery when using encryption (see
the NetBackup Troubleshooting Guide for details on restoring the operating system and
NetBackup). This example assumes a NetBackup client named orca.
1. Reinstall the operating system on orca.
2. Reinstall and configure the NetBackup client software on orca.
3. Reinstall and configure encryption on orca by executing the following command (one
line):
bpinst -LEGACY_CRYPT -update_libraries -crypt_option allowed 4. Execute bpinst -LEGACY_CRYPT to create a pass phrase.
bpinst -LEGACY_CRYPT -passphrase_prompt orca
Enter new NetBackup pass phrase: *********************
Re-enter new NetBackup pass phrase: *********************
The pass phrase that you enter here is the first one used on orca.
5. Execute bpinst -LEGACY_CRYPT for each subsequent pass phrase used on orca:
# bpinst -LEGACY_CRYPT -passphrase_prompt orca
6. Restore the backed up files to orca.
EXAMPLES
Example 1
The following command copies encryption software from a master server to NetBackup
clients.
From a Master Server
Assume that you want to install the encryption software on client1 and client2. You
would enter a command like this (all on one line):
bpinst.exe -ENCRYPTION client1 client2
153
bpinst
Assume that you want to install the encryption software on all clients in the NetBackup
policies policy1 and policy2. You would enter a command like this (all on one line):
bpinst.exe -ENCRYPTION -policy_names policy1 policy2
Example 2
The following command installs the libraries on a NetBackup client named mars (one
line):
bpinst.exe -LEGACY_CRYPT -update_libraries mars
Example 3
The following command (all on one line) installs and configures 40-bit DES encryption on
UNIX clients in a policy named policy40:
bpinst -LEGACY_CRYPT -update_libraries -crypt_option allowed -crypt_strength des_40 -policy_encrypt 1 bpinst -LEGACY_CRYPT -passphrase_prompt -policy_names policy40
The above 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 4
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 5
The following command displays a verbose listing of the configuration for the client
named strong:
bpinst -LEGACY_CRYPT -verbose strong
BPCD protocol version 4.5.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 sgi5 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
No update of NetBackup configuration required for client strong
No update of NetBackup pass phrase required for client strong
154
bpinst
FILES
Windows:
◆
Windows server command
install_path\NetBackup\bin\bpinst.exe
◆
Windows server directory with encryption software
install_path\lib\client\
◆
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
install_path\share\version_crypt.txt
155
bpkeyfile
bpkeyfile
NAME
bpkeyfile - Encryption key file utility for NetBackup.
SYNOPSIS
bpkeyfile [-stdin] [-change_key_file_pass_phrase] [-change_netbackup_pass_phrase] [-display] key_file_path
AVAILABILITY
The bpkeyfile command is available only with the NetBackup Encryption option.
DESCRIPTION
bpkeyfile creates or updates a file that contains information used to generate DES
encryption keys. The information is generated based on a NetBackup pass phrase that you
supply. The key file is encrypted by a key-file pass phrase that you supply.
The NetBackup client software uses an encryption key calculated from information in the
key file 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 can be run automatically. If you use
your own key-file pass phrase, start bpcd with the -keyfile argument as explained
under in the NetBackup Encryption System Administrator’s Guide.
OPTIONS
-stdin
Read pass phrases from standard input. By default, bpkeyfile reads pass
phrases that you are prompted to input from your terminal window.
-change_key_file_pass_phrase (or -ckfpp) Change the pass phrase used to encrypt the key file.
-change_netbackup_pass_phrase (or -cnpp) Change the pass phrase used to encrypt NetBackup backups and archives
on this client.
-display
Display information about the key file.
156
bpkeyfile
key_file_path
The path of the key file to be created or updated by bpkeyfile.
NOTES
Pass phrases used by NetBackup 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. Space character (code 32) to tilde character (code 126).
The bpkeyutil command is used for legacy encryption.
FILES
Windows:
install_path\NetBackup\bin\keyfile.dat
(Windows client encryption key file)
157
bpkeyutil
bpkeyutil
NAME
bpkeyutil - A key file utility used for NetBackup standard encryption.
SYNOPSIS
install_path\NetBackup\bin\bpkeyutil [-stdin | -insert | -delete] [-display] [-client client_name1[,client_name2,...,client_namen]] [-M server]
AVAILABILITY
The bpkeyutil command is available only with the NetBackup Encryption option.
DESCRIPTION
The bpkeyutil command updates a key file that contains keys used for encryption and
decryption. The keys are generated based on private VERITAS NetBackup pass phrases that
you supply. The key file is encrypted using a key. The NetBackup client software will use
an encryption key from the key file, to encrypt files during a backup or decrypt files
during a restore.
OPTIONS
-stdin
Read pass phrases from standard input. By default, bpkeyutil reads pass
phrases that you are prompted to input from your terminal window.
-insert
Insert a new NetBackup pass phrase to the key file to encrypt NetBackup
backups and archives on this client.
-delete
Delete an existing pass phrase from the key file.
-display
Display information about the key file.
-client client_name1[,client_name2,...,client_namen]
Name of the client where the key file reside. The default is the local client.
You may specify multiple client names separated by commas. You can
only use this argument if you are a NetBackup administrator.
158
bpkeyutil
-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
◆
The bpkeyfile command is used for standard encryption.
◆
The key file must be the same on all nodes in a cluster.
FILES
install_path\NetBackup\var\keyfile.dat
(Windows client encryption key file)
159
bplabel
bplabel
NAME
bplabel - Write a NetBackup label on tape media.
SYNOPSIS
install_path\netbackup\bin\admincmd\bplabel -m media_ID -d density
[-o] [-p volume_pool_name] [-n drive_name | -u
device_number] [-host media_server] [-erase [-l]]
DESCRIPTION
The bplabel command writes a NetBackup label on the specified media. Labeling is
required only for media that were last used for NetBackup catalog backups or by a
non-NetBackup application. You can use this command to erase and label media that is
unassigned in a volume database. In addition, you can use this command to assign
specific media IDs. The NetBackup Device Manager service (ltid) must be active for
bplabel to succeed. You must also 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.
The following are some facts about using 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 already 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.
◆ You must have administrator privileges to run this command.
OPTIONS
-m m
edia_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 is always converted to uppercase.
The media ID must be six or fewer alphanumeric characters.
160
bplabel
-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 entering 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)
Note The following densities are supported only by NetBackup Enterprise Servers.
8mm2 (8-mm Cartridge 2)
8mm3 (8-mm Cartridge 3)
dlt2 (DLT Cartridge 2)
dlt3 (DLT Cartridge 3)
dtf (DTF Cartridge)
hcart2 (1/2 Inch Cartridge 2)
hcart3 (1/2 Inch Cartridge 3)
-o
Unconditionally overwrites the selected media ID. If this option is not
specified, bplabel prompts for permission to overwrite media that
meets any of the following conditions:
Contains a NetBackup media header.
Is 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.
-u device_number
Unconditionally assigns the standalone drive specified by
device_number. 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.
161
bplabel
-n drive_name
Unconditionally assigns the standalone drive specified by drive_name.
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.
-erase [-l]
This option is used to erase the media. Short erase is the default erase. If -l
option is specified, the media will be long erased. A long erase operation
can be very time consuming 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 will run on the local system.
NOTES
tpconfig -d, tpconfig -l, and vmoprcmd may truncate long drive names. Please use
tpconfig -dl to obtain the full drive name.
162
bplist
bplist
NAME
bplist - Lists backed up and archived files on the NetBackup server.
SYNOPSIS
install_path\NetBackup\bin\bplist [-A | -B] [-C client] [-S
master_server] [-t policy_type] [-k policy] [-F] [-R [n]] [-b
| -c | -u] [-l] [-r] [-flops file_options] [-Listseconds]
[-T] [-unix_files] [-nt_files] [-s date] [-e date] [-I]
[-PI] [-help] [-keyword "keyword_phrase"] [filename]
DESCRIPTION
bplist 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.
The list shows only the files that you have read access to. You also must own or have read
access to all directories in the file paths. You can list files that were backed up or archived
by another client only if you are validated to do so by the NetBackup administrator.
If you create directory install_path\NetBackup\logs\bplist\ with write access,
bplist creates an debug log file in this directory that you can use for troubleshooting.
The output of bplist goes to standard output.
OPTIONS
-A | -B
Specifies whether to produce the listing from archives (-A) or backups
(-B). The default is -B.
-C client
name must be as it appears in the NetBackup configuration. The default
is the current client name.
-S master_server
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. To display this dialog, start the Backup, Archive, and
163
bplist
-t 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
10 = NetWare
13 = MS-Windows
14 = OS/2
15 = MS-SQL-Server
19 = NDMP
17 = SAP
18 = DB2
20 = FlashBackup
21 = Split-Mirror
22 = AFS
25 = Lotus Notes
-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 (applies only to UNIX
clients) will end with a trailing @ and executable files with a trailing *.
-R [n]
Recursively lists subdirectories encountered to a depth of n. The default
for n is 999.
-b | -c | -u
Specifies an alternate date and time to be used for printing with the -l
option:
-b displays the backup date and time of each file.
-c displays the creation date and time for each file.
-u displays the last access date and time of each file.
164
bplist
The default is to display the time of the last modification of each file.
-l
Shows file details.
-Listseconds
Specifies that seconds granularity be used for the time stamp when the
the -l option is used.
-r
Lists disk images that were backed up. The default is to list file systems.
-flops file_options
Allows either Backup Exec files to be listed, or both Backup Exec and
NetBackup files to be listed. The default (-flops not specified) is to list
only NetBackup files.
To list only Backup Exe files specify:
-flops 524288
To list Backup Exe and NetBackup files specify:
-flops 1048576
-T
Lists directories in true-image backups. The default is to list non-true-image backups.
Note: TIR information will not appear for synthetic full backups, even
though TIR information is used for sythetic 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 and end date range for the listing. -s specifies a start date and time for the listing. The resulting list shows only files in backups or archives that occurred at or after the specified
date and time. The valid range of dates are from 01/01/1970 00:00:00 to 01/19/2038
03:14:07. The default is the current date minus six months.
165
bplist
-e specifies an end date and time for the listing. The resulting list shows
only files from backups or archives that occurred at or before the
specified date and time. Use the same format as explained above for start
date and time. The default is the current date and time.
-I
Specifies a case-insensitive search. This means that capitalization is not
considered when comparing 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, if a file named test exists in the three directories shown below,
a search for test finds all three instances of the file:
\tmp\junk\test
\abc\123\xxx\test
\abc\123\xxx\yyy\zzz\test
-help
the command line.
Specifies a keyword phrase for NetBackup to use when searching 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 the bpbackup or bparchive command.
You can use this option in place of or in combination with the other
restore options in order to make it easier to restore your backups and
archives. The following meta characters can be used to simplify the task
of matching keywords or parts of keywords in the phrase:
* matches any string of characters.
? matches any single character.
[ ] matches one of the sequence of characters 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 (‘...’ ).
filename
Names the file or directory to list. If you do not specify a path, the default
is the current working directory.
166
bplist
Any files or directories that you specify must be listed at the end,
following all other options. Use upper case 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:
bplist -l "D:\WS_FTP.LOG\*"
Note: If you are using the asterisk meta character "*", you should use quotation marks around the filename for the command to work properly.
EXAMPLES
Example 1
To list recursively, in long format, the files that were backed up in D:\WS_FTP.LOG.
bplist -l -R D:\WS_FTP.LOG
-rwx------ bjm
bjm
-rwx------ bjm
bjm
-rwx------ bjm
bjm
64 Oct 10
64 Oct 10
64 Oct 10
1997 D:\WS_FTP.LOG
1997 D:\WS_FTP.LOG
1997 D:\WS_FTP.LOG
Example 2
To list, with details, the files that were backed up and associated with all or part of the
keyword phrase
"My Home Directory"
in directory C:\home\kwc, enter the following:
bplist -keyword "*My Home Directory*" -l C:\home\kwc\
Example 3
To list, with details, the files that were archived and associated with all or part of the
keyword phrase
"My Home Directory"
in directory C:\home\kwc, enter the following:
bplist -A -keyword "*My Home Directory*" -l C:\home\kwc\
Example 4
To list, recursively and with details, the files that were backed up on drive D of Windows
client slater and associated with all or part of the keyword phrase
"Win NT"
bplist -keyword "*Win NT*" -C slater -t 13 -R -l D:\
167
bplist
FILES
install_path\NetBackup\logs\bplist\*.log
SEE ALSO
bp, bparchive, bpbackup, bprestore
168
bpmedia
bpmedia
NAME
bpmedia - Freeze, unfreeze, suspend, or unsuspend NetBackup media.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpmedia -freeze| -unfreeze|
-suspend|-unsuspend -m media_id [-h host] [-v]
install_path\NetBackup\bin\admincmd\bpmedia -movedb -m media_id
-newserver hostname [-oldserver hostname] [-v]
DESCRIPTION
bpmedia allows an individual NetBackup media ID to be controlled in terms of allowing
or disallowing future backups or archives to be directed to the media. Note that this
command applies only to media managed by Media Manager.
Note Under certain media or hardware error conditions, NetBackup automatically
suspends or freezes media. If this happens, the reason is logged in the NetBackup
Problems report. If necessary, you can use the bpmedia -unfreeze or
-unsuspend options to reverse this action.
OPTIONS
-freeze
Freezes the specified media ID. When an active NetBackup media ID is
frozen, NetBackup stops directing backups and archives to the media. All
unexpired images on the media continue to be available for restores.
NetBackup never deletes a frozen media ID from the NetBackup media
catalog, nor is it unassigned in the NetBackup volume pool when it
expires.
-unfreeze
Unfreeze the specified media ID. This reverses the action of freeze and
allows the media to be used for backups or archives again if it has not
expired. If a media is expired when it is unfrozen, it is immediately
unassigned in the NetBackup volume pool.
169
bpmedia
-suspend
Suspend the specified media ID. The action is the same as freeze except
that when the media ID expires, it is immediately unassigned in the
NetBackup volume pool.
-unsuspend
Unsuspend the specified media ID. This reverses the action of suspend
and allows the media to be used for backups or archives again.
-movedb -newserver hostname [-oldserver hostname]
Note You cannot use the -movedb option with NetBackup Server.
Moves a media catalog entry from one server to another in a master and media server cluster. This command moves the media catalog entry for the specified media ID from oldserver to newserver and updates the NetBackup image catalog to reflect that the media ID was moved. It is
assumed that after the move, newserver has access to the media.
-newserver hostname specifies the name of the host to which the entry
is moved.
-oldserver hostname specifies the name of the host where the catalog entry to be moved currently resides. If you do not specify -oldserver, the system where the command is being run is considered to be the old server.
The -movedb option is most meaningful in configurations where a master and its media servers are sharing a robotic library and have access
to all the media in the robot. If this is not the case, at a minimum, all NetBackup servers must use the same Enterprise Media Manager
Database, so the media can be moved from one robotic library to another without losing their attributes and assignment status.
-m media_id
Specifies the media ID that requires action. The media ID must be six or
fewer characters and must be in the NetBackup media catalog.
-h host
Specifies the host name of the server where the media catalog resides.
This option is required only if the volume was not written on the server
where you run the bpmedia command. In this case, the media ID is in the
NetBackup media catalog on the other server and you must specify the
name of that server on the bpmedia command.
For example, assume you have a master server named whale and a media
server named eel. You run the following bpmedia command on whale in
order to suspend media ID BU0001 that is in the media catalog on eel:
bpmedia -suspend -m BU0001 -h eel
170
bpmedia
Use the NetBackup Media List report to determine the host that has the
volume in its media catalog.
-v
Select verbose mode. This is only meaningful when running with debug
logging turned on (that is, when the
install_path\NetBackup\logs\admin directory exists).
EXAMPLES
Note You cannot use the -movedb option with NetBackup Server.
Assume that the master server is HOSTM, with HOSTS1 and HOSTS2 being media
servers. The following command, run on HOSTM, moves the media catalog entry for
media ID DLT001 from HOSTS1 to HOSTS2 and updates the NetBackup image catalog:
bpmedia -movedb -m DLT001 -newserver HOSTS2 -oldserver HOSTS1
FILES
install_path\NetBackup\logs\admin\*.log
install_path\NetBackup\db\media\*.log
171
bpmedialist
bpmedialist
NAME
bpmedialist - Display NetBackup media status.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpmedialist [-mlist] [-U | -l
| -L] [-m media_id] [-rl ret_level] [-d density] [-p
pool_name] [-h host_name | -M master_server,... ] [-v]
install_path\NetBackup\bin\admincmd\bpmedialist -summary [-U | -L]
[-brief] [-p pool_name] [-h host_name | -M
master_server,...] [-v]
install_path\NetBackup\bin\admincmd\bpmedialist -mcontents -m
media_id [-U | -l | -L] [-d density] [-h host_name | -M
master_server,...] [-v]
install_path\NetBackup\bin\admincmd\bpmedialist -count -rt
robot_type -rn robot_number [-d density] [-U | -l] [-h
host_name | -M master_server] [-v]
DESCRIPTION
bpmedialist queries one or more NetBackup media catalogs and produces a report on
the status of the NetBackup media. This command can be executed by authorized users.
For more information about NetBackup authorization, refer to "Enhanced Authorization
and Authentication" in the NetBackup System Administrator's Guide.
bpmedialist produces one of four reports:
MEDIA LIST REPORT
Media List (-mlist) report, provides information on either a single volume or all
volumes in the NetBackup media catalog. This report does not apply to disk storage units.
The report lists, for each volume in the report, the volume’s media Id, media server, and
other attributes. This is the default report type.
If -U is an option, the status field appears as English text. Otherwise, the status appears as
a hexadecimal integer. This is a three-digit value. The interpretation of the two
upper-order digits is given here. Any or all of these flags can be set. Settings other than
those listed here correspond to unreported states.
>= 0x200 Multiplexing is TRUE.
>= 0x080 Imported is TRUE.
>= 0x040 Multiple retention levels is TRUE.
172
bpmedialist
The interpretation for the low-order status digit is determined by comparing the digit to
the following values in order.
>= 0x008 The status is Full.
>= 0x004 This is an unreported state.
>= 0x002 The status is Suspended.
== 0x001 The status is Frozen.
== 0x000 The status is Active.
The reported status is the status for the low-order digit combined with the status for the
upper-order digits. For instance, for a status value of 0x040, the media ID is active, and
multiple retention levels are in effect.
The -l option produces a report in Short mode. Each media ID occupies one line of the
report. The fields on this line are listed below. The section on the Media List Report in
your NetBackup system administrator’s guide describes the fields in detail. Any fields
listed below that are not documented in that section are reserved for NetBackup internal
use.
◆
media id
◆
partner id
◆
version
◆
density
◆
time allocated
◆
time last written
◆
time of expiration
◆
time last read
◆
Kbytes
◆
nimages
◆
vimages (unexpired images)
◆
retention level
◆
volume pool
◆
number of restores
◆
status (described above)
◆
hsize
◆
ssize
173
bpmedialist
◆
l_offset
◆
reserved
◆
psize
◆
reserved
◆
4 reserved fields
MEDIA SUMMARY REPORT
The Media Summary report lists, by server, summary statistics for active and inactive
media grouped according to expiration date. The report shows the expiration date for the
media and the number of media at each retention level, and the status of each media ID.
MEDIA CONTENTS REPORT
The Media Contents report lists the contents of media as read directly from the media. It
lists the backup IDs that are on a single media ID. It does not list each individual file. This
report does not apply to disk storage units. Note that if you attempt to abort the command
by entering ctl-c and the media requested are still being mounted or positioned, the
storage unit may stay in use for some time after the break. Each entry in the report
appears as that area of the storage unit is read.
The -l format for the Media Contents report produces one line for each backup ID,
containing the fields below. The section on the Media Contents Report in your NetBackup
system administrator’s guide contains more details. Any fields not described in that
section are reserved for NetBackup internal use.
174
◆
version (1 denotes a DB backup image, 2 denotes a regular backup image)
◆
backup id
◆
creation time
◆
expiration time
◆
retention level
◆
fragment number
◆
file number
◆
block size (in bytes)
◆
status
◆
media_id
◆
size
◆
reserved
◆
data_start
bpmedialist
◆
reserved
◆
client_type *
◆
copy_num *
◆
sched_type *
◆
flags *
◆
opt_extra
◆
mpx_headers
◆
res1
◆
policy name *
◆
schedule label *
* These fields are significant only if version is 2.
MEDIA COUNT REPORT
The Media Count report shows a count of the number of UP devices matching all the
criteria specified. The robot type and the robot number are mandatory criteria for this
report. The -U format provides a title, Number of UP devices for rt(rn) = value. The -l
format provides only the value.
OPTIONS
Report-type Options
bpmedialist produces one of four types of reports. An option on the command line
determines the type of report produced. The report-type options are as follows:
-mlist
Produce a Media List report. This is the default report type.
-summary Produce a Media Summary report.
-mcontents
Produce a Media Contents report.
-count
Produce a Media Count report. This report also displays the media
attribute ALLOW_MULT_RET_PER_MEDIA and its value, 0 (do not allow)
or 1 (allow).
Report-format Options
The bpmedialist report can appear in one of several formats. The report-format options
are as follows:
175
bpmedialist
-brief Produce a brief report. This option is available for the Media Summary
report only. The default is a full report, which includes a breakdown of
active and non-active media, reporting on each media ID’s status within
these categories.
-U
Report in user mode. This is the default report mode. The report includes
a banner listing the column titles, and the report style is descriptive,
rather than terse.
-L Report in long mode. This format produces the report with the most
complete information. For instance, for the Media List report, the report
lists the attributes of each media ID as a series of keyword = value pairs,
one attribute per line. A value may be expressed as both a numeric value
and a descriptive value.
-l Report in short mode. This format produces a terse report. This option is
useful for scripts or programs that rework the listing contents into a
customized report format.
Other Options
The following are the remaining options used by bpmedialist:
-d density
Report on media of this density type. If the robot type is specified on the
command line, the value for density should be consistent with the robot
type. Available density types are:
4mm - 4mm Cartridge
8mm - 8mm Cartridge
dlt - DLT Cartridge
qscsi - 1/4 Inch Cartridge
Note The following densities are supported only on NetBackup Enterprise Servers.
dlt2 - DLT Cartridge 2
dlt3 - DLT Cartridge 3
dtf - DTF Cartridge
hcart - 1/2 Inch Cartridge
hcart2 - 1/2 Inch Cartridge 2
hcart3 - 1/2 Inch Cartridge 3
odiskwm - Optical Disk Write-Many
176
bpmedialist
odiskwo - Optical Disk Write-Once
-m media_id
Report on this media ID only. This is a required option for the Media
Contents report.
For the Media List report, this option is optional, and, by default, all
media IDs are included in that report. The media ID can be provided in
either upper- or lower-case. The media ID must be six or fewer characters
and must be in the NetBackup media catalog (that is, assigned from the
NetBackup volume pool).
-h host_name
Note For NetBackup Server, there is only one server (the master) so use the name of that
server for host_name.
host_name is either the name of a host, or the character string ALL. If
host_name is the name of a host, the query goes to the media catalog
residing on the system host_name. For the -mcontents and -count
options, this option can appear once. For the -mlist and -summary
options, this option can appear more than once. The default is all servers
in the set of storage units for removable media.
The system host_name must allow access by the system running
bpmedialist. host_name can be a media server for a master server
other than the local master server. The default is the master server of the
local cluster.
For a media server for a master server other than the local master, if a
bpmedialist query is made using -h the_media_server, and an
equivalent bpmedialist query uses -M the_media_servers_master, the
bpmedialist using -h may complete faster. This difference in response
time can be significant if the master server addressed by -M is located
remotely, and the media server addressed by -h is local.
If host_name is ALL, the query goes to the local master server and its
media servers.
-help
the command line.
A list of alternative master servers. This is a comma-delimited list of host
names. If this option is present, each master server in the list runs the
bpmedialist command. If an error occurs for any master server,
processing stops at that point.
177
bpmedialist
servers in this list. bpmedialist queries each of these master servers.
Each master server in the list must allow access by the system issuing the
bpmedialist command.
For -mcontents (Media Contents report) only, the master server returns
media information from the media catalogs. This media information is for
both the master and its media servers (except for NetBackup Server
which does not support remote media servers). For example, if a media
ID exists on a media server of one of the master servers in the -M list, the
master retrieves the media information from the media server and returns
it to the system running bpmedialist. In this case, both the master
server and the media server must allow access by the system issuing the
bpmedialist command.
The default is the master server for the server running bpmedialist.
Note NetBackup Server supports only one server, the master; so the default, in this case,
is always the NetBackup Server master where you run bpmedialist.
-p pool_name
Report on the media IDs that belong to this volume pool. The default is
all pools.
-rl retention_level
Report on media that are using this retention level. The retention level
determines how long to retain backups and archives. The retention_level
is an integer between 0 and 24. The default retention level is 1.
Following are the retention levels with the installation values for the
corresponding retention periods. Note that your site may have
reconfigured the retention periods corresponding to the retention levels.
0
1 week
1
2 weeks
2
3 weeks
3
1 month
4
2 months
5
3 months
6
6 months
7
9 months
8
1 year
9 - 24 infinite
178
bpmedialist
-rn robot_number
Report on the robot using this robot number. This is a required option
when the -count option is used. The robot number can be obtained
from the Media Manager device configuration. For rules concerning the
use of this number, see your Media Manager system administrator’s
guide.
-rt robot_type
Report on a robot of this type. This is a required option when the -count
option is used. For non-robotic (standalone) devices select NONE. Valid
robot types include the following
TL4 - Tape Library 4MM
TLD - Tape Library DLT
NONE - Not robotic
Note The following robot types apply only to NetBackup Enterprise Server.
ACS - Automated Cartridge System
ODL - Optical Disk Library
TLH - Tape Library Half-Inch
TLM - Tape Library Multimedia
TSH - Tape Stacker Half-Inch
-v
Select verbose mode. This option causes bpmedialist to log additional
EXAMPLES
Example 1
The following example produces a media report for all media IDs defined for the master
server of the local system and any media servers.
Note For NetBackup Server, the report includes only media IDs for the master server
because remote media servers are not supported.
bpmedialist Server Host = hatt id
rl
images
allocated
last updated
density
kbytes
restores 179
bpmedialist
vimages
expiration
last read
<------- STATUS -------> --------------------------------------------------------------------------143191 0
28
12/03/2002 23:02 12/22/2002 23:00
dlt
736288
1 7
12/29/2002 23:00 12/09/2002 10:59 144280
0 9
0
11/25/2002 11:06
12/08/2002 23:03
12/01/2002 23:03
dlt
N/A
EXPIRED
AEK800
0
22
7
12/06/2002 03:05
12/30/2002 03:01
12/23/2002 03:01
12/09/2002 10:48 dlt
23213184
0 C0015
0
28
7
11/26/2002 02:09
12/30/2002 02:01
12/23/2002 02:01
N/A dlt
896448
0 IBM001
0 16
14
12/16/2002 01:01
12/30/2002 01:07
12/23/2002 01:07
N/A dlt
6447360
0 L00103
0
20
9
12/07/2002 08:33
12/30/2002 01:07
12/23/2002 01:07
N/A
dlt
7657728
0
L00104
0 12/11/2002 01:09
12/28/2002 01:04
12/21/2002 01:04
N/A dlt
5429504
0 9
5
290304
FROZEN 0 Example 2
The following example produces a media count report for robot type TLD and robot
number 0:
bpmedialist -count -rt TLD -rn 0
ALLOW_MULT_RET_PER_MEDIA 0
Number of UP devices for TLD(0) = 2
Example 3
The following example produces a media contents report for media ID AEK802. The
report is partially listed below.
bpmedialist -mcontents -m AEK802
media id = AEK802, allocated 01/08/2004 03:10, retention level = 0
File number 1
Backup id = hat_0915786605
Creation date = 01/08/2004 03:10
Expiration date = 01/15/2004 03:10
Retention level = 0
Copy number = 1
Fragment number = 2
Block size (in bytes) = 65536
File number 2
180
bpmedialist
Backup id = hat_0915809009
Creation date = 01/08/2004 09:23
Expiration date = 01/15/2004 09:23
Retention level = 0
Copy number = 1
Fragment number = 1
Block size (in bytes) = 65536
Example 4
In this example, bpmedialist runs on the master server buff. bpmedialist produces a
Media List report for master servers hatt and duo.
bpmedialist -M hatt,duo
Server Host = hatt
id
rl
images
allocated
last updated
density kbytes
restores
vimages
expiration
last read
<------- STATUS ------->
--------------------------------------------------------------------------143191
0
51
12/03/2002 23:02 01/11/2003 23:04
dlt
1436686
2
9
01/18/2003 23:04 01/08/2003 10:26
144280
0 9
0
11/25/2002 11:06
12/08/2002 23:03
12/01/2002 23:03
01/12/2003 16:10
dlt
EXPIRED
AEK800
0
AEK802
0 C0015
IBM000
38
3
12/06/2002 03:05
01/15/2003 03:10
01/08/2003 03:10
12/09/2002 10:48
dlt
FULL
6
6
01/08/2003 03:10
01/19/2003 03:05
01/12/2003 03:05
01/12/2003 16:12
dlt
6140544
0
0
48
7
11/26/2002 02:09
01/19/2003 02:11
01/12/2003 02:11
N/A
dlt
1531968
0
0 19
13
01/01/2003 01:09
01/19/2003 02:05
01/12/2003 02:05
01/09/2003 05:41
dlt
290304
FROZEN
0
3922200024
8284224
0
0
Server Host = duo
id
rl
images
allocated
last updated
density
kbytes restores
vimages
expiration
last read
<------- STATUS ------->
--------------------------------------------------------------------------A00004
0 0
11/16/2003 05:31
N/A
4mm
0
0
0
N/A
N/A
FROZEN
DLT210
1 DLT215
0
5
2
12/09/2002 06:10
01/22/2003 06:04
01/08/2003 06:04
N/A
dlt
2560
0
124
28
12/08/2002 14:57
01/19/2003 08:07
01/12/2003 08:07
12/31/2002 15:42
dlt
9788072
4
Example 5
181
bpmedialist
In this example, bpmedialist reports which of two hosts has a given media ID
configured. Since the host hatt does not have A00004 configured in its media catalog, it
reports, the requested media ID was not found in the NetBackup media catalog or
Enterprise Media Manager Database.
The host duo does have A00004 configured, so it produces a Media List report for A00004
(the command is all on one line).
bpmedialist -mlist -h hatt -h duo -m A00004
requested media id was not found in NB media database and/or MM volume database
Server Host = duo
id
rl
images
allocated
last updated
density
kbytes restores
vimages
expiration
last read
<------- STATUS ------->
--------------------------------------------------------------------------A00004
0 0
11/16/2003 05:31
N/A
4mm
0
0
0
N/A
N/A
FROZEN
FILES
EMM database
182
bpminlicense
bpminlicense
NAME
bpminlicense - Manage NetBackup license file.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpminlicense [-path
license_key_file | -M server] [-debug] [-verbose]
[-list_keys] [-nb_features | -sm_features]
install_path\NetBackup\bin\admincmd\bpminlicense [-path
license_key_file | -M server] [-debug] [-verbose]
-find_keys | -delete_keys | -add_keys keystring1 ..
keystringn
DESCRIPTION
The bpminlicense utility manages a NetBackup license file. The preferred method to
manage NetBackup licenses is to use the Help > License Keys panel in the NetBackup
Administration console. For UNIX servers, you may use the get_license_key(1M)
utility to manage the NetBackup licenses, which is preferred to this command.
OPTIONS
-add_keys | -delete_keys | -find_keys keystring1 .. keystringn
Respectively, these options find and list, add, or delete one or more
specified keystrings in the NetBackup license file.
-debug
Display detailed information to standard error.
-list_keys
List the keys in the NetBackup license file.
-M server
Use the standard NetBackup license file from the specified NetBackup
server.
-nb_features
-sm_features
Respectively, list only active NetBackup or Storage Migrator feature IDs
(and active keys when specified with the -verbose option).
183
bpminlicense
-path license_key_file
Use the specified license_key_file on the local system. The default is the
standard NetBackup license file.
-verbose
Display additional information to standard output.
184
bpnbat
bpnbat
NAME
bpnbat - enables a user to accomplish Authentication tasks from within NetBackup.
SYNOPSIS
install_path\NetBackup\bin\bpnbat [-Login] [-WhoAmI] [-AddDomain |
-RemoveDomain] [-AddUser | -RemoveUser] [-AddMachine]
[-LoginMachine] [-GetBrokerCert] [-ShowBrokerCerts]
[-RemoveBrokerCert]
DESCRIPTION
The bpnbat command is a tool that enables a user to use the VERITAS Security
Subsystem (VxSS). VxSS has two distinct pieces to it.
◆
Authentication - the act of proving who you are
◆
Authorization - the act of checking what you can do
bpnbat enables a user to accomplish authentication tasks from within NetBackup. Note Any command that asks for a password will not echo the password or asterisks as
they allow a shoulder surfer to significantly narrow the password search space.
Note The use of NetBackup Access Control requires the user’s home directories to work
correctly.
OPTIONS
-Login
Use this option to identify oneself to the system. When running this
command, enter a Name, Password, Domain, Authentication type, and a
server to authenticate. The combination of a name, password, domain,
and domain type create a unique identity within an Enterprise-wide
network. The first time a broker is contacted, you are asked if you want to
trust that broker and authenticate them. You cannot use an untrusted
broker.
-WhoAmI Use this command to tell what identity you are currently using within
VxSS. It lists your name, domain, the authenticating broker who issued
the credential, the time at which a certificate will expire, and the domain
type that was used when creating the credential.
185
bpnbat
[-AddDomain | -RemoveDomain] These options enable an administrator, who is running locally on an
Authentication server, to add or remove domains within the private
VERITAS Domain Database. These domains are not accessible from
within any operating system, and only have meaning within VxSS. They
are intended to be used in places where a centralized naming authority (
such as a PDC/AD, or NIS domain ) is not available.
You must have administrator privileges to use these command options.
[-AddUser | -RemoveUser] These options enable an administrator, who is running locally on an
Authentication server, to add or remove users from within domains in the
private VERITAS Domain Database. These accounts only have meaning
within VxSS. They are intended to be used in places where a centralized
naming authority ( such as, PDC/AD or NIS domain) is not available.
You must have administrator privileges to use these command options.
-AddMachine
Run this option on your authentication broker (root +ab). This option
registers a machine in a private VERITAS Security Subsystem database.
The identity is placed in the private domain
NBU_Machines@<at.server.name>.
-LoginMachine
Run this option on your NetBackup Media, Master, and Clients. This
option enables you to identify a machine using an account within the
VERITAS Security Subsystem private domain
NBU_Machines@<at.server.name>. This is similar to logging in as a user
to a specified authentication broker.
-GetBrokerCert
This command is used to obtain a broker certificate without
authenticating to a broker.
-ShowBrokerCerts
This command lists all of the brokers that the user currently trusts. Any
broker listed is trusted to handle authentication requests that are sent to
it.
-RemoveBrokerCert
This command removes a trust of a specified authentication broker. You
can use this command to remove a broker when you no longer trust it, for
example, an authentication broker is moved to a different corporate
division.
EXAMPLES
Example 1
186
bpnbat
In the following example the user is using the -Login option to connect to the
Authentication Broker (the server that handles the Authentication process) called
test.domain.veritas.com, using the default port number. In the following example, an NIS
account is being used, therefore a domain name associated with the NIS account is
provided in addition to a user and password.
# bpnbat -Login
Authentication Broker: test.domain.veritas.com
Authentication port[ Enter = default]:
Authentication type (NIS, NISPLUS, WINDOWS, vx, unixpwd): NIS
Domain: domain.veritas.com
Name: username
Password: You do not currently trust the server: test.domain.veritas.com, do you wish to trust it? (y/n):
y
Operation completed successfully.
Example 2
The -WhoAmI command verifies the identity that you are currently using within VxSS. It
lists your name, domain, the authenticating broker who issued the credential, the time at
which your certificate will expire and what type of domain you used in creating the
credential.
# bpnbat -WhoAmI
Name: user name
Domain: domain.veritas.com
Issued by: /CN=broker/[email protected]/O=vx
Expiry Date: Oct 27 20:57:43 2003 GMT
Authentication method: NIS
Example 3
Adding a machine to the machine identities list:
# bpnbat -AddMachine
187
bpnbat
Does this machine use Dynamic Host Configuration Protocol (DHCP)? (y/n) n
Authentication port[ Enter = default]: Name: auto.domain.veritas.com
Password: Operation completed successfully.
Logging in a machine to a specified authentication broker:
# bpnbat -LoginMachine
Authentication port[ Enter = default]: Name: auto.domain.veritas.com
Password: Operation completed successfully.
Logging in a machine to a specified authentication broker and a problem occurs:
If the user has a multi-NIC configuration, or if the broker name is typed incorrectly, a
second prompt appears that gives the user a second chance at entering the proper broker
name. The following example assumes sleemanNB is a private NIC name. The public
NIC name that VxSS uses to build the authentication domain is
sleeman.min.veritas.com. If the user is using the -loginmachine command and
there is a failure (such as a bad machine name, wrong password, or incorrect broker name)
the user has a second opportunity to enter an explicit primary hostname for the
authentication broker. Refer to the following example:
# bpnbat -LoginMachine
Authentication Broker: sleemanNB
Authentication port[ Enter = default]: Machine Name: challenger
188
bpnbat
Password: Primary host name of broker: sleeman.min.veritas.com
Example 4
This command is used to obtain a broker certificate without authenticating to a broker. It
expects a broker (test.domain.veritas.com) and a port (0 for default)
# bpnbat -GetBrokerCert test.domain.veritas.com 0
Example 5
This command will list all the brokers that the user currently trusts
# bpnbat -ShowBrokerCerts
Name: root
Domain: [email protected]
Issued by: /CN=root/[email protected]/O=vx
Expiry Date: Jun 12 20:45:19 2006 GMT
Authentication method: VERITAS Private Security
Name: root
Expiry Date: Feb 17 19:05:39 2006 GMT
Name: root
Expiry Date: May 13 23:20:58 2006 GMT
189
bpnbat
Example 6
The -RemoveBrokerCert option removes a broker when the user no longer wants to
trust it. In the following example, an authentication broker is moved to a different
corporate division.
# bpnbat -RemoveBrokerCert test.domain.veritas.com
The user can now use the -ShowBrokerCerts option to display current certificates. The
previously removed certificate is no longer displayed.
SEE ALSO
bpnbaz
190
bpnbaz
bpnbaz
NAME
bpnbaz - enables a user to accomplish Authorization administration tasks from within
NetBackup
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpnbaz -[AddUser | DelUser]
Group_Name Domain_Type:Domain_Name:User_Name
[-OSGroup] [-M server] [-Server server1.domain.com]
[-CredFile Credential]
install_path\NetBackup\bin\admincmd\bpnbaz -[AddGroup | DelGroup]
Group_Name [-M server] [-Server server1.domain.com]
[-CredFile Credential]
install_path\NetBackup\bin\admincmd\bpnbaz -UpGrade60
install_path\NetBackup\bin\admincmd\bpnbaz -[ListPerms |
ListMainObjects | ListGroups | ShowAuthorizers] [-M
server] [-Server server1.domain.com] [-CredFile
Credential]
install_path\NetBackup\bin\admincmd\bpnbaz -ListGroupMembers
Group_Name [-M server] [-Server
server1.domain.com][-CredFile Credential]
install_path\NetBackup\bin\admincmd\bpnbaz -AddPerms
Permission_1[,Permission_2,...] -Group Group_Name
-Object Object [-M server] [-Server
server1.domain.com] [-CredFileCredential]
install_path\NetBackup\bin\admincmd\bpnbaz -DelPerms
[Permission_1,...] -Group Group_Name -Object Object
[-M server] [-Server server1.domain.com]
[-CredFileCredential]
install_path\NetBackup\bin\admincmd\bpnbaz -[AllowAuthorization|DisallowAuthorization] Machine Name [-M server] [-Server server1.domain.com] install_path\NetBackup\bin\admincmd\bpnbaz -SetupSecurity NBU.Master.Server.com [-M server] [-Server server1.domain.com] Chapter 1, NetBackup Commands
191
bpnbaz
DESCRIPTION
NetBackup uses the bpnbaz command line executable to access the authorization portion
of VxSS. Authorization is the process of checking rights on an object. This command
enables you to do the following:
◆
Add users to Az groups
◆
Create Az groups
◆
Add and remove permissions from the main NetBackup resource objects
◆
Add and remove permissions on individual policies
◆
List current permissions on NetBackup resource and policies
◆
List Az groups
◆
Lists users within Az groups
◆
Permit machines to perform authorization actions
◆
Setup the initial security information
To use this command and its associated options, you must be a member of the NetBackup
Security Administrators group (NBU_Security Administration). The only exception to this
is with the SetupSecurity command. You must have local administrator privileges on the
authorization server to use this command.
When using bpnbaz, it is assumed that the Master server and the Az server are the same
machine.
Note The use of NetBackup Access Control requires the user’s home directories to work
correctly.
OPTIONS
-AddGroup Group_Name
This option enables you to create an authorization group defined with the
variable Group_Name. NOTE: An Az group is a collection within the Authorization engine into
which OS groups and OS users can be placed. Adding a user to an Az
group grants them the rights and privileges associated with that group.
192
bpnbaz
-AddPerms Permission_1[,Permission_2,...]
This option adds the permissions specified for the given role to the object or policy in
question. Refer to the NetBackup System Administrator’s Guide for
additional information. -AddUser Group_Name
Domain_Type:Domain_Name:User_Name
You can add users by creating a unique enterprise account name,
following this format: <Authentication
type>:<Domain_Type>:<User_Name to which the user or group
belongs>
The supported Authentication types for this variable are:
Nis ... Network Information Services
NISPLUS ... Network Information Services Plus
Unixpwd ... Unix Password file on the Authentication server
WINDOWS ... Primary Domain Controller or Active Directory
Vx ... VERITAS Private database.
The Domain_Type variable is the domain that the user or group belongs,
and the User_Name variable defines the applicable user or group name.
-AllowAuthorization Machine Name
This option specifies which machines are allowed to perform
authorization checks. The security administrator must specify which
servers ( Master or Media) are permitted to examine the Authorization
database to perform authorization checks.
-CredFile Credential
This option specifies a file name (Credential) from which to obtain an VxSS
credential, rather than the default location.
-DelGroup Group_Name
Deleting an Az group from the authorization engine removes all the
members of the group. This operation is not reversible; removing a group
will revoke the rights granted to members of the group.
-DelPerms This option deletes all permissions from an object for a given group. -DelUser
Group_Name Domain Type:Domain_Name:User_Name
This option enables you to remove a user from an authorization group .
This operation is not reversible. Refer to the AddUser option for
definitions of the Domain_Type, User_Names, and Authentication types.
193
bpnbaz
-DisallowAuthorization Machine Name
This option specifies which machines are not allowed to perform
authorization checks. The security administrator must specify which
servers ( Master or Media) are not permitted to examine the
Authorization database to perform authorization checks.
-ListGroupMembers Group_Name
This option lists the group member associated with a particular group
defined by Group_Name.
-ListGroups
This option lists the defined groups.
-ListMainObjects
This option lists the current permissions for each group on each of the
main NetBackup objects. This is an informative view that you can use to
verify changes to permissions on an object. This options shows the
permissions each group has within the authorization system.
-ListPerms
The option -ListPerms shows all applicable permissions for a given object or object
type within the database. This will help the user to create meaningful
customizations to their authorization. -Group Group_Name
This option enables you to define user groups that can be members of
multiple user groups at the same time. NetBackup does not allow user
groups to be nested.
-Object Object
This options enables you to control the access to specified objects or object
collections.
-OSGroup
This option enables you to define a named collection of authentication
principals, established in a native operating system, and treated as a
single entity. All members of an authentication group, or OS group, are
from the same authentication domain.
-M server
This option specifies the name of the master server as defined in the
variable server. This server name may be different from the local host
name.
-SetupSecurity
This option must be run as root on the Az server.
-Server server1.domain.com
This option specifies the Az server being used. Currently we expect the
Az server and the NetBackup master server to exist on the same system.
194
bpnbaz
-ShowAuthorizers
This option lists the machines are allowed to perform authorization
checks.
-UpGrade60
This option modifies the NBU_Operator groups permissions to enable an
operator to continually view general media and device information. This
command should only be run when upgrading a system from NetBackup
5.x (any patch level) to NetBackup 6.0.
EXAMPLES
Example 1
An Az group is a collection within the Authorization engine where other OS groups and
OS users are placed. This is the basic building block against which permissions are
applied on the objects within the database. Adding a user to an Az group grants them all
the rights and privileges associated with that group. When a user is placed in more than
one group that user’s effective permissions are the logical "or" of the applicable
permissions of each group to which the user belongs. The following example
demonstrates how to create and list an existing Az group.
install_path\NetBackup\bin\admincmd\bpnbaz -AddGroup "New Group 1" -server test.domain.veritas.com
install_path\NetBackup\bin\admincmd\bpnbaz -ListGroups -server test.domain.veritas.com
Administrators
Operators
Security Administrators
Resource Management Applications
Applications
New Group 1 NBU_Unknown
NBU_User
NBU_Operator
NBU_Media Device Operator
NBU_Admin
NBU_Executive
NBU_Security Admin
195
bpnbaz
NBU_Database Agent Operator
NBU_Database Agent Administrator
Example 2
Deleting an Az group:
Deleting an az group from the authorization engine will results in all the members being
removed from the group. This operation is not reversible. Removing a group will revoke
the rights granted to members of the group. As such you can do yourself a great disservice
by deleting groups before careful thought goes into it.
install_path\NetBackup\bin\admincmd\bpnbaz -DelGroup "New Group 1" -server test.domain.veritas.com
install_path\NetBackup\bin\admincmd\bpnbaz -ListGroups -server test.domain.veritas.com
Administrators
Operators
Security Administrators
Resource Management Applications
Applications
NBU_Unknown
NBU_User
NBU_Operator
NBU_Media Device Operator
NBU_Admin
NBU_Executive
NBU_Security Admin
NBU_Database Agent Operator
NBU_Database Agent Administrator
Example 3
196
bpnbaz
Adding and removing users from Az groups (and Listing group members):
Users are added by creating a unique enterprise name of the following format:
<Authentication type>:<Domain to which user/group belongs>:<user/group name>
Supported Authentication types are:
◆
Nis - Network Information Services
◆
NisPlus - Network Information Services Plus
◆
Unixpwd - UNIX Password file on the Authentication server
◆
WINDOWS - Primary Domain Controller or Active Directory
◆
Vx - VERITAS Private database
install_path\NetBackup\bin\admincmd\bpnbaz -AddUser NBU_Operator nis:domain.veritas.com:ssosa -server test.domain.veritas.com
install_path\NetBackup\bin\admincmd\bpnbaz -ListGroupMembers NBU_Operator -server test.domain.veritas.com
==========
Type: User
Domain Type: nis
Domain:domain.veritas.com
Name: jdimaggio
==========
Type: User
Domain Type: nis
Name: ssosa
install_path\NetBackup\bin\admincmd\bpnbaz -DelUser NBU_Operator nis:domain.veritas.com:ssosa -server test.domain.veritas.com
install_path\NetBackup\bin\admincmd\bpnbaz -ListGroupMembers NBU_Operator -server test.domain.veritas.com
==========
Type: User
197
bpnbaz
Domain Type: nis
Name: jdimaggio
Example 4
Listing Applicable Permissions:
Using -ListPerms will show all applicable permissions for a given object or object type
within the database. This will help the user to create meaningful customizations to their
authorization.
install_path\NetBackup\bin\admincmd\bpnbaz -ListPerms -server test.domain.veritas.com
Object Type: Unknown
Browse
Object Type: Media
Browse
Read
New
Delete
Eject
. . . Restart
Synchronize
Object Type: PolicyGroup
Browse
Read
New
Delete
Activate
Deactivate
198
bpnbaz
Backup
Example 5
Listing Main Objects:
The -ListMainObjects option lists the current permissions for each group on each of
the main NetBackup objects. This is an informative view that can be used to verify
changes to permissions on an object. This show what permissions each group has within
the authorization system.
install_path\NetBackup\bin\admincmd\bpnbaz -ListMainObjects -server test.domain.veritas.com
. . .
NBU_RES_Policy:
Role: NBU_User
Unknown
Role: NBU_Media Device Operator
Browse
Read
Role: NBU_Executive
Read
Browse
Role: NBU_Database Agent Operator
Unknown
Role: NBU_Unknown
Unknown
Role: NBU_Operator
Browse
Read
Role: NBU_Admin
Browse
199
bpnbaz
New
Activate
Backup
Read
Delete
Deactivate
Role: NBU_Security Admin
Unknown
Role: NBU_Database Agent Administrator
Unknown
Role: Administrators
Unknown
Role: Operators
Unknown
Role: Applications
Unknown
Unknown
. . .
NBU_RES_Job:
Browse
Suspend
Cancel
Read
Resume
Delete
Role: NBU_Executive
Browse
Read
200
bpnbaz
Unknown
Role: NBU_User
Unknown
Role: NBU_Unknown
Unknown
Role: NBU_Operator
Browse
Suspend
Cancel
Read
Resume
Delete
Role: NBU_Admin
Browse
Delete
Resume
Read
Suspend
Cancel
Unknown
Unknown
Unknown
Role: Operators
Unknown
Role: Applications
Unknown
201
bpnbaz
Unknown
. . .
Example 6
Adding and deleting permissions from an object or policy:
Deletion deletes all permissions from an object for a given group. Add adds the
permissions specified for the given role to the object or policy in question.
install_path\NetBackup\bin\admincmd\bpnbaz -AddPerms Browse,Read,New,Delete -Group TestGroup1 -Object NBU_RES_Job -server test.domain.veritas.com
install_path\NetBackup\bin\admincmd\bpnbaz -ListMainObjects -server test.domain.veritas.com
NBU_RES_Unknown:
Role: NBU_User
. . .
NBU_RES_Job:
Browse
Suspend
Cancel
Read
Resume
Delete
Role: NBU_Executive
Browse
Read
202
bpnbaz
Unknown
Role: TestGroup1
Read
Delete
New
Browse
Role: NBU_User
Unknown
Role: NBU_Unknown
Unknown
Role: NBU_Operator
Browse
Suspend
Cancel
Read
Resume
Delete
Role: NBU_Admin
Browse
Delete
Resume
Read
Suspend
Cancel
Unknown
Unknown
Unknown
203
bpnbaz
Role: Operators
Unknown
Role: Applications
Unknown
Unknown
NBU_RES_Service:
Role: NBU_Unknown
. . .
install_path\NetBackup\bin\admincmd\bpnbaz -DelPerms -Group TestGroup1 -Object NBU_RES_Policy -server test.domain.veritas.com
Example 7
Specifies what servers can perform Authorization checks as well as viewing what servers
can perform Authorization checks. In addition, Disallows a server from performing
Authorization checks:
The -AllowAuthorization option specifies which machines are allowed to perform
authorization checks. The security administrator must specify which servers (Master or
Media) are permitted to examine the Authorization database to perform authorization
checks. The following examples demonstrate how to allow or disallow a machine to
perform authorization.
install_path\NetBackup\bin\admincmd\bpnbaz -AllowAuthorization butterball.domain.veritas.com -server test.domain.veritas.com
install_path\NetBackup\bin\admincmd\bpnbaz -ShowAuthorizers -server test.domain.veritas.com
==========
Type: User
Domain Type: vx
204
bpnbaz
Domain:[email protected]
Name: butterball.domain.veritas.com
install_path\NetBackup\bin\admincmd\bpnbaz -DisallowAuthorization butterball.domain.veritas.com -server test.domain.veritas.com
install_path\NetBackup\bin\admincmd\bpnbaz -ShowAuthorizers -server test.domain.veritas.com
Example 8
Initial security boot strapping:
The user must run the -SetupSecurity option as root on the Az server. The user must
then provide the login information for the first NetBackup Security administrator.
NOTE: Root on the system upon which the Az server is installed is always a security
administrator.
install_path\NetBackup\bin\admincmd\bpnbaz -SetupSecurity test.domain.veritas.com -server test.domain.veritas.com
Authentication port[ Enter = default]: Domain: domain.veritas.com
Name: ssosa
Password: Authentication type (NIS, NISplus, WINDOWS, vx, unixpwd: NIS
SEE ALSO
bpnbat
205
bpnbaz
bppficorr
NAME
bppficorr - lists persistent snapshot information found in the NetBackup catalog for a
specified client, and optionally deletes catalog entries for snapshots that no longer exist on
the client.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bppficorr [-media] [-hoursago hours] [-rotation] [-policy policy_name] -client client_name
DESCRIPTION
For the specified client, bppficorr lists the persistent snapshots currently found in the
NetBackup catalog. Without the -media option, bppficorr compares the catalog
information to the actual information on the client, and removes any entries in the catalog
that do not have corresponding snapshots on the client. This is useful if someone has
renamed or removed a snapshot on the client.
Note Persistent snapshots are managed by NetBackup. Do not rename or remove a
persistent snapshot; otherwise, the data cannot be restored.
The output of bppficorr goes to standard output.
You must have root privileges to execute this command.
OPTIONS
-media Lists all persistent snapshot entries found in the NetBackup catalog for
the client specified on the -client option. The list includes the backup IDs
and the media descriptions for each backup ID. See the NetBackup System
Administrator’s Guide for details on the media description.
-hoursago hours
Includes images written up to this many hours ago (1 or greater). The
default is all images.
-policy policy_name
NetBackup lists the persistent snapshot information found in the
NetBackup catalog for this policy for the specified client. The default is all
policies that include the client specified on the -client option.
206
bpnbaz
-client client_name
This is a required option. NetBackup lists the persistent snapshot
information found in the NetBackup catalog for this client. This name
must be as it appears in the NetBackup catalog. By default, bppficorr
searches for all clients.
NOTES
bppficorr writes activity log information to the /usr/openv/netbackup/logs/admin
directory. You can use the information in the directory for troubleshooting.
EXAMPLES
Example 1
To resynchronize the NetBackup catalog with a client’s actual snapshots:
install_path\NetBackup\bin\admincmd\bppficorr -client lupine
Example 2
To display the snapshots that are currently in the catalog for client lupine:
install_path\NetBackup\bin\admincmd\bppficorr -media -client lupine
Sample output:
Listing frozen image info from NBU catalog
-----------------------------------------backup_id
created
name
---------
-------
----
1 lupine_1034167036
Wed Oct
9 07:37:16 2002
1 vxvm:32:vxfs:/V1fs:/dev/vx/dsk/oradg/PFI-V1_1034167036
2 lupine_1033995680
Mon Oct
7 08:01:20 2002
1 vxfs_pfi:34:vxfs:/ora8data:VX+NBU+PFI+ORA+2002.10.07.08h01m20s
3 lupine_1033880459
Sun Oct
6 00:00:59 2002
1 vxfs_pfi:34:vxfs:/V1fs:VX+NBU+PFI+FS+2002.10.06.00h00m59s
FILES
install_path\NetBackup\logs\
207
bpplclients
bpplclients
NAME
bpplclients - Administer the clients within NetBackup policies
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpplclients
install_path\NetBackup\bin\admincmd\bpplclients [policy_name |
-allunique [-pt policy_type]] [-L | -l | -U | -noheader]
[-M master_server,...] [-v]
install_path\NetBackup\bin\admincmd\bpplclients policy_name [-M
master_server,...] [-v] -add host_name hardware os [priority]
master_server,...] [-v] -delete host_name ...
master_server,...] [-v] -modify host_name [-hardware
hardware] [-os os] [-priority priority]
install_path\NetBackup\bin\admincmd\bpplclients policy_name -rename
old_client_name new_client_name [-os os] [-hardware hardware]
DESCRIPTION
bpplclients will do one of the following:
◆
Produce a listing of clients.
◆
Add a new client to a policy.
◆
Delete a list of clients from a policy.
◆
Modify an existing client in a policy.
For the -add, -delete, and -modify options, bpplclients returns to the system
prompt immediately after it submits the client change request to NetBackup. To
determine whether the change was successful, run bpplclients again to list the
updated client information.
When the listing option is used, the list is ordered alphabetically by client name. Each
client entry is on a single line, and there is a single entry for each client.
208
bpplclients
OPTIONS
The options used with bpplclients depend on the form of bpplclients being used.
The first form of bpplclients has no options and produces a listing of information
about the clients for all policies.
The second form of bpplclients produces a listing of information about the clients for a
single policy or for all policies. The following options apply to this form:
policy_name | -allunique [-pt policy_type]
policy_name specifies the name of a policy and lists client information
only for the policy with this name.
-allunique without [-pt policy_type] lists client information for all policies defined for NetBackup on the master server. If you use -allunique -pt policy_type, where policy_type is a specific policy type (such as Sybase), the command lists the client information only for the clients that belong to that type of policy.
If the command line contains neither the policy_name nor -allunique
option, the listing contains client information for all policies.
These options, if used, must be the first option on the command line.
-L
List in long format. There is no two-line header at the top of the listing;
the header is embedded in the line for each client. The line for each client
includes the following fields:
Client/HW/OS/Pri: (the header)
Client name
Hardware type
Operating system
Priority
There are also four additional fields which can be ignored. These fields
are either unused or used for internal processing.
-l List in short format; this produces a terse listing and is also called raw
output mode. There is no two-line header at the top of the listing; the
header is embedded in the line for each client. The line for each client
includes the following fields:
CLIENT (the header)
Client name
Hardware type
Operating system Priority Chapter 1, NetBackup Commands
209
bpplclients
There are also four additional fields which can be ignored. These fields
are either unused or used for internal processing.
This option is useful for scripts or programs that rework the listing contents into a customized report format.
-U List in user format. The listing consists of one line for each client,
containing the hardware type, operating system, and client name. A
two-line header begins the listing. This is the default format for the
listing.
-noheader
List without any header. The listing consists of one line for each client,
containing the hardware type, operating system, and client name.
A list of alternative master servers. This is a comma-delimited list of host
bpplclients command. Each master server in the list must allow
access by the system issuing the bpplclients command. If an error
occurs for any master server, processing stops at that point.
If bpplclients is producing a listing, the listing is the composite of the
information returned by all the master servers in this list.
If bpplclients is adding, deleting, or modifying a client (explained
later), the change is made on all the master servers in this list.
-v
Selects verbose mode. This option causes bpplclients to log additional
The next three forms of bpplclients affect one or more clients in a single policy. The
client will be added, deleted, or have its attributes modified within the policy. This form of
bpplclients uses the following options:
policy_name
Change the client information for this policy. This option must be the first
option on the command line.
Explained earlier. This option must precede the -add, -delete, or
-modify option on the command line.
-v
Explained earlier. This option must precede the -add, -delete, or
-modify option on the command line.
210
bpplclients
Note The next three options, -add, -delete, and -modify, determine the change that
bpplclients makes to the clients for the policy. Any of these options, with its
accompanying client information, must be the final option on the command line.
Only one of these options can be used at a time.
-add host_name hardware os [priority]
Add a client to the policy. If the local system already has the maximum
number of clients defined, an error is returned. The installation default
for the maximum number of clients is unlimited for NetBackup
Enterprise Server and 4 for NetBackup Server. Specify the host name,
hardware type, and operating system (see the definitions below). (priority
is not implemented at this time)
-delete host_name ...
Delete one or more clients from the policy. Up to twenty clients can be
deleted at a time. The clients are provided as a space-delimited list of host
names.
-modify
host_name ...
Modify the attributes for a client within a policy. The client has been
added to the policy previously. The attribute values that follow the client
name replace the previous equivalent attribute values for this client. At
least one of the client’s attributes must be modified. -priority is not
implemented at this time.
-hardware hardware
The hardware type of this client. Use one of the hardware types as
displayed in the dialog box used for adding clients to a policy with the
Backup Policy Management utility.
-os os
The operating system of this client. Use one of the operating systems as
displayed in the dialog box used for adding clients to a policy with the
Backup Policy Management utility.
The values chosen for the hardware and os options must form a valid
combination.
-priority priority
Not implemented.
The following form of bpplclients changes the name of the client in a policy and can
also change the operating system and hardware type that is specified for the client. This
form of bpplclients uses the following options:
policy_name
The policy that has the client. This option must be the first option on the
command line.
211
bpplclients
-rename old_client_name new_client_name
old_client_name specifies the current name of the client and new_client_name specifies the new name.
-hardware hardware
Specifies a different hardware type for the client. Use one of the hardware
types as displayed in the dialog box used for adding clients to a policy
with the Backup Policy Management utility.
-os os
Specifies a different operating system for the client. Use one of the
operating systems as displayed in the dialog box used for adding clients
to a policy with the Backup Policy Management utility.
The values chosen for the hardware and os options must form a valid
combination.
EXAMPLES
Example 1
While running on the master server, list the clients known to the master server.
bpplclients
The output returned will look like the following:
Hardware
--------------Novell
Windows
HP9000
PC
OS
--------------Novell 5.1
Windows
HP-UX 11.0
Windows
Client
-------------marge
marmot
squash
tigers
This command could also be entered on a client of hatt, with the same results.
Example 2
List the clients defined for the policy onepolicy:
bpplclients onepolicy
Hardware
OS
--------------- --------------Sun
Solaris8
IBM
AIX
HP9000
HP-UX 11.0
SGI
IRIX6.5.23
Tru64-Alpha
TRU 5.1b
Sun
Solaris8
HP9000
HP-UX
Client
-------------jeckle
streaky
chilly
yak
alpha
heckle
shark
Example 3
212
bpplclients
Add the client marmot to the policy twopolicy on the master servers serv1 and serv2.
marmot’s hardware type is HP9000, and marmot’s operating system is HP-UX 11.0. The
default priority is used. (the command is all on one line)
bpplclients twopolicy -M serv1,serv2 -add marmot HP9000 HP-UX 11.0
Example 4
Delete the clients marmot and vole from the policy twopolicy on the master servers serv1
and serv2. (the command is all on one line)
bpplclients twopolicy -M serv1,serv2 -delete marmot vole
Example 5
While running on the master server hatt, list client information for policy BackTrack on
the master server beaver:
bpplclients BackTrack -M beaver
Hardware
OS
--------------- --------------Sun
Solaris8
Client
-------------saturn
Example 6
Assume you have a policy called my_policy that has 1 client defined. The client name is
pear, the operating system is Solaris2.6, and the hardware type is Solaris.
bpplclients my_policy -rename pear apple -os MacOS \
-hardware MACINTOSH
This command changes the client name pear in my_policy to apple. It also changes the os
from Solaris to MacOS and hardware from Solaris to Macintosh.
RETURN VALUES
bpplclients: EXIT status = exit status
213
bpplclients
FILES
install_path\NetBackup\db\policy\policy_name\clients
SEE ALSO
bpplinfo
214
bppldelete
bppldelete
NAME
bppldelete - Delete policies from the NetBackup database.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bppldelete policyname
[-verbose] [-M master_server,...master_server]
DESCRIPTION
bppldelete deletes policies from the NetBackup database.
OPTIONS
-M master_server,...master_server
Delete policy information for a specific master server(s). For example, to
delete policy MWF_PM from master server Saturn, enter:
bppldelete MWF_PM -M Saturn
-verbose
Select verbose mode for logging.
policyname
Specifies the policy to remove from the NetBackup database.
215
bpplinclude
bpplinclude
NAME
bpplinclude - Maintain the list of files automatically backed up by a NetBackup policy.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpplinclude policy_name [-v]
[-M master_server,...] -L | -l
[-M master_server,...] -add path_name ...
[-M master_server,...] -add -f filename
[-M master_server,...] -delete path_name
[-M master_server,...] -delete -f filename
[-M master_server,...] -modify {old_path_name
new_path_name} ...
DESCRIPTION
bpplinclude maintains the policy file list for a NetBackup policy. This is the list of files
backed up when NetBackup runs an automatic backup for the policy. The policy file list
does not apply to user backups or archives since users select the files when they start
those operations.
bpplinclude performs one of the following operations:
◆
Adds pathnames to the policy file list
◆
Deletes pathnames from the policy file list
◆
Modifies pathnames in the policy file list
◆
Displays the policy file list for a policy
The -add, -delete, and -modify options include a list of pathnames. The list of
pathnames must be the final part of the bpplinclude command line. The pathname
must be the entire path from the root of the file system to the desired location. For the
absolute pathname syntax for your client type, refer to the File-Path Rules topics in the
NetBackup System Administrator’s Guide. The last part of the path can be a filename, a
directory name, or a wildcard specification. You can enclose pathnames in quotes. Use
enclosing quotes if the pathname contains special characters or a wildcard specification.
216
bpplinclude
File-Path Rules for does not verify the existence of the input directories or files.
NetBackup backs up only the files it finds and does not require that all entries in the list be
present on every client.
See the NetBackup System Administrator’s Guide for additional information on policy file
lists.
For database extensions, the input entries are scripts. NetBackup runs these during the
backup. See the NetBackup guide that comes with the extension product for additional
information.
For certain policy attributes (such as Allow Multiple Data Streams) and extension
products (such as NetBackup for NDMP), the entries added to the policy file list may be
directives, rather than pathnames. Refer to the NetBackup System Administrator’s Guide or
the NetBackup guide for the extension product.
The options -l and -L produce nearly identical displays of the policy file list.
bpplinclude sends its error messages to stderr. bpplinclude sends a log of its
activities to the NetBackup admin log file for the current day.
OPTIONS
-add path_name
Add these path_names to the policy file list. A pathname must be
enclosed in quotes (") if it contains special characters, such as blank(" "), or
a wildcard specification. Use a blank to separate two pathnames, not a
comma. bpplinclude interprets a comma as part of the pathname. This
means that bpplinclude concatenates two or more comma-delimited
pathnames into a single pathname with embedded commas.
bpplinclude does not verify the syntax or the existence of the
pathnames. This option must be the final entry on the command line.
-adds -f filename
Add the file listed in "filename" to policy file list.
-delete path_name
Delete these path_names from the policy file list. Refer to -add for the
pathname-list syntax. Deleting a pathname from the policy file list does
not prevent you from recovering any backups or archives for that
pathname. This option must be the final entry on the command line.
will add the files listed in "filelist_filename" file to policy file list.
217
bpplinclude
-delete -f filename
Deletes the file listed in "filename" from the policy file list.
-help
the command line.
-L
Display the contents of the policy file list in long format.
-l
Display the contents of the policy file list in compact format.
Note The -l and -L displays are similar.
-modify {old_path_name new_path_name}
Modify an entry in the policy file list. The values are a list of pathname
pairs {old_path_name new_path_name}. For each pathname pair,
new_name_path replaces old_name_path in the policy file list. If no list
entry matches old_path_name, then new_path_name is not entered into
the policy file list. Refer to the -add option for the pathname syntax.
Delimit the list entries with spaces, both within a pathname pair and
between pathname pairs. This option must be the final entry on the
command line.
-v
install_path\NetBackup\logs\admin is defined).
OPERANDS
policy_name
Specifies the policy for which the policy file list is to be set.
EXAMPLES
Example 1
While running on another master server kiwi, display the policy file list for policy
oprdoc_policy on the master server plim:
218
bpplinclude
bpplinclude oprdoc_policy -L -M plim
Include:
c:\oprdoc
Example 2
Illustrate bpplinclude's interpretation of wildcards by adding and deleting pathnames
that include one wildcard entry:
bpplinclude mkbpolicy
Include: C:\yap
Include: C:\y*
Include: C:\yap
-add C:\yap C:\y*
-L
-delete C:\y*
-L
Note The wildcard entry C:\y* for -delete is not interpreted by bpplinclude as
meaning that both C:\yap and C:\y* should be deleted. Only C:\y* is deleted
from the include list for mkbpolicy. The interpretation of the wildcard occurs when
NetBackup is selecting files to be backed up, during the actual backup.
Example 3
Add two entries to the policy file list for a policy, and then modify them:
bpplinclude mkbpolicy -add "C:\ima file" "C:\ura file"
bpplinclude mkbpolicy -L
Include: C:\ima file
Include: C:\ura file
bpplinclude mkbpolicy -modify "C:\ima file" "C:\ima file 2" "C:\ura file" "C:\ura file 2"
bpplinclude mkbpolicy -L
Include: C:\ima file 2
Include: C:\ura file 2
Example 4
Add a raw partition to the policy file list for the policy rc (UNIX clients). The full path
name for the device is used (the command is all on one line):
bpplinclude rc -add /devices/sbus@2,0/dma@2,81000/esp@2,80000/sd@6,0:h,raw
(see the Adding Unix Raw Partitions to the File List section of the NetBackup System
Administrator’s Guide).
Example 5
Display the policy file list for the policy mkb_policy:
bpplinclude mkb_policy -l
INCLUDE C:\services
INCLUDE C:\aliases
219
bpplinclude
INCLUDE C:\Programs
RETURN VALUES
bpplinclude: EXIT status = exit status
FILES
install_path\NetBackup\dv\policy\policy_name\includes
SEE ALSO
bpplclients, bpplinfo, bpschedule, bppldelete, bppllist
220
bpplinfo
bpplinfo
NAME
bpplinfo - Manage or display policy attributes for NetBackup.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpplinfo policy_name
-U [-v] [-M master_server,...]
-L | -l |
install_path\NetBackup\bin\admincmd\bpplinfo policy_name -set |
-modify [-v] [-active | -inactive] [-blkincr flag]
[-collect_tir_info value] [-compress flag]
[-collect_bmr_info flag] [-crossmp flag] [-disaster flag]
[-ef effective_time] [-encrypt flag] [-follownfs flag]
[-keyword "keyword phrase"] [-M master_server,...]
[-multiple_streams flag] [-policyjobs max_jobs] [-pool
label] [-priority flag] [-pt policy_type] [-residence label]
[-rfile flag] [-ut] [-chkpt [1|0]] [-chkpt_intrvl
interval]
install_path\NetBackup\bin\admincmd\bpplinfo policy_name
-help
DESCRIPTION
bpplinfo initializes, modifies, or displays the attribute values for a NetBackup policy.
OPTIONS
The options used with bpplinfo depend on the form of bpplinfo being used.
The first form of bpplinfo displays a policy. The following options apply to this form:
policy_name -L | -l | -U
List information for this policy. This is a required option.
-L specifies a long list type and produces a listing with one policy
attribute per line, in the format policy_attribute: value. The value may be
expressed both in numeric and name form. Fields in the list include:
Policy Type
Active
Follow NFS Mounts (applies only to NetBackup Enterprise Server)
Cross Mount Points
Client Compress
221
bpplinfo
Collect TIR Info
Policy Priority
Ext Security Info
File Restore Raw
Client Encrypt
Max Jobs/Policy
Mult. Data Stream
Snapshot
Backup Copy
Disaster Recovery
Collect BMR Info
Max Frag Size
Residence
Volume Pool
-l specifies a short list type and produces a terse listing. This option is
useful for scripts or programs that rework the listing contents into a
customized report format. A short listing contains the following
information for the specified policy:
Line 1: "INFO", client_type, follow_nfs_mounts, client_compress, priority,
proxy_client, client_encrypt, disaster recovery, max_jobs_per_policy,
cross_mount_points, max_frag_size, active, collect_tir_info, block_incr,
ext_sec_info, i_f_r_f_r, streaming, frozen_image, effective_date, policy ID,
collect_bmr_info
Line 2: "KEY",keyword
Line 3: "BCMD",backup_command
Line 4: "RCMD",restore_command
Line 5: "RES", residence
Line 6: "POOL", pool
Line 7: "FOE", this field is not used
-U specifies a user list type and produces a listing with one policy
attribute per line, in the format policy_attribute: value. This listing is
similar to the -L listing, but contains fewer fields.
-v
Selects verbose mode. This option causes bpplinfo to log additional
222
bpplinfo
hostnames. If this option is present, each master server in the list runs the bpplinfo command. Each master server in the list must allow access by the system issuing the bpplinfo command. If an error occurs for any master server, processing terminates at that point. For the display form of bpplinfo, the report is the composite of the
information returned by all the master servers in this list. bpplinfo
queries each of these master servers. The master server returns
information from its policy catalog.
For the policy-definition form of bpplinfo, the policy is created or modified on each master server in the list.
The default is the master server for the system running bpplinfo.
The second form of bpplinfo initializes attribute values for a policy or modifies the
attribute values for a policy. The following options apply to this form:
Note Not all options apply to every policy type. For instance, if the policy type is
MS-Windows, bpplinfo accepts the options -compress and -crossmp. When
bpplinfo completes, it returns a zero status. However, NetBackup’s subsequent
handling of the policy with the MS-Windows policy type is as though the options
had not been set.
-active | -inactive
Set the policy to active or inactive. If the policy is active, NetBackup runs
all its automatic schedules and permits user-directed backups and
archives to be used. A policy must be active for an automatic backup to
occur. This is the default.
If the policy is inactive, NetBackup does not run any automatic schedules
or permit user-directed schedules to be used. This option is useful for
temporarily inactivating a policy to prevent schedules from being used.
-blkincr flag
Note This option applies only if you are running NetBackup Enterprise Server and also
have VERITAS Oracle Edition, which supports block-level incrementally.
0 (disabled) or 1 (enabled). Perform block-level-incremental backups for
clients in this policy.
If 1, do perform block-level-incremental backups.
If 0, do not perform block-level-incremental backups.
223
bpplinfo
-chkpt [1|0]
Enables and disables the checkpoint restart for the policy. If 1, the
command enables the checkpoint restart. If 0, the command disables the
checkpoint restart. The default is 0.
-chkpt_intrvl interval
Enables and disables the checkpoint interval for the policy. The variable
interval is the checkpoint interval in minutes. The default interval is 15
minutes. The range for this interval is between 5 and 180 minutes. If the
checkpoint restart is not enabled, then this parameter has no effect.
-collect_tir_info value
Collect true-image-recovery (TIR) information. True-image recovery
allows NetBackup to restore a directory to exactly what it was at the time
of any scheduled full or incremental backup. Files deleted before the time
of the selected backup are not restored. After enabling this attribute,
NetBackup starts collecting additional information beginning with the
next full or incremental backup for the policy.
If 0, NetBackup does not keep track of true-image-recovery information.
If 1, NetBackup collects TIR information.
If 2, NetBackup collects TIR information and tracks client files.
-collect_bmr_info flag
Collect Bare Metal Restore information.
If flag is 0, do not collect Bare Metal Restore information.
If flag is 1, collect Bare Metal Restore information.
If -collect_bmr_info is set to 1 and Bare Metal Restore is not licensed or the policy type is not Standard or MS-Windows, bpplinfo will fail.
If -collect_bmr_info is set to 1 but the policy does not collect true image restore information with move detection, Bare Metal Restore will
ignore incremental backups and restore files from the last full backup.
-compress flag
0 (disabled) or 1 (enabled). Specifies whether to compress files or not. If
1, the files selected are compressed by the client software onto the media.
Compression may increase total backup time. If 0, the files are not
compressed onto the media. This is the default.
This option has no effect on the hardware compression that may be
available on the storage unit.
-crossmp flag
0 (disabled) or 1 (enabled). Specifies whether to cross mount points
during backups or not.
If 1, NetBackup backs up or archives all files and directories in the
selected path regardless of the file system on which they reside.
224
bpplinfo
If 0, NetBackup backs up or archives only those files and directories that
are on the same file system as the selected file path. This is the default.
This attribute can affect the Follow NFS policy attribute, which applies
only to NetBackup Enterprise Server. Refer to the NetBackup system
administrator’s guide for more details.
-disaster 0|1
Collect information required for intelligent disaster recovery. This
attribute applies only when you back up Windows clients.
0 = Do not allow disaster recovery (Default)
1 = Allow disaster recovery
-ef effective time
This time specifies the time the policy will be active.
-encrypt flag
0 (disabled) or 1 (enabled). Specifies whether files should be encrypted
or not.
If 1, encryption is enabled.
-follownfs 0|1
Note The following nfs option applies only to NetBackup Enterprise Server
0 (disabled) or 1 (enabled). Specifies whether to follow NFS mount points or not. For policy types MS-Windows and OS/2, setting this flag
affects the policy attribute Backup Network Drives instead of the Follow
NFS attribute.
If 1, NetBackup backs up or archives any NFS-mounted files
encountered.
If 0, NetBackup does not back up or archive any NFS-mounted files encountered. This is the default.
The behavior of this attribute varies somewhat depending on the setting
of the Cross Mount Points attribute. Refer to the NetBackup System
Administrator’s Guide for more details. -keyword "keyword phrase"
The value will be associated with all backups created using this policy.
The keyword phrase can be used to link related policies. It can also be
used during restores to search only for backups that have the keyword
phrase associated with them.
Same as explained earlier.
225
bpplinfo
-multiple_streams flag
0 (disabled) or 1 (enabled). Allow Multiple Data Streams.
If 1, allow multiple data streams.
If 0, do not allow multiple data streams.
policy_name -set | -modify
Initialize or modify attributes for this policy. This is a required option.
-set initializes (or reinitializes) attributes for the policy to their default
values, except for those attributes set by options on the current command
line.
-modify modifies attributes for the policy. Attributes that are not
explicitly set by options on the current command line do not change their
values.
-pool label
Specifies the volume pool for the policy. The default is NetBackup. The
volume pool should be one of the volume pools for the policy storage
unit. This attribute is not relevant if a disk storage unit is the residence
for the policy. If the policy storage unit is Any_available (Residence:
appears on the bpplinfo display), the volume pool for any storage unit
can be selected. If "*NULL*" is specified, the volume pool is set to
NetBackup. To display the configured volume pools, run
install_path\Volmgr\bin\vmpool -listall.
-policyjobs max_jobs
The maximum number of concurrent jobs that NetBackup allows for this
policy (corresponds to the Limit Jobs per Policy setting in the
administration interface). max_jobs is always greater than or equal to 0.
For the default or when -policyjobs is 0, bpplinfo sets max_jobs to a
value that corresponds to unlimited. The effective maximum number of
jobs in this instance is 8 for NetBackup and 2003 for NetBackup
Enterprise Server.
-priority flag
The priority of this policy in relation to other policies. Priority is greater
than or equal to 0. This value determines the order in which policies are
run. The higher the value, the earlier the policy is run. The default is 0,
which is the lowest priority.
-pt policy_type
Specify the policy type by entering one of the following character strings
(the default is Standard):
Informix-On-BAR
MS-Exchange-Server
MS-SQL-Server
226
bpplinfo
MS-Windows
NDMP
NetWare
Oracle
OS/2
Standard
Sybase
AFS
DB2
FlashBackup
SAP
Split-Mirror
-residence label
Specifies the label of the storage unit for storing the backups created
according to this schedule. The default is Any_available. This allows the
policy to use any storage unit which has the attribute On Demand Only?
set to No. If the policy needs to use a specific storage unit or the storage
unit desired has the attribute On Demand Only? set to Yes, then specify
the storage unit. If "*NULL*" is specified, the residence for the schedule is
set (or reset) to Any_available. The policy residence determines the
residence for the policy schedules, unless the Override Policy Storage
Unit setting on an individual schedule specifies a residence. Run
bpstulist to display the set of defined storage units..
-rfile flag
0 (disabled) or 1 (enabled).
If 1, allow Individual File Restore From Raw.
If 0, do not allow Individual File Restore From Raw.
For a FlashBackup policy, this option is ignored, since the attribute is
always enabled.
NOTE: Advanced Client is available only if you are running NetBackup Enterprise Server and have the separately-priced option.
-ut
Any of the date/time arguments that follow -ut will be accepted as
UNIX time, instead of the standard time format. The -ut option is used
primarily for Java.
227
bpplinfo
The third form of bpplinfo (not shown in the synopsis) shows usage information and
has only one option as follows:
-help
the command line.
EXAMPLES
Note References to NFS Mounts in the following examples apply only to NetBackup
Enterprise Server.
Example 1
To set the storage unit of the policy tstpolicy to tstunit and view the results, perform the
following:
bpplinfo tstpolicy -modify -residence tstunit
bpplinfo tstpolicy -L
Policy Type:
Standard (0)
Active:
no
Effective:
no
Follow NFS Mounts: no
Cross Mount Points: no
Client Compress:
no
Collect TIR Info:
no
Policy Priority:
0
Ext Security Info: no
File Restore Raw:
no
Client Encrypt:
no
Max Jobs/Policy:
8
Mult. Data Streams: 1
Block Level Incremental: no
Perform Snapshot Backup: no
Backup Copy:
0
Date Mover Type:
2
Use Alternate Client:
no
Alternate Client Name:
(none)
Enable Instant Recovery: no
Disaster Recovery: 0
Collect BMR Info:
no
Max Frag Size:
0 MB (1048576 MB)
Checkpoint Restart: no
Residence:
tstunit Volume Pool:
NetBackup Example 2
228
bpplinfo
To set the attributes of policy tstpolicy back to their default values, perform the following:
bpplinfo tstpolicy -set
bpplinfo tstpolicy -L
Policy Type:
Standard (0)
Active:
yes
Follow NFS Mounts: no
Client Compress:
no
Collect TIR Info:
no
Policy Priority:
0
Ext Security Info: no
File Restore Raw:
no
Client Encrypt:
no
Multiple Streams:
0
Max Jobs/Policy:
8
Collect BMR Info:
no
Max Frag Size:
0 MB (1048576 MB)
Residence:
-
Volume Pool:
NetBackup
Example 3
The following is an example of a short listing for the policy named mkbpolicy:
bpplinfo mkbpolicy -l
INFO 0 0 0 0 *NULL* 0 0 99 0 0 0 0 0 0 0 0 *NULL* 1
KEY my temp directory
BCMD *NULL*
RCMD *NULL*
RES mkbunit *NULL* *NULL* *NULL* *NULL* *NULL* *NULL* *NULL* *NULL*
POOL NetBackup *NULL* *NULL* *NULL* *NULL* *NULL* *NULL* *NULL* *NULL*
FOE 0 0 0 0 0 0 0 0 0 0
FILES
install_path\NetBackup\logs\admin/*
install_path\NetBackup\db\policy\policy_name\info
229
bppllist
bppllist
NAME
bppllist - List policy information.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bppllist [policyname] [-L | -l |
-U] [-allpolicies] [-M master_server,...,master_server]
[-hwos] [-byclient client] [-keyword ”keyword
phrase”][-verbose]
DESCRIPTION
bppllist lists policies within the NetBackup database.
OPTIONS
-allpolicies
Lists all policies.
-hwos
Lists possible hardware and the operating system.
-L
Displays a full listing.
-l
Displays information in raw output mode.
Lists policy information for a specific master server(s).
-U
Displays information in the style used by xbpadm.
-byclient client
Lists policy information for all policies containing the client indicated.
-keyword ”keyword phrase”
The value will be associated with all backups created using this policy.
The keyword phrase can be used to link related policies. It can also be
used during restores to search only for backups that have the keyword
phrase associated with them.
230
bppllist
policyname
Specifies the policy in the NetBackup database.
-verbose
Select verbose mode for logging.
231
bpplsched
bpplsched
NAME
bpplsched - Add, delete, or list NetBackup schedules.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpplsched policy_name [-v] [-M
master_server...] [-L | -l | -U] [-label sched_label]
master_server...] -delete sched_label ...
master_server...] -deleteall
master_server...] -add sched_label [-st sched_type] [-freq
frequency] [-mpxmax mpx_factor] [-number_copies number]
[-synthetic 0|1] [-pfi_fast_recovery 0|1] [-rl
retention_level[,rl-copy2,...,rl-copyn]] [-residence
storage_unit_label[,stunit-copy2,...stunit-copyn]] [-pool
volume_pool_label[,pool-copy2,...pool-copyn]]
[-fail_on_error 0|1[,0|1,...,0|1]] [-window
start_duration] [-cal 0|1|2] [-ut] [-incl mm/dd/yyyy]
[-excl mm/dd/yyyy] [-weekday day_name_week] [-dayomonth
1-31 or l]
DESCRIPTION
bpplsched will do one of the following:
◆
Add a new schedule to a policy.
◆
Delete one or more schedules from a policy.
◆
Delete all the schedules from a policy.
◆
List one or all schedules in a policy.
For the -add and -delete options, bpplsched returns to the system prompt
immediately after it submits the schedule change request to NetBackup. To determine
whether the change was successful, run bpplsched again to list the updated schedule
information.
When the listing option is used there is a single entry for each schedule, even if the -M
option is used. The -l form lists the information for each schedule on several lines. -l
does not identify the attributes by name; these are as follows (where the names are not
described, they are reserved for internal NetBackup use):
232
bpplsched
Line 1: SCHED, schedule name, type, max_mpx, frequency, retention level, u_wind/o/d,
2 internal attributes, maximum fragment size, calendar, number of copies, and fail on
error. Note that u_wind/o/d is a field reserved for future use. This is also true for the
u_wind entry in the -L display.
Line 2: SCHEDWIN, seven pairs of the form start,duration, expressing the start and
duration of the window for each day of the week, starting with Sunday.
Line 3: SCHEDRES, residence (a value for each copy).
Line 4: SCHEDPOOL, pool (a value for each copy).
Line 5: SCHEDRL, retention level (a value for each copy).
Line 6: SCHEDFOE, fail on error (a value for each copy).
If the -M option is used, bpplsched performs the operation on each of the master servers
listed. For instance, if bpplsched is adding a schedule, bpplsched adds the schedule to
the policy on each of the master servers listed for -M. If the -M option is used on a listing
request, the listing is the composite of the information returned by all of the master
servers in the -M list. If the command fails for any of the master servers, activity stops at
that point.
To modify an existing NetBackup schedule, use the NetBackup command
bpplschedrep.
OPTIONS
These options are common to all forms of bpplsched:
policy_name
The name of the policy that contains the schedules. The policy must exist
before running this command. This option is required, and must be the
first one on the command line.
-help
the command line.
A list of alternative master servers. This is a comma-separated list of host
bpplsched command. Each master server in the list must allow access
by the system issuing the bpplsched command.
233
bpplsched
If this option is present, the command is run on each master server in the
list. If an error occurs for any master server, processing terminates at that
point.
If bpplsched is producing a listing, the listing is the composite of the
If bpplsched adds or deletes a schedule, all master servers in this list
receive the change.
-v
Selects verbose mode. This option causes bpplsched to log additional
NetBackup administration debug log. This option is meaningful only
when NetBackup has debug logging enabled
The remaining options depend on the form of bpplsched. The first form of bpplsched
adds a schedule to the named policy. The following options apply to this form of
bpplsched:
-add sched_label [suboptions]
Add a single schedule to the named policy. The suboptions for the -add option explained below. These are attributes
of the schedule being added. Refer to the NetBackup System
Administrator’s Guide for details on schedules and their attributes.
-cal 0|1|2
Indicates whether bpplschred is following a calendar-based schedule
or a frequency-based schedule.
0 = frequency-based schedule
1 = calendar-based schedule with no retries after run day
2 = calendar-based schedule with retires after run day
-dayomonth 1-31 | l
Specifies the day of every month to run the schedule. Enter l (lowercase
L) to run the last day of every month, whether the month contains 28, 29,
30, or 31 days.
For example, to run the schedule the 15th day of every month, enter:
-dayomonth 15
To run the last day of every month, enter:
-dayomonth l
-excl mm/dd/yyyy
Indicates to exclude this single date.
234
bpplsched
-fail_on_error 0|1[,0|1,...,0|1]
Specifies whether to fail all other copies if one copy fails. If no parameter
is specified, 0 is default for all copies. Specify a value for each copy.
-freq frequency
Determines how often backups run. Represents the number of seconds
between backups initiated according to this schedule. Valid range for this
option is 0 through 2419200 (number of seconds in four weeks). When
omitted on the command line, the default value is 604800 (duration of one
week in seconds).
-incl mm/dd/yyyy
Indicates to include this single date.
-mpxmax mpx_factor
This is the maximum number of jobs for this schedule that NetBackup
will multiplex on any one drive. mpx_factor is an integer that can range
from 1 through 8 for NetBackup Server and 1 through 32 for NetBackup
Enterprise Server. A value of 1 means that backups for this schedule are
not multiplexed. The default is no multiplexing.
Specify the number of simultaneous backup copies. The minimum value
is 1. The maximum value is 4 or the Maximum Backup Copies global
parameter, whichever is smaller. The default is 1.
-pfi_fast_recovery 0|1
Enables the user to turn on the feature to retain snapshots for Instant
Recovery. The default value is 0, meaing this feature is disabled. A value
of 1, enables this feature.
-pool volume_pool_label[,pool-copy2,... pool-copyn]
This is the name of the volume pool. This choice overrides the
policy-level volume pool. Entering "*NULL*" causes NetBackup to use
the volume pool specified at the policy level. The default is to use the
volume pool specified at the policy level. The volume pool label cannot
be None. If you do not specify a volume pool at either the schedule level
or the policy level, NetBackup uses a default value of NetBackup.
When specifying -number_copies greater than 1, specify a pool for
each copy.
-residence storage_unit_label[,stunit-copy2,... stunit-copyn]
This is the name of the storage unit, which specifies the location of the
backup images. The value "*NULL*" causes NetBackup to use the storage
unit specified at the policy level. The default is for NetBackup to use the
235
bpplsched
storage unit specified at the policy level. If you do not specify a storage
unit at either the schedule level or the policy level, NetBackup uses the
next storage unit available.
When specifying -number_copies greater than 1, specify a residence
for each copy.
-rl retention_level[,rl-copy2,..., rl-copyn]
The retention level determines how long to retain backups and archives.
The retention_level is an integer between 0 and 24. The default retention
level is 1. Valid retention levels and their corresponding default retention
times are listed below.
When specifying -number_copies greater than 1, specify a retention
level for each copy.
CAUTION: Because the retention period associated with each level can be
changed by using the NetBackup administration interface, your
configuration may have different values for each level than those shown
here. Use the NetBackup administration interface to determine the actual
retention periods before making any changes with this command.
Otherwise, backups could expire sooner than you expect, resulting in loss
of data.
0
1 week
1
2 weeks
2
3 weeks
3
1 month
4
2 months
5
3 months
6
6 months
7
9 months
8
1 year
9 - 24 infinite
-st sched_type
This is the type of the schedule. The default schedule type is FULL. Here
are the possible values, with their meanings, for this attribute:
FULL - full
INCR - differential incremental
CINC - cumulative incremental
UBAK - user backup
UARC - user archive
236
bpplsched
-synthetic 0|1
Enables the user to determine which schedule is going to occur. A value
of 0 (the default value) means the schedule is a real (non-synthetic)
backup schedule. A value of means the schedule is a synthetic backup
schedule.
-ut
primarily for Java.
-weekday day_name week
Specifies a day of the week, and the week of the month, as a run day in
the schedule. The day_name is: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday. The week is the number of the week in the month.
For example, to instruct the policy to run the second Monday of the month, enter:
-weekday Monday 2
-window start duration
Specifies when NetBackup can run the backups for this schedule. Every
day of the week has the same window.
start is the time at which the backup window opens for this schedule. This is the number of seconds since midnight. This is an integer between
0 and 86399 (there are 86400 seconds in a day).
duration is the length of time that the window remains open. The time
unit is seconds. This is a non-negative integer.
The second form of bpplsched deletes one or more schedules from the named policy.
The following option applies to this form of bpplsched:
-delete sched_label
Delete the listed schedules from the named policy. The elements of the
sched_label list must be separated by spaces. There can be up to 25 labels
in the list.
The third form of bpplsched deletes all schedule from the named policy. The following
option applies to this form of bpplsched:
-deleteall Delete all schedules from the named policy.
The fourth form of bpplsched produces a listing of information about the schedules for
the named policy. The following options apply to this form of bpplsched:
237
bpplsched
-l The list type is short. This is the default list type. This produces a terse
listing that includes all attributes for the schedule. Each schedule
occupies one line of the listing. Most attribute values are expressed
numerically. This option is useful for scripts or programs that rework the
listing contents into a customized report format.
-L The list type is long. This listing includes all attributes for the schedule.
Some attribute values are descriptive terms, rather than numbers.
-label sched_label
List the attributes for this schedule in the named policy. The default is to
list information for all schedules for the named policy.
-U The list type is user. This listing is similar to the long-type listing, but it
has fewer entries. Most attribute values are descriptive terms, rather than
numbers.
EXAMPLES
Example 1
In this example, bpplsched lists the information for schedule user within policy tstpolicy
in two different ways. The first display is in long mode. The second is in User mode,
which shows fewer entries than the Long mode display.
bpplsched tstpolicy -L -label user
Schedule:
user
Type:
UBAK (2)
Frequency:
1 day(s) (86400 seconds)
Retention Level: 0 (1 week)
u-wind/o/d:
0 0
Incr Type:
DELTA (0)
Incr Depends: (none defined)
Max Frag Size:0 MB (1048576 MB)
Maximum MPX: 1
Number copies:1
Fail on Error:0
Residence:
(specific storage unit not required)
Volume Pool:
(same as policy volume pool)
Daily Windows:
Day
Open
Close
W-Open
W-Close
Sunday
000:00:00 024:00:00
000:00:00 024:00:00
Monday
000:00:00 024:00:00
024:00:00 048:00:00
Tuesday
000:00:00 024:00:00
048:00:00 072:00:00
Wednesday
000:00:00 024:00:00
072:00:00 096:00:00
238
bpplsched
Thursday
Friday
Saturday
000:00:00 024:00:00
000:00:00 024:00:00
000:00:00 024:00:00
096:00:00 120:00:00
120:00:00 144:00:00
144:00:00 168:00:00
bpplsched tstpolicy -U -label user
Schedule:
user
Type:
User Backup
Maximum MPX:
1
Number copies:1
Fail on Error:0
Residence:
Volume Pool:
Daily Windows:
Sunday
00:00:00 --> Sunday
24:00:00
Monday
00:00:00 --> Monday
24:00:00
Tuesday
00:00:00 --> Tuesday
24:00:00
Wednesday 00:00:00 --> Wednesday 24:00:00
Thursday
00:00:00 --> Thursday
24:00:00
Friday
00:00:00 --> Friday
24:00:00
Saturday
00:00:00 --> Saturday
24:00:00
Example 2
While running on the system hatt, list information for the schedule named full in policy
tstpolicy, as defined on the master server beaver:
bpplsched tstpolicy -M beaver -L -label full
Schedule:
full
Type:
FULL (0)
Frequency:
0+ day(s) (14400 seconds)
u-wind/o/d:
0 0
Incr Type:
DELTA (0)
Incr Depends:
(none defined)
Max Frag Size:
0 MB (1048576 MB)
Maximum MPX:
1
Number copies:1
Fail on Error:0
Residence:
Volume Pool:
Daily Windows:
Day
Open
Close
W-Open
W-Close
Sunday
000:00:00 024:00:00
000:00:00 024:00:00
Monday
000:00:00 024:00:00
024:00:00 048:00:00
Tuesday
000:00:00 024:00:00
048:00:00 072:00:00
Wednesday
000:00:00 024:00:00
072:00:00 096:00:00
Thursday
000:00:00 024:00:00
096:00:00 120:00:00
239
bpplsched
Friday
Saturday
000:00:00
000:00:00
024:00:00
024:00:00
120:00:00
144:00:00
144:00:00
168:00:00
Example 3
The following example adds a new schedule, full_2, to the policy tstpolicy on beaver, and
then lists the new schedule in Long mode. These commands run on the system hatt:
bpplsched tstpolicy -M beaver -add full_2
bpplsched tstpolicy -M beaver -label full_2 -L
Schedule:
full_2
Type:
FULL (0)
Frequency:
Retention Level: 1 (2 weeks)
u-wind/o/d:
0 0
Incr Type:
DELTA (0)
Incr Depends:
(none defined)
Max Frag Size:
0 MB (1048576 MB)
Maximum MPX:
1
Number copies:1
Fail on Error:0
Residence:
Volume Pool:
Daily Windows:
Day
Open
Close
W-Open
W-Close
Sunday
000:00:00 000:00:00
Monday
000:00:00 000:00:00
Tuesday
000:00:00 000:00:00
Wednesday
000:00:00 000:00:00
Thursday
000:00:00 000:00:00
Friday
000:00:00 000:00:00
Saturday
000:00:00 000:00:00
Example 4
In this example, bpplsched deletes the schedules, full_3, user, user_2, and user_3 from
policy tstpolicy:
bpplsched tstpolicy -delete full_3 user user_2 user_3
Example 5
In this example, bpplsched lists the schedule information for policy tstpolicy:
bpplsched tstpolicy -L
Schedule:
full
Type:
FULL (0)
Frequency:
u-wind/o/d:
0 0
Incr Type:
DELTA (0)
240
bpplsched
Incr Depends:
(none defined)
Max Frag Size:
0 MB (1048576 MB)
Maximum MPX:
1
Number copies:1
Fail on Error:0
Residence:
Volume Pool:
Daily Windows:
Day
Open
Close
W-Open
W-Close
Sunday
000:00:00 024:00:00
000:00:00 024:00:00
Monday
000:00:00 024:00:00
024:00:00 048:00:00
Tuesday
000:00:00 024:00:00
048:00:00 072:00:00
Wednesday
000:00:00 024:00:00
072:00:00 096:00:00
Thursday
000:00:00 024:00:00
096:00:00 120:00:00
Friday
000:00:00 024:00:00
120:00:00 144:00:00
Saturday
000:00:00 024:00:00
144:00:00 168:00:00
Schedule:
user
Type:
UBAK (2)
Frequency:
u-wind/o/d:
0 0
Incr Type:
DELTA (0)
Incr Depends:
(none defined)
Max Frag Size:
0 MB (1048576 MB)
Maximum MPX:
1
Number copies:1
Fail on Error:0
Residence:
Volume Pool:
Daily Windows:
Day
Open
Close
W-Open
W-Close
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
000:00:00
000:00:00
000:00:00
000:00:00
000:00:00
000:00:00
000:00:00
024:00:00
024:00:00
024:00:00
024:00:00
024:00:00
024:00:00
024:00:00
000:00:00
024:00:00
048:00:00
072:00:00
096:00:00
120:00:00
144:00:00
024:00:00
048:00:00
072:00:00
096:00:00
120:00:00
144:00:00
168:00:00
Example 6
In this example, bpplsched adds a new schedule, full, with a window from 11 pm to
midnight. The second bpplsched lists the information for schedule full:
bpplsched elevenpm -add full -window 82800 3600
241
bpplsched
bpplsched elevenpm -U -label full
Schedule:
FULL (0)
Type:
Full Backup
Frequency:
every 7 days (604800 seconds)
Maximum MPX:
1
Number copies:1
Fail on Error:0
Residence:
Volume Pool:
Daily Windows:
Sunday
23:00:00 --> Sunday
24:00:00
Monday
23:00:00 --> Monday
24:00:00
Tuesday
23:00:00 --> Tuesday
24:00:00
Thursday
23:00:00 --> Thursday
24:00:00
Friday
23:00:00 --> Friday
24:00:00
Saturday
23:00:00 --> Saturday
24:00:00
FILES
install_path\NetBackup\db\policy\policy_name\schedule
SEE ALSO
bpplschedrep
242
bpplschedrep
bpplschedrep
NAME
bpplschedrep - Modify the attributes of a NetBackup schedule.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpplschedrep policy_name
sched_label [ -M master_server,...] [-v] [-st sched_type]
[-freq backup_frequency] [-mpxmax mpx_factor] [-cal 0|1|2]
[-incl mm/dd/yyyy] [-excl mm/dd/yyyy] [-delincl
mm/dd/yyyy] [-delexcl mm/dd/yyyy] [-weekday day_name
week] [-dayomonth 1-31|l] [-delweekday day_name week]
[-deldayomonth 1-31|l] [-ci] [-ce] [-cw] [-cd]
[-number_copies number][-rl
retention_level[,rl-copy2,...,rl-copyn]] [-fail_on_error
0|1[,0|1,...,0|1]] [-residence
volume_pool_label[,pool-copy2,...pool-copyn]] [-(0..6) start
duration]
DESCRIPTION
bpplschedrep changes the attributes of a NetBackup schedule. The schedule and policy
named by bpplschedrep should already exist when this command is run. If the -M
option is used, bpplschedrep changes the schedule on each of the master servers listed.
OPTIONS
-(0..6) start duration
Specifies the window during which NetBackup can run the backups for
this schedule. This window applies to a specific day of the week. 0
corresponds to Sunday, 1 to Monday, and so on.
start is the time at which the backup window opens for this schedule.
This is the number of seconds since midnight. It is an integer between 0
and 86400 (the number of seconds in a day).
-cal 0|1|2
Indicates whether bpplschedrep is following a calendar-based
schedule or a frequency-based schedule.
243
bpplschedrep
-dayomonth 1-31|l
30, or 31 days.
-dayomonth 15
-dayomonth l
-deldayomonth 1-31|l
Specifies a day of every month to be excluded as a run day. Enter 1
(lowercase L) to exclude the last day of every month, whether the month
contains 28, 29, 30, or 31 days. This command can only remove dates that
were added by using the -dayomonth command.
For example, to exclude the 20th day of every month from the schedule,
enter:
-deldayomonth 20
-delweekday day_name week
Specifies a day of the week and the week of the month to be excluded as a
run day from the schedule. This command can only remove dates that
were added by using the -weekday command.
The day_name is: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday. The week is the number of the week in the month.
For example, to exclude the second Monday of the month, enter:
-delweekday Monday 2
-excl mm/dd/yyyy
-delincl mm/dd/yyyy
Indicates to delete this single date. This command can only remove dates
that were added by using the -incl command.
-delexcl mm/dd/yyyy
Indicates to delete this single date.
-ci
Clear all specific include dates.
244
bpplschedrep
-ce
Clear all specific exclude dates.
-cw
Clear all week days.
-cd
Clear all days of a month.
-fail_on_error 0|1[,0|1,...,0|1]
-freq backup_frequency
The backup frequency controls how much time can elapse between
successful automatic backups for clients on this schedule. Frequency does
not apply to user schedules because the user can perform a backup or
archive any time the backup window is open. This value is a positive
integer, representing the number of seconds between successful
automatic backups for this schedule.
-help
the command line.
-incl mm/dd/yyyy
bpplschedrep command. Each master server in the list must allow
access by the system issuing the bpplschedrep command. If an error
occurs for any master server, processing terminates at that point.
The schedule attributes will be modified on all the master servers in this
list.
-mpxmax mpx_factor
This is the maximum multiplexing factor for this schedule. Multiplexing
sends concurrent, multiple backups from one or several clients to a single
drive.
The multiplexing factor can range from 1 through 8 for NetBackup Server
and 1 through 32 for NetBackup Enterprise Server. A value of 1 specifies
no multiplexing and a value greater than 1 means that NetBackup should
245
bpplschedrep
create multiplexed images on the destination media. The multiplexing
factor should be less than or equal to the multiplexing factor for the
storage unit.
For more information on multiplexing refer to the multiplexing topic in
the NetBackup System Administrator’s Guide.
policy_name
The name of the policy that contains the schedule. This policy has been
previously created.
Specifies the volume pool(s) for the schedule. Do not use this option if a
disk storage unit is the residence for the schedule. If "*NULL*" is
specified, the volume pool for the schedule is the volume pool of the
policy which contains this schedule.
Specify a pool for each copy.
To display the configured volume pools, run install_path\Volmgr\bin\vmpool -listall.
Specifies the label(s) of the storage unit to be used for storing the backups
created according to this schedule. If "*NULL*" is specified, the residence
for the schedule defaults to the residence of the policy which contains this
schedule. If the residence value is a storage unit label, the residence for
the schedule becomes that storage unit, overriding the residence for the
policy.
Specify a storage unit for each copy.
Run bpstulist to display the set of defined storage units.
-rl retention_level[,rl-copy2,..., rl-copyn]
Specifies how long NetBackup retains the backups that it creates using
this schedule. Valid retention levels and their corresponding default
retention times are listed below.
Specify a retention level for each copy.
Caution Because the retention period associated with each level can be changed by using
the NetBackup administration interface, your configuration may have different
values for each level than those shown here. Use the NetBackup administration
246
bpplschedrep
interface to determine the actual retention periods before making any changes
with this command. Otherwise, backups could expire sooner than you expect,
resulting in loss of data.
0
1 week
1
2 weeks
2
3 weeks
3
1 month
4
2 months
5
3 months
6
6 months
7
9 months
8
1 year
9 - 24 infinite
NetBackup keeps the information about the backups for the specified
time. Then it deletes information about them. Once deleted, the files in
the backups are unavailable for restores. When all the backups on a
volume have expired, the volume can be reassigned.
sched_label
The name of the schedule to be changed. This schedule has been
previously created.
-st sched_type
Specifies the type of backup this schedule performs. Schedule types fall
into two main categories: automatic and user. Automatic schedules
define the windows during which the NetBackup scheduler can initiate a
backup for this policy.
User schedules define the windows during which a user can initiate a
backup or archive.
The values for schedule type are
FULL
(full backup)
INCR
(differential incremental backup)
CINC
(cumulative incremental backup)
UBAK
(user backup)
UARC
(user archive)
the schedule.
The day_name is: Sunday, Monday, Tuesday, Wednesday, Thursday,
Friday, or Saturday.
247
bpplschedrep
The week is the number of the week in the month.
-weekday Monday 2
-v
Selects verbose mode. This option causes bpplschedrep to log
EXAMPLES
Example 1
Set the frequency for a schedule.
bpplschedrep mkbpolicy incr -freq 604800
This sets to 1 week the frequency with which automatic backups will be performed for the
schedule incr in policy mkbpolicy.
Example 2
For Saturday and Sunday of each week, have the window for schedule full in policy
newpolicy open at 10 pm instead of 11 pm. Also, have the window duration be 2 hours
instead of 1 hour. bpplschedrep resets the windows, and bpplsched lists the new
schedule values.
bpplschedrep newpolicy full -0 79200 7200 -6 79200 7200
bpplsched newpolicy -U -label full
Schedule:
full
Type:
Full Backup
Frequency:
every 7 days
Maximum MPX:
1
Residence:
Volume Pool:
Daily Windows:
Sunday
22:00:00 --> Sunday
24:00:00
Monday
23:00:00 --> Monday
24:00:00
Tuesday
23:00:00 --> Tuesday
24:00:00
Thursday
23:00:00 --> Thursday
24:00:00
Friday
23:00:00 --> Friday
24:00:00
Saturday
22:00:00 --> Saturday
24:00:00
248
bpplschedrep
FILES
install_path\NetBackup\db\policy\policy_name\schedule
SEE ALSO
bpplsched
249
bppolicynew
bppolicynew
NAME
bppolicynew - Create, copy, or rename a NetBackup policy.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bppolicynew policy_name
[-verbose] [-M master_server,...]
install_path\NetBackup\bin\admincmd\bppolicynew policy_name -sameas
existing_policy_name [-verbose] [-M master_server,...]
install_path\NetBackup\bin\admincmd\bppolicynew existing_policy_name
-renameto policy_name [-verbose] [-M master_server,...]
DESCRIPTION
bppolicynew performs one of the following operations on a NetBackup policy:
◆
Create a new NetBackup policy with default attribute values
◆
Create a new NetBackup policy with the same attributes as an existing policy r
◆
Rename an existing NetBackup policy
When bppolicynew runs without -sameas or -renameto, it creates a new NetBackup
policy with default attribute values. If -M is present, the defaults used for the policy
definition on each master server are the defaults for that master server.
bppolicynew copies a policy by adding a new policy to the NetBackup database. The
clients, files, schedules, and attributes for the new policy are the same as those for the
existing policy. bppolicynew does not create a policy copy with the same name as an
existing policy.
If bppolicynew renames a policy, the existing association of images with the policy is
lost. This means that an image listing for the renamed policy does not include the images
that were created before the policy was renamed. bppolicynew does not rename a policy
to have the same name as an existing policy.
The NetBackup command bpplinfo replaces the policy-attribute defaults with new
values. bpplclients, bpplinclude, and bpplsched define the clients, backup files,
and schedules for the policy. A policy needs to have at least one client, one file
specification, and one automatic schedule before it can run automatic backups.
bppolicynew sends its error messages to stderr. bppolicynew sends a log of its activity
to the NetBackup admin log file for the current day.
250
bppolicynew
See the NetBackup System Administrator’s Guide for additional information on policies.
OPTIONS
policy_name
The name of a NetBackup policy which bppolicynew creates or the
name to which bppolicynew changes an existing policy. There is no
default value.
This policy name must differ from any existing policy name. It is
composed of numeric, alphabetic, plus, minus, underscore, and period
characters. Do not use a minus as the first character or leave any spaces
between characters.
existing_policy_name
The name of a NetBackup policy which already exists when
bppolicynew runs. There is no default value.
-renameto
Change the name of the existing policy to the new policy name.
-sameas
Create a new policy, copying its characteristics from the existing policy.
-help
the command line.
-verbose
with debug logging turned on (that is, the directory
EXAMPLES
Note that references to Follow NFS Mounts in these examples apply only to NetBackup
Enterprise Server.
251
bppolicynew
Example 1
Create a policy with default attribute values on the master server plim:
bppolicynew ishkabibble -M plim
bppllist ishkabibble -U -M plim
-----------------------------------------------------------Policy Name:
ishkabibble
Policy Type:
Standard
Active:
yes
Client Compress:
no
Follow NFS Mounts:
no
Collect TIR info:
no
Block Incremental:
no
Mult. Data Streams: no
Client Encrypt:
no
Policy Priority:
0
Max Jobs/Policy:
99
Disaster Recovery:
0
Residence:
Volume Pool:
NetBackup
Keyword:
(none specified)
Clients:
(none defined)
Include:
(none defined)
Schedule:
(none defined)
Example 2
Create a new policy, mypolicy_copy from the existing policy mypolicy. bppllist shows
that mypolicy_copy has the same attributes as mypolicy. For brevity, most of the schedule
information is omitted here:
bppolicynew mypolicy_copy -sameas mypolicy
bppllist mypolicy -U
-----------------------------------------------------------Policy Name:
mypolicy
Policy Type:
Standard
Active:
yes
Client Compress:
no
Follow NFS Mounts:
no
Collect TIR info:
no
Block Incremental:
no
252
bppolicynew
Mult. Data Streams:
Client Encrypt:
Policy Priority:
Max Jobs/Policy:
Disaster Recovery:
Residence:
Volume Pool:
Keyword:
no
no
0
99
0
myunit
NetBackup
(none specified)
HW/OS/Client: Linux
SGI
Include:
RedHat
IRIX6.5.15
zippity
mango
/tmp/my
Schedule:
Type:
Frequency:
Maximum MPX:
Retention Level:
Residence:
Volume Pool:
Daily Windows:
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
full
Full Backup
every 7 days
1
0 (1 week)
Schedule:
Type:
incr
Differential Incremental Backup
00:00:00
00:00:00
00:00:00
00:00:00
00:00:00
00:00:00
00:00:00
-->
-->
-->
-->
-->
-->
-->
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
08:00:00
08:00:00
08:00:00
08:00:00
08:00:00
08:00:00
08:00:00
bppllist mypolicy_copy -U
-----------------------------------------------------------Policy Name:
mypolicy_copy
Policy Type:
Standard
Active:
yes
Client Compress:
no
Follow NFS Mounts:
no
Collect TIR info:
no
Block Incremental:
no
Mult. Data Streams: no
Client Encrypt:
no
Policy Priority:
0
Max Jobs/Policy:
99
253
bppolicynew
Disaster Recovery:
Residence:
Volume Pool:
Keyword:
0
myunit
NetBackup
(none specified)
HW/OS/Client: Linux
SGI
Include:
RedHat
IRIX6.5.15
zippity
mango
/tmp/my
Schedule:
Type:
Frequency:
Maximum MPX:
Retention Level:
Residence:
Volume Pool:
Daily Windows:
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
full
Full Backup
every 7 days
1
0 (1 week)
Schedule:
Type:
incr
Differential Incremental Backup
00:00:00
00:00:00
00:00:00
00:00:00
00:00:00
00:00:00
00:00:00
-->
-->
-->
-->
-->
-->
-->
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
08:00:00
08:00:00
08:00:00
08:00:00
08:00:00
08:00:00
08:00:00
Example 3
Rename a policy from policy_old to policy_new. Before and after the renaming,
bppllist shows the policies in the NetBackup configuration database:
bppllist
mypolicy
policy_old
test
bppolicynew policy_old -renameto policy_new
bppllist
mypolicy
policy_new
test
RETURN VALUES
254
bppolicynew
bppolicynew: EXIT status = exit status
FILES
install_path\NetBackup\db\policy\policy_name
SEE ALSO
bpplclients, bpplinfo, bpplsched, bppldelete, bppllist
255
bpps
bpps
NAME
bpps - Lists all processes and statistics for each process.
SYNOPSIS
install_path\NetBackup\bin\bpps [-l | -s | -S] [-t sample_time[m]]
[-i | -x process_group] ... [host_name] ...
install_path\NetBackup\bin\bpps -? [process_group ...]
DESCRIPTION
The bpps command lists the process statistics for all processes running on your system.
This command enables you to list a specific process group to process. It also enables you
specify a sample time in seconds (or milliseconds) before listing the processes.
OPTIONS
-?
Print the help screen. Specifying process_group here displays the list of
processes that would be included or excluded when specifying
process_group with the -i or -x options.
-l
Output a long listing.
-s
Output a short listing (default).
-S
Output a short listing without the header (for example, host name, date,
and column headings).
-t sample_time[m]
Specify the sample time (default 1 second). The sample time is specified
in seconds unless followed by m, which specifies the sample time in
milliseconds.
-i process_group
Include the specified process group in the listing (default NB_ALL).
-x process_group
Exclude the specified process group from the listing.
host_name
The name of the host computer you are listing group process statistics on.
256
bpps
NOTES
The following is a list of all of the valid process groups and a brief
description of each.
MM_ALL
All Media Manager processes.
MM_CLIS
Media Manager command line programs.
MM_CORE
Media Manager core processes.
MM_GUIS
Media Manager GUI programs.
MM_SERVICES
Media Manager services.
MM_UIS
Media Manager user interface programs.
MM_WORKERS
Media Manager worker processes.
NB_ALL
All NetBackup, Media Manager and ARO processes.
NB_ALL_CLIS
All NetBackup and Media Manager command line programs.
NB_ALL_CORE
All NetBackup, Media Manager and ARO core processes.
NB_ALL_GUIS
All NetBackup and Media Manager GUI programs.
NB_ALL_SERVICES
All NetBackup and Media Manager Services.
NB_ALL_UIS
All NetBackup and Media Manager user interface programs.
NB_ALL_WORKERS
All NetBackup and Media Manager worker processes.
NB_CLIENT_ALL
All NetBackup client processes.
NB_CLIENT_CLIS
NetBackup client command line programs.
257
bpps
NB_CLIENT_CORE
NetBackup client core processes.
NB_CLIENT_GUIS
NetBackup client GUI programs.
NB_CLIENT_SERVICES
NetBackup client services.
NB_CLIENT_UIS
NetBackup client user interface p
NB_CLIENT_WORKERS
NetBackup client worker processes.
NB_SERVER_ALL
All NetBackup server processes.
NB_SERVER_CLIS
NetBackup server command line programs.
NB_SERVER_CORE NetBackup server core processes.
NB_SERVER_GUIS
NetBackup server GUI programs.
NB_SERVER_SERVICES
NetBackup server services.
NB_SERVER_UIS
NetBackup server user interface programs.
NB_SERVER_WORKERS
NetBackup server worker processes.
NBDB_SERVICES
NetBackup Database services.
NBDB_CLIS
NetBackup Database command line programs.
NBDB_ALL
All NetBackup Database processes.
VLT_CORE
Core Vault processes.
VLT_GUIS
Vault GUI programs.
VLT_CLIS
Vault command line programs.
258
bpps
VLT_UIS
Vault user interface programs.
VLT_ALL
All Vault processes.
OTHER_PROCESSES
All processes not included in NB_ALL.
FILES
install_path\NetBackup\bin\bp.conf
259
bprecover
bprecover
NAME
bprecover - Recover selected NetBackup related catalogs.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bprecover
-l -m media_id -d density [-v]
-l -tpath raw_tape_device_path [-v]
-l -dpath disk_device_path [-v]
-l -opath optical_device_path [-v]
-l -5x -p policy_name [-v]
-l -vxss -p policy_name [-v]
-r [ALL | image_number [[-stdout] | [-dhost destination_host]]]
-m media_id -d density [-v]
-tpath raw_tape_device_path [-v]
-dpath disk_device_path [-v]
-opath optical_device_path [-v]
-r [ALL | image_number] -5x -p policy_name [-v]
-r [ALL | image_number] -vxss -p policy_name [-v]
-r -nbdb [-v]
-wizard
Note One or more of the NetBackup services will have to be in a stopped state before
using bprecover. Refer to the "Recovering Catalogs from Tape" section in the
Troubleshooting Guide.
260
bprecover
DESCRIPTION
The bprecover command initiates the NetBackup utility for restoring the NetBackup
internal databases called catalogs and recovers catalogs that were backed up by using the
procedures described in the NetBackup System Administrator’s Guide. Use bprecover
only if catalogs were destroyed on disk.
The command has two main modes: list and recover. List shows the contents of a backup
media or disk path. Recover recovers the catalog files.
OPTIONS
-5x
This parameter, when used with the -p policy_name option, defines a
NetBackup 5.x media server. You must use this parameter in conjunction
with the -p policy_name option to recover an image from the
following location.
install_path\NetBackup\db\/NBU_5XMDB_IMAGE/catalog_bac
kup_policy_name
-l
Lists the header information from the specified media or disk path.
-m media_ID -d density
Specifies the media ID and the density of the media from which to recover files. The Device Manager and Volume Manager services must be
running when you use the -m option. When the Volmgr\database
directory is restored you will see messages about busy files and must
reboot.
media_ID must be six or less characters and must be defined in the
Enterprise Media Manager Database.
density must be one of the following: 4mm (4-mm cartridge)
8mm (8-mm cartridge)
dlt (dlt cartridge)
dlt2 (dlt cartridge alternate)
qscsi (1/4-in cartridge)
Note The following densities apply only to NetBackup Enterprise Servers.
hcart (1/2 Inch cartridge)
hcart2 (1/2 Inch cartridge alternate)
dtf (DTF cartridge)
261
bprecover
-nbdb
Used in conjunction with the -r option during catalog recovery
procedures to recover and resynchronize the NetBackup relational
database, the EMM database, and the BMR database if BMR is
configured.. Reference the catalog recovery procedures in the Disaster
Recovery chapter of the NetBackup Troubleshooting Guide for complete
catalog recovery procedures.
-dpath disk_device_path
-tpath raw_tape_device_path
-opath optical_device_path
Specifies a raw device path. If -m and -d are not specified. Use -dpath ,
-opath, or -tpath to specify a raw device path. Stop the NetBackup
Device Manager and Volume Manager services when using one of these
options.
-r [ALL | image_number]
Recovers images from the specified media or disk path. There are three modes of recovery available with -r: If -r ALL is specified, recover all the images contained in the specified
media or disk path. If -r image_number is specified, recover only the selected image number from the specified media or disk path. If -r is specified by itself, bprecover interactively prompts and asks if
you want to recover the images contained in the specified media or disk path. -r -nbdb
If -r -nbdb is specified, recover and resynchronize the NetBackup
relational database. Only used as part of catalog recovery procedures.
Reference the catalog recovery procedures in the Disaster Recovery
chapter of the NetBackup Troubleshooting Guide for complete catalog
recovery procedures.
-stdout
Specifies that the selected backup image be written to stdout instead of
automatically being restored. This option is useful, for example, if only
one individual file was lost and you want to restore it without restoring
the rest of the catalog files in the image.
Note You cannot specify -r ALL with -stdout because the -stdout option permits
only one file image to be read at a time.
262
bprecover
-dhost destination_host
Specifies the host to which the selected catalog is restored. Normally,
catalogs are restored to the host where the data originated (as displayed
with the -l option). The -dhost option makes it possible to restore the
catalog to another host.
The NetBackup client or server software must be installed on the
destination host and the NetBackup Client service must be running.
Caution Use the dhost option with EXTREME caution, since it can overwrite existing
catalogs on the destination host. To permit recovery in case you unintentionally
overwrite the wrong catalogs, you can move existing catalogs to a temporary
directory on the destination host.
Note Do not specify -r all (or ALL) with -dhost when using this command. Either
explicitly specify an image (for example, -r 2) or use the interactive mode (-r).
-v
Selects verbose mode. This is meaningful only when running with debug
logging turned on (that is, when the
install_path\NetBackup\logs\admin directory exists).
-vxss
This parameter, when used with the -p policy_name option, enables
you to recover VxSS Authentication and Authorization data that has been
backed up by an online, hot catalog backup. The image will be recovered
from the following location:
install_path\NetBackup\db\/NBU_VSSDB_IMAGE/policy_name -wizard
This parameter enables a user to perform the same functions from a
command line that are present on the recovery wizard. For example, a
user can do the following.
- Specify the full pathname to the catalog disaster recovery file:
- Recover the entire NetBackup catalog
EXAMPLES
Example 1
List the backup header information for the catalog backup done to disk path
D:\apps\dbbackup.
cd D:\VERITAS\NetBackup\bin\admincmd\
bprecover -l -dpath D:\apps\dbbackup
Database Backup Information from D:\apps\dbbackup
263
bprecover
Created:
Server:
03/31/97 11:31:34
bphost
Path
---
IMAGE1 D:\VERITAS\NetBackup\db
IMAGE2 D:\VERITAS\Volmgr\database
Example 2 List the backup header information from media ID 000001, which is density dlt.
cd D:\VERITAS\NetBackup\bin\admincmd
bprecover -l -m 000001 -d dlt
Database Backup Information from 000001
Created:
Server:
Block size:
03/31/97 05:50:51
bphost
32768
Path
---IMAGE1 D:\VERITAS\NetBackup\db
IMAGE2 D:\VERITAS\Volmgr\database
Example 3
Recover the D:\VERITAS\NetBackup\db files from disk path D:\apps\dbbackup.
bprecover -r 1 -dpath D:\apps\dbbackup
Recovering bphost:D:\VERITAS\NetBackup\db
◆
Example 4 Recover all the backed up catalogs from media ID JBL29.
bprecover -r ALL -m JBL29 -d 8mm
Recovering bphost:D:\VERITAS\NetBackup\db
Recovering bphost: D:\VERITAS\Volmgr\database
Example 5
Interactively restore selected images. Use raw tape path \\.\Tape1. Assume that the
media that is loaded into the drive is the same one as in example 4.
bprecover -r -tpath \\.\Tape1
Recover bphost: D:\VERITAS\NetBackup\db y/n (n)? n
Recover bphost: D:\VERITAS\Volmgr\database y/n (n)? y
Recovering bphost: D:\VERITAS\Volmgr\database
264
bprecover
ERRORS
If errors occur during the recover operation, NetBackup writes error messages to the
MS-DOS command window when you run the bprecover command.
FILES
install_path\NetBackup\db\*
install_path\Volmgr\database\*
SEE ALSO
tpreq
NetBackup Troubleshooting Guide for information on disaster recovery.
265
bprestore
bprestore
NAME
bprestore - Restores files from the NetBackup server.
SYNOPSIS
install_path\NetBackup\bin\bprestore [-A | -B] [-drs] [-F
file_options] [-K] [-l | -H | -y] [-r] [-T] [-L progress_log
[-en]] [-R rename_file] [-C client] [-D client] [-S
master_server] [-t policy_type] [-p policy] [-s date] [-e date]
[-w [hh:mm:ss]] [-k "keyword_phrase"] -f listfile | filenames
[-cm] [-drs] [-md] [-td temp_dir] [-spsredir_server
hostname] [-BR portal_name | teamsite_name]
DESCRIPTION
bprestore lets users restore a backed up or archived file or list of files. You can also
name directories to restore. If you include a directory name, bprestore restores all files
and subdirectories of that directory. You can exclude a file or directory path that was
previously included in the restore by placing an exclamation mark (!) in front of the file or
directory path (does not apply to NDMP restores). The exclude capability is useful, for
example, if you want to exclude part of a directory from the restore.
Note: If a policy, schedule type, or date range is not specified then bprestore will
start with the most recent full backup image and include all subsequent ncremental
and differential backup images. From these images the most recent copy of a file will
be restored.
By default, you are returned to the system prompt after bprestore is successfully
directly to you. The -w option lets you change this behavior so bprestore works in the
The bprestore command restores the file from the most recent backups within the time
period you specify, except for a true-image restore (see the -T option description).
bprestore overwrites any file of the same name that already exists on the local client
disk, unless you include the -K option. It is also possible to restore files that were backed
up or archived on another client (-C option). You must be validated by the NetBackup
administrator to restore from other clients.
bprestore writes informative and error messages to a progress-log file if you create the
file prior to running the bprestore command and then specify the file with the -L
progress_log option. If bprestore cannot restore the requested files or directories, you
can use the progress log to find the reason for the failure.
266
bprestore
For detailed troubleshooting information, create a directory named
install_path\NetBackup\logs\bprestore with write access. bprestore then creates
an debug log file in this directory.
The following restrictions apply to bprestore:
◆ You can restore files and directories that you own and those owned by other users if
you have read access. You need write access to another user’s directories and files to
restore that user’s files to their original location.
◆ The operating system restricts the number of files and directories that you can specify
on a single bprestore command line. If this is a problem, use the -f option to
restore the files.
Use the bplist command to display information on the files and directories that were
backed up or archived.
OPTIONS
-A | -B
Specifies whether to restore from archives (-A) or backups (-B). The
default is -B.
-BR portal_name | teamsite_name
This option specifies a portal nameor the team site name to where the
selected portal or teamsite is to be redirected in a SharePoint farm. A user
should specify the redirected portal or teamsite as http://portalname
| http://teamsitename, and should already exist in a farm.
-cm
Use this option if your selection contains the last backup set to be
restored. This enables the restore operation to play through log files and
roll back any uncompleted transactions. If this option is not selected, the
database is left in an intermediate state and is not yet usable.
-drs
Allows files to be restored without access-control attributes. By default,
access-control attributes are restored along with file and directory data.
Option -drs is available only to NetBackup administrators.
-F file_options
Allows either Backup Exec files to be restored, or both Backup Exec and
NetBackup files to be restored. The default ( -F is not specified), is to
restore only NetBackup files.
To restore only Backup Exe files specify:
-F 524288
To restore Backup Exe and NetBackup files specify:
-F 1048576
267
bprestore
-K
Specifying this option causes bprestore to keep existing files rather
than writing over them when restoring files with the same name. The
default is to overwrite existing files.
Note The -l | -H | -y options apply only when restoring UNIX files to a UNIX system.
-l | -H | -y
Specifying -l renames the targets of UNIX links by using the -R
rename_file option in the same way as when renaming files.
Specifying -H renames UNIX hard links by using the -R rename_file
option in the same way as when renaming files. Soft links are unchanged.
Specifying -y renames UNIX soft links by using the -R rename_file
option in the same way as when renaming files. Hard links are
unchanged.
See Example 5 in the EXAMPLES section.
-md
Mounts the database so that it is available to users. This option is only
available if Commit after restore completes is selected.
-r
Specifying this option restores disk images instead of file systems.
Specifies the name of an existing file in which to write progress
information.
For example: c:\proglog
-R rename_file
Specifies the name of a file with name changes for alternate-path restores.
For example: bprestore -R /C/renamefile /C/origfile
Where /C/rename_file is the file with the name change and
/C/origfile is the file to be renamed.
Use the following form for entries in the rename file:
change backup_filepath to restore_filepath
The file paths must start with / (slash)
The first backup_filepath that is matched is replaced with the restore_filepath string. Use all upper case for the drive letter.
268
bprestore
The default is to restore using the original path.
For example, the following entry renames C:\users\fred to
C:\users\fred2:
change /C/users/fred to /C/users/fred2
(be sure to end the entry with a return)
When restoring to a Windows client, you can also use the following
method for specifying entries in the rename file (do not use this method
for other clients):
rename bulength backup_filepath reslength restore_filepath
Where:
bulength is the number of ASCII characters in the backup path.
reslength is the number of ASCII characters in the restore path.
The first backup_filepath that is matched is replaced with the
restore_filepath string.
For example, the following entry renames C:\fred.txt to
C:\fred2.txt:
rename 11 /C/fred.txt 12 /C/fred2.txt
(be sure to end the entry with a return)
-C client
Specifies a client name to use for finding backups or archives from which
to restore files. This name must be as it appears in the NetBackup catalog.
The default is the current client name.
Note The destination client does not default to the source client. See the description for
-D client option.
-D client
Specifies a destination client. This can be done by an administrator on the
master server in order to direct the restored files to a machine other than
the client specified with the -C option. The default is the current client
name.
-S master_server
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. To display this dialog, start the Backup, Archive and
269
bprestore
-spsredir_server hostname
This option specifies the webserver on which the redirected portal or
team site resides in a sharepoint farm. The redirected webserver should
be specified as hostname.
-t 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
10 = NetWare
13 = MS-Windows
14 = OS/2
15 = MS-SQL-Server
19 = NDMP
17 = SAP
18 = DB2
20 = FlashBackup
21 = Split-Mirror
22 = AFS
35 = NBU-Catalog
-p policy
Specifies the policy for which the backups or archives were performed.
-s date
-e date
Specifies the start and end date range for the listing. The bprestore
command restores only files from backups or archives that occurred
within the specified start and end date range.
-s specifies a start date and time for the restore window. bprestore
restores files only from backups or archives that occurred at or after the
specified date and time.
270
bprestore
The valid range of dates are from 01/01/1970 00:00:00 to 01/19/2038
03:14:07. The default start date is 01/01/1970 00:00:00.
The default is to return the most recent image. For backups, this is the
most recent full backup if a full backup exists. If a full backup does not
exist, then the most recent incremental or user-directed backup will be
restored.
-e specifies an end date and time for the restore window. bprestore
restores only files in backups or archives that occurred at or before the
specified date and time. Use the same format as for the start date and
time.
The end backup date and time do not need to be exact, except for a
true-image restore (see the -T option description). The bprestore
command restores the file that has the specified backup date and time or
the file that is the most recent backup preceding the end date and time.
The default is the current date and time."
-td temp_dir
This option provides a location where the associated log and patch files
are to be kept until the database is restored. The default location is
c:\temp. If storage groups are being restored, a subdirectory in c:\temp is
created for each storage group. The log and patch files for each storage
group are kept in the corresponding subdirectory.
-T
Specifies a true-image restore, where only files and directories that
existed in the last true-image backup are restored. This option is useful
only if true-image backups were performed. If this option is not specified,
all files and directories meeting the specified criteria are restored, even if
they were deleted.
When the -T option is specified, the image requested must be uniquely
identified. Unique identification is accomplished by using the -e option
with seconds granularity. The -s option, if any, is ignored. The seconds
granularity of an image can be retrieved by using the bplist command
with the -l and -Listseconds options.
-w [hh:mm:ss]
expires before the restore is complete, the command exits with a timeout status. The restore, however, still completes on the server.
Specifying 0 or not specifying a time, means wait indefinitely for the completion status.
271
bprestore
-k "keyword_phrase"
Specifies a keyword phrase for NetBackup to use when searching for
backups or archives from which to restore files. The phrase must match
the one that was previously associated with backup or archive by the -k
option of the bpbackup or bparchive command.
You can use this option in place of or in combination with the other
restore options in order to make it easier to restore your backups and
archives. The following meta characters can simplify the task of matching
keywords or parts of keywords in the phrase:
* matches any string of characters.
? matches any single character.
[ ] matches one of the sequence of characters 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 (‘...’).
-f listfile
Specifies a file (listfile) containing a list of files to be restored and can be
used instead of the filenames option. In listfile, list each file path on a
separate line.
The format required for the file list depends on whether the files have spaces or newlines in the names.
To restore files that do not have spaces or newlines in the names, use this
format:
filepath
Where filepath is the path to the file that you are restoring. For example:
Note Use upper case for the drive letter. For example, C:\NetBackup\Log1.
C:\programs
C:\winnt
C:\documents\old_memos
To restore files that have spaces or newlines in the names, use one of the
following formats:
filepathlen filepath start_date_time end_date_time
filepathlen filepath -s datetime -e datetime
The filepath is the path to the file you are restoring.
272
bprestore
The filepathlen is the total number of characters in the file path.
The start_date_time and end_date_time are the decimal number of
seconds since 01/01/1970 00:00:00.
datetime is the same as the command line (mm/dd/yy [hh[:mm[:ss]]]).
The start and end date and time specified on the command line is used
unless a line in listfile overrides it. The dates may change from line to line.
You can exclude a file or directory path that was previously included in
the restore by placing an exclamation mark (!) in front of the file or
directory path (except when performing NDMP restores).
The following is an example that uses filepathlen filepath:
11 C:\programs
8 C:\winnt
22 C:\documents\old memos
17 !C:\programs\test
filenames
Names one or more files to be restored and can be used instead of the -f
option.
Any files that you specify must be listed at the end, following all other
options. You must also specify absolute file paths. You can exclude a file
or directory path that was previously included in the restore by placing
an exclamation mark (!) in front of the file or directory path (except when
performing NDMP restores).
Use upper case for the drive letter. For example, C:\NetBackup\log1.
EXAMPLES
Example 1
To restore files from backups of C:\programs\file1 that were performed between
04/01/2003 06:00:00 and 04/10/2003 18:00:00, enter the following (all on one line):
bprestore -s 04/01/93 06:00:00 -e 04/10/93 18:00:00 C:\user1\file1
Example 2
To restore files listed in a file named restore_list by using the most recent backups,
bprestore -f c:\restore_list
Example 3
To restore the directory C:\kwc from the backups that are associated with a keyword
phrase that contains “My Home Directory” and use a progress log named
d:\kwc\bkup.log, enter the following (all on one line):
273
bprestore
bprestore -k "*My Home Directory*" -L d:\kwc\bkup.log C:\kwc
Example 4
To restore the D drive on the Windows client slater from the backups that are associated
with a keyword phrase that contains “My Home Dir” and use a progress log named
c:\kwc\bkup.log, enter the following (all on one line, or using the backslash
continuation character):
bprestore -k "*My Home Dir*" -C slater -D slater -t 13 -L c:\kwc\bkup.log D:\
Example 5
Assume you have a rename file named /home/kwc/rename on a UNIX client and it
contains the following:
change /home/kwc/linkback to /home/kwc/linkback_alt
To restore the hard link named /home/kwc/linkback to alternate path
/home/kwc/linkback_alt on that client, run the following command:
bprestore -H -R /home/kwc/rename /home/kwc/linkback
Example 6
Assume you want to restore files from backups of C:\user1\ that were performed
between 04/01/01 06:00:00 and 04/10/01 18:00:00. You also want to exclude all files with
a .pdf extension, except for the one named final_doc.pdf. To do this, run the
following (all on one line):
bprestore -s 04/01/01 06:00:00 -e 04/10/01 18:00:00 C:\user1\ !C:\user1\*.pdf C:\user1\final_doc.pdf
FILES
install_path\NetBackup\logs\bprestore\*.log
SEE ALSO
bp, bparchive, bpbackup, bplist
274
bpschedule
bpschedule
NAME
bpschedule - Add, delete, or list disk staging storage unit (DSSU) schedules.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpschedule [-v] [-M
master_server,...] -add sched_label [-freq frequency]
[-stage_priority number] [-altreadhost hostname]
[-number_copies number] [-residence
volume_pool_label[,pool-copy2,...pool-copyn]]
[-fail_on_error 0|1[,0|1,...0|1][-window start_duration]]
[-cal 0|1|2] [-ut] [-incl mm/dd/yyyy] [-excl mm/dd/yyyy]
[-weekday day_name_week] [-dayomonth 1-31 | 1]
master_server,...] -delete sched_label ...
master_server,...] -deleteall
master_server...] [-L | -l | -U] [-label sched_label]
DESCRIPTION
The bpschedule command will do one of the following:
◆
Add a new disk staging storage unit (DSSU) schedule.
◆
Delete one or more DSSU schedules.
◆
Delete all the DSSU schedules.
◆
List one or all DSSU schedules.
◆
The default is to list all DSSU schedules.
For the -add and -delete options, bpschedule returns to the system prompt
immediately after it submits the DSSU schedule change request to NetBackup. To
determine whether the change was successful, run bpschedule again to list the updated
schedule information.
When the listing option is used there is a single entry for each schedule, even if the -M
option is used. The -l form lists the information for each schedule on several lines. -l
does not identify the attributes by name; these are as follows (where the names are not
described, they are reserved for internal NetBackup use):
275
bpschedule
Line 1: SCHED, schedule name, type, max_mpx, frequency, retention level, u_wind/o/d,
2 internal attributes, maximum fragment size, calendar, number of copies, and fail on
error. Note that u_wind/o/d is a field reserved for future use. This is also true for the
u_wind entry in the -L display.
Line 2: SCHEDWIN, seven pairs of the form start,duration, expressing the start and
duration of the window for each day of the week, starting with Sunday.
Line 3: SCHEDRES, residence (a value for each copy).
Line 4: SCHEDPOOL, pool (a value for each copy).
Line 5: SCHEDRL, retention level (a value for each copy).
Line 6: SCHEDFOE, fail on error (a value for each copy).
If the -M option is used, bpschedule performs the operation on each of the master
servers listed. For instance, if bpschedule is adding a schedule, bpschedule adds the
schedule to the policy on each of the master servers listed for -M. If the -M option is used
on a listing request, the listing is the composite of the information returned by all of the
master servers in the -M list. If the command fails for any of the master servers, activity
stops at that point.
To modify an existing NetBackup schedule, use the NetBackup command
bpschedulerep.
OPTIONS
These options are common to all forms of bpschedule:
-help
the command line.
A list of alternative master servers. This is a comma-separated list of host
bpschedule command. Each master server in the list must allow access
by the system issuing the bpschedule command.
If this option is present, the command is run on each master server in the
list. If an error occurs for any master server, processing terminates at that
point.
If bpschedule is producing a listing, the listing is the composite of the
276
bpschedule
If bpschedule adds or deletes a schedule, all master servers in this list
receive the change.
-v
Selects verbose mode. This option causes bpschedule to log additional
NetBackup administration debug log. This option is meaningful only
when NetBackup has debug logging enabled
The remaining options depend on the form of bpschedule. The first form of
bpschedule adds a schedule to the named policy. The following options apply to this
form of bpschedule:
-add sched_label [suboptions]
Add a single schedule to the named policy. The suboptions for the -add option explained below. These are attributes
of the schedule being added. Refer to the NetBackup System
Administrator’s Guide for details on schedules and their attributes.
-cal 0|1|2
Indicates whether bpschedule is following a calendar-based schedule
or a frequency-based schedule.
-dayomonth 1-31 | 1
30, or 31 days.
-dayomonth 15
-dayomonth l -excl mm/dd/yyyy
-fail_on_error 0|1[,0|1,...,0|1]
277
bpschedule
-freq frequency
Determines how often backups run. Represents the number of seconds
between backups initiated according to this schedule. Valid range for this
option is 0 through 2419200 (number of seconds in four weeks). When
omitted on the command line, the default value is 604800 (duration of one
week in seconds).
-incl mm/dd/yyyy
This is the name of the volume pool. This choice overrides the
policy-level volume pool. Entering "*NULL*" causes NetBackup to use
the volume pool specified at the policy level. The default is to use the
volume pool specified at the policy level. The volume pool label cannot
be None. If you do not specify a volume pool at either the schedule level
or the policy level, NetBackup uses a default value of NetBackup.
When specifying -number_copies greater than 1, specify a pool for
each copy.
This is the name of the storage unit, which specifies the location of the
backup images. The value "*NULL*" causes NetBackup to use the storage
unit specified at the policy level. The default is for NetBackup to use the
storage unit specified at the policy level. If you do not specify a storage
unit at either the schedule level or the policy level, NetBackup uses the
next storage unit available.
When specifying -number_copies greater than 1, specify a residence
for each copy.
-stage priority number The order in which storage units are to be selected within a storage unit group:
1 = Use the storage units in the order displayed in the storage unit group dialog (default).
2 = Use the storage unit least recently used. (The storage units take turns.)
3 = Use the first storage unit in the list that is not full or down. If the storage unit is only busy, the policy waits to write to it.
278
bpschedule
The server to be used to read a backup image that was originally written
by a different media server.
-ut
primarily for Java.
-weekday Monday 2
-window start duration
Specifies when NetBackup can run the backups for this schedule. Every
day of the week has the same window.
start is the time at which the backup window opens for this schedule. This is the number of seconds since midnight. This is an integer between
0 and 86399 (there are 86400 seconds in a day).
The second form of bpschedule deletes one or more schedules from the named policy.
The following option applies to this form of bpschedule:
-delete sched_label
Delete the listed schedules from the named policy. The elements of the
sched_label list must be separated by spaces. There can be up to 25 labels
in the list.
The third form of bpschedule deletes all schedule from the named policy. The following
option applies to this form of bpschedule:
-deleteall Delete all schedules from the named policy.
The fourth form of bpschedule produces a listing of information about the schedules for
the named policy. The following options apply to this form of bpschedule:
279
bpschedule
-l The list type is short. This is the default list type. This produces a terse
listing that includes all attributes for the schedule. Each schedule
occupies one line of the listing. Most attribute values are expressed
numerically. This option is useful for scripts or programs that rework the
listing contents into a customized report format.
-L The list type is long. This listing includes all attributes for the schedule.
Some attribute values are descriptive terms, rather than numbers.
-label sched_label
List the attributes for this schedule in the named policy. The default is to
list information for all schedules for the named policy.
-U The list type is user. This listing is similar to the long-type listing, but it
has fewer entries. Most attribute values are descriptive terms, rather than
numbers.
EXAMPLES
In this example, bpschedule lists the information for schedule test in Long mode.
bpschedule -L -label test
Schedule:
test
Type:
FULL (0)
Frequency: 7day(s) (604800 seconds)
Retention Level: 1(2 weeks)
u-wind/o/d:
0 0
Incr Type:
DELTA (0)
Incr Depends: (none defined)
Max Frag Size:0 MB (1048576 MB)
Maximum MPX: 1
Number copies:1
Fail on Error:0
Residence:
Volume Pool:
Daily Windows:
Day
Open
Close
W-Open
W-Close
Sunday
000:00:00 000:00:00
Monday
000:00:00 000:00:00
Tuesday
000:00:00 000:00:00
Wednesday
000:00:00 000:00:00
Thursday
000:00:00 000:00:00
Friday
000:00:00 000:00:00
Saturday
000:00:00 000:00:00
280
bpschedule
FILES
install_path\NetBackup\db\sched\schedule name
SEE ALSO
bpschedulerep
281
bpschedulerep
bpschedulerep
NAME
bpschedulerep - Modify the attributes of a disk staging storage unit (DSSU) schedule.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpschedulerep sched_label [ -M
master_server,...] [-v] [-freq backup_frequency]
[-stage_priority number] [-altreadhost hostname] [-cal
0|1|2] [-incl mm/dd/yyyy] [-excl mm/dd/yyyy] [-delincl
mm/dd/yyyy] [-delexcl mm/dd/yyyy] [-weekday day_name
week] [-dayomonth 1-31 | 1] [-delweekday day_name week]
[-deldayomonth 1-31 | 1] [-ci] [-ce] [-cw] [-cd]
[-number_copies number] [-fail_on_error
0|1[,0|1,...,0|1]] [-residence
volume_pool_label[,pool-copy2,...pool-copyn]] [-(0..6) start
duration]
DESCRIPTION
bpschedulerep changes the attributes of a NetBackup disk staging storage unit (DSSU)
schedule. The schedule named by bpschedulerep should already exist when this
command is run. If the -M option is used, bpschedulerep changes the schedule on each
of the master servers listed.
OPTIONS
-(0..6) start duration
Specifies the window during which NetBackup can run the backups for
this schedule. This window applies to a specific day of the week. 0
corresponds to Sunday, 1 to Monday, and so on.
start is the time at which the backup window opens for this schedule.
This is the number of seconds since midnight. It is an integer between 0
and 86400 (the number of seconds in a day).
-cal 0|1|2
Indicates whether bpschedulerep is following a calendar-based
schedule or a frequency-based schedule.
282
bpschedulerep
-dayomonth 1-31 | 1
30, or 31 days.
-dayomonth 15
-dayomonth l -deldayomonth 1-31 | 1
Specifies a day of every month to be excluded as a run day. Enter 1
(lowercase L) to exclude the last day of every month, whether the month
contains 28, 29, 30, or 31 days.
For example, to exclude the 20th day of every month from the schedule,
enter:
-deldayomonth 20
-delweekday day_name week
Specifies a day of the week and the week of the month to be excluded as a
run day from the schedule.
The day_name is: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday. The week is the number of the week in the month.
For example, to exclude the second Monday of the month, enter:
-delweekday Monday 2
-excl mm/dd/yyyy
-delincl mm/dd/yyyy
-delexcl mm/dd/yyyy
-ci
Clear all specific include dates.
-ce
Clear all specific exclude dates.
283
bpschedulerep
-cw
Clear all week days.
-cd
Clear all days of a month.
-fail_on_error 0|1[,0|1,...,0|1]
-freq backup_frequency
The backup frequency controls how much time can elapse between
successful automatic backups for clients on this schedule. Frequency does
not apply to user schedules because the user can perform a backup or
archive any time the backup window is open. This value is a positive
integer, representing the number of seconds between successful
automatic backups for this schedule.
-help
the command line.
-incl mm/dd/yyyy
bpschedulerep command. Each master server in the list must allow
access by the system issuing the bpschedulerep command. If an error
occurs for any master server, processing terminates at that point.
The schedule attributes will be modified on all the master servers in this
list.
Specifies the volume pool(s) for the schedule. Do not use this option if a
disk storage unit is the residence for the schedule. If "*NULL*" is
specified, the volume pool for the schedule is the volume pool of the
policy which contains this schedule.
Specify a pool for each copy.
284
bpschedulerep
To display the configured volume pools, run install_path\Volmgr\bin\vmpool -listall.
Specifies the label(s) of the storage unit to be used for storing the backups
created according to this schedule. If "*NULL*" is specified, the residence
for the schedule defaults to the residence of the policy which contains this
schedule. If the residence value is a storage unit label, the residence for
the schedule becomes that storage unit, overriding the residence for the
policy.
Specify a storage unit for each copy.
Run bpstulist to display the set of defined storage units.
-stage priority number The order in which storage units are to be selected within a storage unit group:
1 = Use the storage units in the order displayed in the storage unit group dialog (default).
2 = Use the storage unit least recently used. (The storage units take turns.)
3 = Use the first storage unit in the list that is not full or down. If the storage unit is only busy, the policy waits to write to it.
The server to be used to read a backup image that was originally written
by a different media server.
sched_label
The name of the schedule to be changed. This schedule has been
previously created.
-weekday Monday 2
285
bpschedulerep
-v
Selects verbose mode. This option causes bpschedulerep to log
EXAMPLES
Example 1
Changing and schedule named test.
bpschedulerep test -cal 2
The following output is received after the change and a "bpschedule -label test" listing.
SCHED test 0 1 604800 1 0 0 0 *NULL* 0 2 0 0 0
SCHEDWIN 0 0 0 0 0 0 0 0 0 0 0 0 0 0
SCHEDRES *NULL* *NULL* *NULL* *NULL* *NULL* *NULL* *NULL* *NULL*
*NULL* *NULL*
SCHEDPOOL *NULL* *NULL* *NULL* *NULL* *NULL* *NULL* *NULL* *NULL* *NULL* *NULL*
SCHEDRL 1 1 1 1 1 1 1 1 1 1
SCHEDFOE 0 0 0 0 0 0 0 0 0 0
Example 2
For Saturday and Sunday of each week, have the window for schedule test open at 10 pm
instead of 11 pm. Also, have the window duration be 2 hours instead of 1 hour.
bpschedulerep resets the windows, and bpschedule lists the new schedule values.
bpschedulerep test -0 79200 7200 -6 79200 7200
bpschedule -U -label test
Schedule:
test
Type:
Full Backup
Frequency:
every 7 days
Maximum MPX:
1
Residence:
Volume Pool:
Daily Windows:
Sunday
22:00:00 --> Sunday
24:00:00
Monday
23:00:00 --> Monday
24:00:00
Tuesday
23:00:00 --> Tuesday
24:00:00
Thursday
23:00:00 --> Thursday
24:00:00
Friday
23:00:00 --> Friday
24:00:00
Saturday
22:00:00 --> Saturday
24:00:00
286
bpschedulerep
FILES
install_path\NetBackup\db\sched\schedule name
SEE ALSO
bpschedule
287
bpsetconfig
bpsetconfig
NAME
bpsetconfig - A program used to update a NetBackup configuration.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpsetconfig[-h host] [-u user] [file ...]
install_path\NetBackup\bin\admincmd\bpsetconfig-H
DESCRIPTION
The bpsetconfig command is used as a standalone program, or as a helper program
with the backuptrace and restoretrace commands, to update a configuration. This
command is available for all NetBackup server platforms.
OPTIONS
-h host
Specifies the host name (host) of the server or client whose configuration
will be updated.
-u user
Specifies the user (user) whose configuration will be updated.
file...
Specifies the file or files where the updates are listed. If not specified,
standard input is read.
-H
Displays the help screen.
EXAMPLE
The following example demonstrates how to set a NetBackup configuration on a different
system.
bpsetconfig -h orange.colors.org
SERVER = yellow.colors.org
SERVER = orange.colors.org
<ctl-Z>
288
bpsetconfig
The result of running the this command is to set the NetBackup configuration on the
system orange.colors.org to the designated server that follows. This means that
yellow.colors.org is the master server for the client orange.colors.org:
SERVER = yellow.colors.org
SERVER = orange.colors.org
289
bpstsinfo
bpstsinfo
NAME
bpstsinfo - Displays storage servers, logical storage units (LSUs), and image attributes.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpstsinfo -serverinfo |
-lsuinfo | -imageinfo [-servername server name]
[-serverprefix server prefix] [-lsuname lsu_name
[-lsuname lsu_name ...]] [-imagename image_name]
[-imagedate image_date] [-imagedatestart image_date]
[-imagedateend image date] [-imagetype STS_FULL_ONLY |
STS_INCR_ONLY] [-remote remote server [-remote remote
server ...]]
DESCRIPTION
The bpstsinfo command displays the attributes for storage servers, logical storage units
(LSUs), and images that reside on disk. Authorized users can execute this command. All
errors for this command go to stderr. In addition, a log of the command's activity is sent
to the NetBackup admin log file for the current day.
For more information about NetBackup authorization, refer to "Enhanced Authorization
and Authentication" in the NetBackup System Administrator's Guide.
OPTIONS
-serverinfo
Optional argument. Print server information. Can be used in conjunction
with -lsuinfo and -imageinfo.
-lsuinfo
Optional argument. Print LSU information. Can be used in conjunction
with -serverinfo and -imageinfo.
-imageinfo
Optional argument. Print image information. Can be used in conjunction
with -serverinfo and -lsuinfo.
-imagedate image_date
Used to specify a single image.
Acceptable formats:
03/08/2005 09:41:22
1110296416
Can be used with -imageinfo only.
290
bpstsinfo
Cannot be used with -imagedatestart or -imagedateend.
-servername server name
Optional argument. server_name is the hostname of the STS server. If
-servername is not specified, the hostname of the local host is used.
-serverprefix server prefix
Optional filtering argument. By default, all server prefixes are used.
Specify server prefix to limit to one prefix. Valid prefixes are "ntap:" and
"STSBasicDisk:".
-lsuname lsu name [-lsuname lsu name ...]
Optional filtering argument. By default, all LSUs are used. Specify lsu
name to limit to one LSU for each -lsuname supplied.
-imagename image name
Optional filtering argument. By default, all images are used. Specify
image name to limit to only matching images.
-imagedatestart image date
MM/DD/YYYY HH:MM:SS to limit the images to something that is equal to
or newer than the image date.
-imagedateend image date
MM/DD/YYYY HH:MM:SS to the images to something that is equal to or
newer than the image date.
-imagetype image type
Optional filtering argument. By default, both full and incremental
images are used. Specify <image type> of STS_FULL_ONLY or
STS_INCR_ONLY to limit to only a specific image type.
-remote server name [-remote remote server ...]
Optional argument to do remote query for disk information for each
-remote supplied. Can be used with -serverinfo, -lsuinfo,
-imageinfo, or -deleteimage.
EXAMPLES
Example 1
List the attributes of the NearStore storage server named apricot:
bpstsinfo –serverinfo -serverprefix "ntap:" -servername apricot
ServerInfo:
Server Name: apricot
Supported Stream Formats:
[
291
bpstsinfo
TAR
]
Server Flags: (STS_SRV_IMAGELIST | STS_SRV_CRED |
STS_SRV_CONRW)
Media: (STS_LSU_MEDIUM_DISK)
Maximum Connections: 128
Current Connections: 4
Supported Interfaces:
[
10.80.104.74
]
Supported Credentials:
[
STS_CRED_MD5
]
Example 2
List the attributes of the lsu /vol/dsu1 on NearStore storage server apricot:
bpstsinfo –lsuinfo -serverprefix "ntap:" -servername apricot -lsuname /vol/dsu1 LsuInfo:
Server Name: mmnetapp2
LSU Name: /vol/dsu1
Descprition:
Attention:
Severity: STS_ESNONE
Message:
Size: 171798691840
Bytes Used: 8895016960
Maximum Transfer: 2048
Block Size: 4096
Resident Images: 47
SaveAs: (STS_SA_CLEARF | STS_SA_IMAGE)
Media: (STS_LSU_MEDIUM_DISK)
Example 3
List the attributes of the images on the lsu /vol/dsu1 on the NearStore storage server
apricot:
bpstsinfo –imageinfo -serverprefix "ntap:" -servername apricot -lsuname /vol/dsu1
ImageInfo:
Image Name: monel_1119652734_C1_F1
Date: 1119652734
Full Date: Policy: db_backup
292
bpstsinfo
SaveAs: (STS_SA_CLEARF | STS_SA_IMAGE)
Stream Format: TAR
Type: STS_IMG_FULL
Server Name: apricot
LSU Name: /vol/dsu1
Size: 17596416
Block Size: 8192
Exports:
/vol/dsu1/nbu_monel_C1_F1.CLF_db_backup_0000(STS_EXFS_NFS)
Status: (STS_II_IMAGE_CREATED | STS_II_FILES_CREATED)
293
bpstuadd
bpstuadd
NAME
bpstuadd - Create a NetBackup storage unit group or a storage unit.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpstuadd -group group_name
stunit_name ... stunit_name [-sm selection_method]
install_path\NetBackup\bin\admincmd\bpstuadd -label storage_unit_label
-path path_name | {-density density_type [-rt robot_type -rn
robot_number]} [-host host_name] [-cj max_jobs] [-odo
on_demand_only_flag] [-dt disk_type] [-flags flags] [-cf
clearfiles] [-tt transfer_throttle] [-hwm
high_water_mark] [-lwm low_water_mark] [-okrt
ok_on_root] [-mfs max_fragment_size] [-maxmpx mpx_factor]
[-nh NDMP_attach_host] [-nodevhost] [-verbose] [-M
master_server,...]
NOTICE for Pre-NetBackup 6.0 Media Servers:
The -tt, -hwm, -lwm, and -okrt options are ignored and set
appropriately.
DESCRIPTION
The bpstuadd command creates a NetBackup storage unit or storage unit group. When
creating a single storage unit, ensure you include a label for the new storage unit and
either the -density or the -path option. The bpstuadd command will not create the
storage unit if the master server has already created the maximum number of storage
units allowed by its NetBackup configuration. The command will not create a storage unit
that specifies the same destination medium as an existing storage unit.
Note This command does not enable you to change a disk storage unit (DSU) or a tape
storage unit to a disk staging storage unit (DSSU). In addition, you cannot change a
DSSU to a DSU or a tape storage unit.
There are several types of storage units. The storage-unit type affects how NetBackup
stores the data. The options on the bpstuadd command line determine the storage-unit
type, which is one of the following:
◆ Disk. The storage destination is a disk file system directory.
◆ Disk Staging. A disk staging storage unit (DSSU) addresses the automatic (or
scheduled sweeping) of images from the DSSU to the final storage unit.
294
bpstuadd
◆ Media Manager. The storage destination is a medium (a tape or optical device)
managed by the Media Manager.
◆ NDMP. An NDMP storage unit is controlled by Media Manager. The NetBackup for
NDMP option must be installed. Where the Media Manager storage-unit type is
discussed in this command description, the discussion also applies to the NDMP
storage-unit type, unless it is specifically excepted. The media for an NDMP storage
unit always attach directly to an NDMP host and cannot be used to store data for
other NetBackup clients. When defining an NDMP storage unit, the bpstuadd
command must be run on the master server. Refer to the NetBackup for NDMP
System Administrator’s Guide for more information on adding NDMP storage units.
Errors go to stderr. A log of the command's activity goes to the NetBackup admin log file
for the current day. See the NetBackup system administrator's guide for additional
information on storage units.
OPTIONS
-cf clearfiles 0 | 1 This option enables the Nearstore P3 feature to do block-level sharing and
reduce the total amount of disk space being used. If cf = 0, then data is
backed up, bit for bit, like backing up to a basic disk. If cf = 1 then the
Nearstore enables block level sharing.
-cj max_jobs
The maximum number of concurrent jobs permitted for this storage unit.
max_jobs is a non-negative integer. The appropriate value depends on
your server's ability to comfortably run multiple backup processes and
the available space on the storage media. Also, refer to Maximum Jobs
per Policy in the NetBackup System Administrator’s Guide.
0 means that this storage unit will never be selected when a job is being
scheduled. The default is 1.
-density density_type
If this option is present, the storage unit type is Media Manager. There is
no default for this option. Either -density, or -path must be on the
command line. Do not use -path when -density is being used. If the
robot type is specified on the command line, the value for density should
be consistent with the robot type.
Valid density types are:
dlt - DLT Cartridge
dlt2 - DLT Cartridge alternate
295
bpstuadd
8mm - 8mm Cartridge
4mm - 4mm Cartridge
Note The following densities are supported only on NetBackup Enterprise Servers.
hcart2 - 1/2 Inch Cartridge alternate
dtf - DTF Cartridge
-dt disk_type
Enables the user to specify a disk type. For example, valid values for
disk_type: are: 1 (basic), 2 (nearstore), or 3 (snapvault).
-flags flags
Specifies the storage unit to be a staging storage unit. This allows for a
quick restore. Valid values for flags are: NONE or STAGE_DATA Currently valid for only disk storage units.
-group group_name stunit_name...stunit_name
Add a storage unit group, specifiying the group name and the storage
unit(s) that comprise the group. Add multiple storage units to the storage
unit group by separating the names with a space. The maximum length of
a storage unit group label is 128 characters.
-help
the command line.
-host host_name
Note NetBackup Server does not support remote media servers.
The NetBackup host that is associated with the destination media. The
default is the hostname of the local system.
The host you select must be either your NetBackup master server or a
remote media server (if you are configuring remote media servers). The
host name must be the network name for the server as known by all
NetBackup servers and clients.
If host_name is a valid network name, but it has not been configured in
NetBackup previously, host_name will be added to NetBackup's
configuration as a media server. On UNIX, this shows up as a SERVER
296
bpstuadd
entry in the bp.conf file; on Windows, servers are specified in Host
Properties for the server, in the Servers list. If host_name is not a valid
network name, you must configure it manually.
-hwm high_water_mark
This option is a user-configurable threshold. The valid range for the High
Water Mark is 0..100 percentage, and the default setting is 98% (the
pre-NetBackup 6.0 setting is 100%). When the High Water Mark is
reached, NetBackup will become proactive, under two different
circumstances:
- When initiating a job, and the total capacity is used, the DSU is
considered to be Full. If choosing from multiple storage units in a Storage
Unit Group, media and device selection (MDS) will not assign a new job
to a storage unit whose used capacity is at or above the High Water Mark;
it will look for another Storage Unit in the group, to assign to the job.
- During a job, if the Staging attribute is set, and the total capacity is used,
staging expires images to free space on the DSU. This happens to
accommodate more backup data.
-label storage_unit_label
The name of the storage unit. This is a required option unless you are
using -group. The maximum length of a storage-unit label is 128
characters.
-lwm low_water_mark
This option is a user-configurable threshold, used by Disk Storage Units
that do staging. The valid range for the Low Water Mark is 0..100
percentage, and the default setting is 80% (the pre-NetBackup 6.0
behavior is to delete 2 or 10 images).
When the High Water Mark is reached, one of the following would need
to happen:
- You would want to migrate images to other storage units, until the "Low
Water Mark" is reached.
- You would need to free disk space by expiring disk images for the oldest
staged images, until the "Low Water Mark" is reached.
NOTE: If the you want to save most of your data, then you would configure the Low Water Mark stting near your High Water Mark.
-mfs max_fragment_size
The maximum fragment size specifies, in megabytes, how large a
fragment for a NetBackup image can be. NetBackup supports a
maximum fragment size of 1,000,000 megabytes (1 terabyte).
297
bpstuadd
For a Media Manager storage unit, this value is either zero or any integer
greater than or equal to 50 megabytes (MB) and less than or equal to
1,048,576 megabytes (1024GB). The default value is 0, meaning the
maximum of 1,048,576 megabytes.
For a Disk storage unit, this value ranges from 20 megabytes to 512,000
megabytes (512GB). The default value is 512GB.
-maxmpx mpx_factor
The maximum multiplexing factor. Multiplexing sends concurrent,
multiple backups from one or several clients to a single drive. Refer to the
topic "Multiplexing (MPX)" in the NetBackup system administrator's
guide.
The multiplexing factor can range from 1 to 32. 1 means no multiplexing.
A value greater than 1 means that NetBackup can create multiplexed
images on the destination medium. Licensing determines the effective
subset of the 1,_,32 range for the local NetBackup installation.
The default is 1.
-M master_server
the command. If an error occurs for any master server, processing stops at
that point. The default is the master server for the system where the
command is entered.
-nh NDMP_attach_host
Specifies the hostname of the NDMP server. If this option is present, the
storage unit type is set to NDMP. The default is no NDMP server.
-nodevhost
Indicates that there is to be no media server associated with this storage
unit.
-odo on_demand_only_flag
The On-Demand-Only flag controls the condition under which
NetBackup uses the storage unit:
To make the storage unit available only to policies or schedules that
request it, set the flag to 1 (enabled).
To make the storage unit available to any policy or schedule, set the flag
to 0 (disabled).
If the storage unit's type is Disk, the default is 1; NetBackup uses the storage unit only when explicitly requested. Otherwise, the default is 0.
DSSU’s are on-demand-only. They have to be explicitly chosen as a back-up target.
298
bpstuadd
-okrt ok_on_root
If this flag is not set, neither backups nor directory creation will occur on
the root file system. If the ok_on_root flag is set, then backups and
directory creations happen normally.
The default value for this flag is 0. (The pre-NetBackup 6.0 setting is 1.)
This means that backups and directory creations to a disk storage unit
(Basic Disk) will not occur if the path is on the root file system.
-path path_name
The path to a disk filesystem, expressed as an absolute pathname. This is
the data storage area for this storage unit. When this option is present,
the storage unit type is Disk. There is no default for this option. Either
-path or -density must be on the command line. Do not use
-density when -path is being used.
In general when this option is used, it is recommended that the
On-Demand-Only flag be enabled (see -odo). Otherwise, any NetBackup
policy that does not require a specific storage unit has the opportunity to
fill the disk filesystem path_name. This can cause serious system
problems. For instance, if the system swap area happens to be on the
same filesystem, new processes may fail.
-rn robot_number
The robot number for this storage unit. The robot number must be greater
than or equal to 0. The robot number can be obtained from the Media
Manager device configuration. The Media Manager system
administrator’s guide discusses the rules concerning the use of this
number. This option is ignored unless the -rt option is present. There is
no default for this option.
-rt robot_type
The robot type for this storage unit. For non-robotic (standalone) devices
select NONE or omit this option. The default value is NONE (Not Robotic).
The value for density should be consistent with the robot type.
If this option is set to any value other than NONE, the -rn option is
required. Available robot type codes are:
NONE - Not Robotic
TSH - Tape Stacker Half-inch
TLH - Tape Library Half-inch
299
bpstuadd
-sm selection_method
Allows you to select the method in which you chose a storage unit group.
This command is only valid for storage units groups, and the valid
values for selection_method are:
Prioritized = 1 (DEFAULT)
Least Recently Selected = 2
Failover = 3 -tt transfer_throttle
The Transfer Throttle setting appears for SnapVault storage units only.
The setting indicates the maximum SnapVault data transfer bandwidth.
A setting of zero (default) indicates an unlimited bandwidth and data
transfer would occur at the full network bandwidth. (Range: 0 (default) to
9999999.)
-verbose
EXAMPLES
Example 1
Create a new storage unit, named hatunit. Its storage unit type is Disk. The path for the
storage unit is C:\tmp\hatdisk:
bpstuadd -label hatunit -path C:\tmp\hatdisk -verbose
<2>bpstuadd: INITIATING: NetBackup 3.2Beta created: 98121513
<2>bpstuadd: EXIT status = 0.
Example 2
Note The following example refers to remote media servers and applies only to
NetBackup Enterprise Server. NetBackup Server supports only a master server, not
remote media servers.
Create a storage unit using a UNIX server, which has not been configured previously in
NetBackup:
% bpstuadd -label parrot_stu -host parrot -density dlt -rt TLD -rn 2
The remote media server parrot was added to the bp.conf file.
You must also install NetBackup and Media Manager on parrot and run the
add_slave_on_clients executable on the master server.
300
bpstuadd
% grep parrot /usr/openv/netbackup/bp.conf
SERVER = parrot
RETURN VALUES
bpstuaddnew: EXIT status = exit status
FILES
EMM database
SEE ALSO
bpstudel, bpstulist, bpsturep
301
bpstudel
bpstudel
NAME
bpstudel - Delete a NetBackup storage unit or storage unit group.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpstudel -label storage_unit_label
install_path\NetBackup\bin\admincmd\bpstudel -group group_name
DESCRIPTION
The bpstudel command deletes a NetBackup storage unit or storage unit group. The
command must include either a label name for the storage unit or a group name for the
storage unit group, but not both.
If bpstudel cannot delete the storage unit (if for instance, if the storage unit label is
mistyped on the command line), it does not return an error message. You can run
bpstulist to verify that the storage unit was deleted.
log file for the current day. See your NetBackup system administrator’s guide for
additional information on storage units.
OPTIONS
The name of the storage unit. This is a required option. The maximum
length for a storage-unit label is 128 characters.
-group group_name
The name of a storage unit group. If this option is present, the named
storage unit group is deleted.
-M master_server
A list of master servers. This is a comma-separated list of host names. If
the command. If an error occurs for any master server, processing stops
at that point. The default is the master server for the system where the
command is entered.
302
bpstudel
-verbose
EXAMPLES
Delete the storage unit named tst.dsk, listing the existing storage units before and after the
deletion:
bpstulist
stuunit 0 mango 0 -1 -1 1 0 C:\tmp\stuunit 1 1 2000 *NULL*
tst.dsk 0 mango 0 -1 -1 3 0 C:\hsm3\dsk 1 1 2000 *NULL*
bpstudel -label tst.dsk
bpstulist
stuunit 0 mango 0 -1 -1 1 0 C:\tmp\stuunit 1 1 2000 *NULL*
FILES
EMM database
SEE ALSO
bpstuadd, bpstulist, bpsturep
303
bpstulist
bpstulist
NAME
bpstulist - Display one or all of the NetBackup storage units or storage unit groups.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpstulist -label
storage_unit_label,...,storage_unit_label
[-L|-l|-U|-show_available|-lsa] [-g|-go] [-verbose]
[-M master_server,...,master_server]
install_path\NetBackup\bin\admincmd\bpstulist [-group group_name]
DESCRIPTION
The bpstulist command displays the attributes for a NetBackup storage unit or storage
unit group. If no storage unit label or storage unit group name is specified, the command
displays the attributes for all NetBackup storage units or storage unit groups. In addition,
this command will accept a comma-separated list of storage unit labels and display the
information for each of the storage units. The -show_available and -lsa flags provide
you with a way to list all of the configured media servers for a particular storage unit.
log file for the current day. See your NetBackup system administrator's guide for
OPTIONS
List-type options:
-L
The list type is long. This option produces a listing with one storage-unit
attribute per line, in the format storage-unit attribute: value. Some
attribute values are expressed in both interpreted and raw form. For
instance, a robot-type entry might be TL4 (7) (7 is NetBackup's internal
value for a TL4 robot).
For a disk storage unit, a long listing has these attributes for each storage
unit:
- Label
- Storage Unit Type (For example, Disk Staging (6))
304
bpstulist
- Media Subtype
- Host Connection
- Concurrent Jobs
- On Demand Only
- Path
- Robot Type (not robotic)
- Max Fragment Size
- Max MPX
- Stage data
- High Water Mark
- Ok On Root
For a Media Manager storage unit, a long listing has these attributes for
each storage unit:
- Label
- Storage Unit Type (For example, Disk Staging (6))
- Media Subtype
- Host Connection
- Concurrent Jobs
- On Demand Only
- Path
- Robot Type
- Max Fragment Size
- Max MPX/drive
- Stage data
- High Water Mark
- Low Water Mark
- Ok On Root
-l
The list type is short. This produces a terse listing. This option is useful
report format. This is the default list type.
A single line contains the information for a storage unit, with all attribute
values expressed in raw form. The fields on this line are:
- label
- storage unit type
- host
305
bpstulist
- robot_type
- robot_number
- density
- concurrent_jobs
- initial_mpx
- path
- on_demand_only
- max_mpx
- maxfrag_size
- ndmp_attach_host
-U
The list type is user. This option produces a listing with one storage-unit
attribute per line, in the format storage-unit attribute: value. Attribute
values are expressed in interpreted form. For instance, a robot-type value
might be TL4, instead of 7.
For a disk storage unit, a user-type listing has these attributes for each
storage unit:
- Label
- Storage Unit Type (this is the storage-unit type)
- Storage Unit Subtype - Host Connection
- Concurrent Jobs
- On Demand Only
- Max MPX
- Path
- Max Fragment Size
- Stage data
- High Water Mark
- Ok On Root
For a Media Manager storage unit, a user-type listing has these attributes
for each storage unit:
- Label
- Storage Unit Type (this is the storage-unit type)
- Storage Unit Subtype - Host Connection
- Concurrent Jobs
- On Demand Only
306
bpstulist
- Max MPX/drive
- Path
- Max Fragment Size
- Stage data
- High Water Mark
- Low Water Mark
- Ok On Root
-g
This list type causes the storage unit list to include the storage unit
groups. The format of this option produces a listing with one storage unit
group per line, in the format group_name: group_members. This option
also includes the Selection Method value at the end of the Storage Unit
Group List.
-go
This list type causes the storage unit list to include only information on
the storage unit groups.
Here are the remaining options for bpstulist:
-label storage_unit_label,...,storage_unit_label
The name of the storage unit. This is a comma-separated list of storage
unit labels. If this option is not present, the listing is for all storage units.
The maximum length for a storage-unit label is 128 characters.
-group group_name
A list that includes all defined storage units and storage unit groups. The
list type for the list of storage units is short. This produces a terse listing.
The list of storage unit groups is in the format group_name:
group_members.
-lsa
Lists all storage units in the database including any available media
servers on the media server list.
that point in the list. The default is the master server for the system where
the command is entered.
-show_available
Lists all storage units in the database including any available media
servers on the media server list.
307
bpstulist
-verbose
install_path\NetBackup\logs is defined).
EXAMPLES
Example 1
List the storage units defined on the master server apricot, using the -U display option:
bpstulist -U -M apricot
Label:
Storage Unit Type:
Host Connection:
Concurrent Jobs:
On Demand Only:
Max MPX:
Path:
Max Fragment Size:
redtest
Disk
apricot
1
yes
4
/usr/redtest
512000 MB
Label:
Storage Unit Type:
Host Connection:
Number of Drives:
On Demand Only:
Max MPX/drive:
Density:
Robot Type/Number:
Max Fragment Size:
bluetest
Media Manager
apricot
6
yes
1
4mm - 4mm Cartridge
TL4 / 0
1048576 MB
Example 2
The following output is realized using the following bpstuadd command to create a a
regular disk storage unit:
bpstuadd -label apple -path /tmp/apple -flags STAGE_DATA
regular Disk STU
- creates a Short output:
apple 0 felix.min.veritas.com 0 -1 -1 1 0 "/tmp/apple" 1 1 2000 *NULL*
Long output:
Label:
Media Type:
Host Connection:
Concurrent Jobs:
308
apple
Disk (0)
felix.min.veritas.com
1
bpstulist
On Demand Only:
Path:
Robot Type:
Max Fragment Size:
Max MPX:
yes
"/tmp/apple"
(not robotic)
512000 MB
1
FILES
EMM database
SEE ALSO
bpstuadd, bpstudel, bpsturep
309
bpsturep
bpsturep
NAME
bpsturep - Replace selected NetBackup storage unit attributes.
SYNOPSIS
install_path\NetBackup\bin\Admincmd\bpsturep -label storage_unit_label
[-verbose] [-host host_name | -nodevhost] [-cj max_jobs]
[-odo on_demand_only_flag] [-mfs max_fragment_size]
[-maxmpx mpx_factor] [-dt disk_type] [-cf 0|1] [-flags
flags] [-tt transfer_throttle] [-hwm high_water_mark]
[-lwm low_water_mark] [-okrt ok_on_root]
install_path\NetBackup\bin\admincmd\bpsturep [{-path path_name} |
{-density density [-rt robot_type -rn robot_number]} | {-nh
NDMP_attach_host}]
install_path\NetBackup\bin\admincmd\bpsturep -group storage_unit_group
[-addstu | -delstu] storage_unit [-M master_server,...]
[-sm selection_method]
NOTICE for Pre-NetBackup 6.0 Media Servers:
The -tt, -hwm, -lwm, and -okrt options are ignored and set
appropriately.
DESCRIPTION
The bpsturep command modifies an existing NetBackup storage unit by replacing
selected storage-unit or storage-unit-group attributes in the NetBackup catalog. The
command line must include a label for the storage unit or a group name for the storage
unit group. The label or group name is the only storage-unit attribute that bpsturep
cannot modify.
Note This command does not enable you to change a disk storage unit (DSU) or a tape
storage unit to a disk staging storage unit (DSSU). In addition, you cannot change a
DSSU to a DSU or a tape storage unit.
Use the bpsturep command with care. The changes to the storage unit or storage unit
group must be compatible with existing attributes. Make sure resulting attribute
combinations are valid, especially for the following attributes:
robot_type
robot_number
density_type
310
bpsturep
max_fragment_size
path_type
NDMP_attach_host
The safest way to modify these attributes is to run bpsturep once for each attribute to be
replaced.
bpsturep makes the changes by deleting the old storage unit and adding a new storage
unit with the specified attribute changes. Therefore, if bpsturep specifies invalid options
or an invalid combination of options, the storage unit may be deleted without being
re-added. It is best to run bpstulist after bpsturep to determine whether the
intended changes were actually applied.
Errors go to stderr. A log of the command's activity goes to the NetBackup administrative
log file for the current day. See your NetBackup system administrator's guide for
OPTIONS
-cf clearfiles 0 | 1 This option enables the Nearstore P3 feature to do block-level sharing and
reduce the total amount of disk space being used. If cf = 0, then data is
backed up, bit for bit, like backing up to a basic disk. If cf = 1 then the
Nearstore enables block level sharing.
-cj max_jobs
The maximum number of concurrent jobs permitted for this storage unit.
max_jobs is a non-negative integer. The appropriate value depends on
your server's ability to comfortably run multiple backup processes and
the available space on the storage media. Also, refer to the Maximum
Jobs per Policy topic in your NetBackup system administrator's guide.
0 means that this storage unit will never be selected when a job is being
scheduled. The default is 1.
-density density_type
If this option is present, the storage unit type is Media Manager. There is
no default for this option. One of -density or -path must be on the
command line, but not both. If the command line includes a robot type,
the value for density should be consistent with the robot type.
Valid density types are:
dlt - DLT Cartridge
dlt2 - DLT Cartridge alternate
311
bpsturep
8mm - 8mm Cartridge
4mm - 4mm Cartridge
Note: The following densities apply only to NetBackup Enterprise
Servers.
hcart2 - 1/2 Inch Cartridge alternate
dtf - DTF Cartridge
-dt disk_type
Enables the user to specify a disk type. For example, valid values for
disk_type: are: 1 (basic), 2 (nearstore), or 3 (snapvault).
-flags flags
Specifies the storage unit to be a staging storage unit. This allows for a
quick restore. Valid values for flags are: NONE or STAGE_DATA Currently valid for only disk storage units.
-group storage_unit_group
The name of a storage unit group. This is the storage unit whose
members bpsturep adds or deletes. Use -addstu storage_unit to add
storage units to the group. Use -delstu storage_unit to remove storage
units from the group.
-host host_name
Note: NetBackup Server does not support remote media servers.
The NetBackup host to which the destination media is attached. The
default is the hostname of the local system.
The host you select must be either your NetBackup master server or a
media server (if you are configuring media servers). The host name must
be the network name for the server as known by all NetBackup servers
and clients.
If host_name is a valid network name and is not yet configured in
NetBackup, the value host_name will be added to NetBackup's
configuration as a media server. On UNIX, this shows up in bp.conf; on
Windows, this shows up in the Configuration window for Servers. If
host_name is not a valid network name, you must configure it manually.
312
bpsturep
-hwm high_water_mark
This option is a user-configurable threshold. The default setting for the
High Water Mark is 98% (the pre-NetBackup 6.0 setting is 100%). When
the High Water Mark is reached, NetBackup will become proactive,
under two different circumstances:
- When initiating a job, and the total capacity is used, the DSU is
considered to be Full. If choosing from multiple storage units in a Storage
Unit Group, media and device selection (MDS) will not assign a new job
to a storage unit whose used capacity is at or above the High Water Mark;
it will look for another Storage Unit in the group, to assign to the job.
- During a job, if the Staging attribute is set, and the total capacity is used,
staging expires images to free space on the DSU. This happens to
accommodate more backup data.
The name of a storage unit. This is the storage unit whose attributes
bpsturep replaces. This is a required option. The maximum length of a
storage-unit label is 128 characters.
-lwm low_water_mark
This option is a user-configurable threshold, used by Disk Storage Units
that do staging. The default setting for the Low Water Mark is 80% (the
pre-NetBackup 6.0 behavior is to delete 2 or 10 images).
When the High Water Mark is reached, you should do one of the
following:
- Migrate images to other storage units, until the "Low Water Mark" is
reached.
- Free disk space by expiring disk images for the oldest staged images,
until the "Low Water Mark" is reached.
NOTE: If the you want to save most of your available data, then configure
the Low Water Mark stting near the High Water Mark. In addition, the
Low Water Mark must be less than High Water Mark. They cannot be
equal settings.
-mfs max_fragment_size
The maximum fragment size specifies, in megabytes, how large a
fragment for a NetBackup image can be. NetBackup supports a
maximum fragment size of 1,000,000 megabytes (1 terabyte).
For a Media Manager storage unit, this value is either zero or any integer
greater than or equal to 50 megabytes (MB) and less than or equal to
1,048,576 megabytes (MB) or (1024GB). The default value is 0is equivalent
to the largest value allowed, 1024GB.
For a Disk storage unit, this value ranges from 20 megabytes to 2000
megabytes (2 gigabytes). The default value is 524288 (512GB).
313
bpsturep
-maxmpx mpx_factor
The maximum multiplexing factor. Multiplexing sends concurrent,
multiple backups from one or several clients to a single drive. Refer to
the topic "Multiplexing (MPX)" in your NetBackup system
administrator's guide.
The multiplexing factor can range from 1 to 32, where 1 means no
multiplexing. A value greater than 1 means that NetBackup can create
multiplexed images on the destination medium. Depending on the
licensing of the local NetBackup installation, it may not be possible to
assign multiplexing factors in the entire range 1..32.
The default is 1.
-M master_server_
-nh NDMP_attach_host
Specifies the hostname of the NDMP server. If this option is present, the
storage unit type is set to NDMP. The default is no NDMP server.
-nodevhost
Indicates that there is to be no media server associated with this storage
unit.
-odo on_demand_only_flag
The on-demand-only flag controls whether the storage unit is used only
for backups that explicitly request (demand) the storage unit:
To make the storage unit available only to policies or schedules that
request it, set the flag to 1 (enabled).
To make the storage unit available to any policy or schedule, set the flag
to 0 (disabled).
If the storage unit's type is Disk, the default is 1; NetBackup uses the storage unit only when explicitly requested. Otherwise, the default is 0.
-okrt ok_on_root
If this flag is not set, neither backups nor directory creation will occur on
the root file system. If the ok_on_root flag is set, then backups and
directory creations happen normally.
The default value for this flag is 0. (The pre-NetBackup 6.0 setting is 1.)
This means that backups and directory creations to a disk storage unit
(Basic Disk) will not occur if the path is on the root file system.
314
bpsturep
Note: Root on Windows is the Volume that the windows\system
directory resides on .
-path path_name
The path to a disk filesystem, expressed as an absolute pathname. This is
the data storage area for this storage unit. When this option is present,
the storage unit type is Disk. There is no default for this option. One of
-density or -path must be on the command line, but not both.
In general when this option is used, it is recommended that the
on-demand-only flag be enabled (see -odo). Otherwise, any NetBackup
policy that does not require a specific storage unit has the opportunity to
fill the disk filesystem path_name. This can cause serious system
problems. For instance, if the system swap area happens to be on the
same filesystem, new processes may fail.
If the path name is defined as a disk staging storage unit (DSSU), then
this option can be used to change the path name a different DSSU. It
cannot be used to change a DSSU to a different type of storage unit.
-rn robot_number
The robot number for this storage unit. The robot number must be
greater than or equal to 0. The robot number can be obtained from the
Media Manager device configuration. The Media Manager system
administrator’s guide discusses the rules concerning the use of this
number. This option is ignored unless the -rt option is present. There is
no default for this option.
-rt robot_type
The robot type for this storage unit. For non-robotic (standalone) devices
select NONE or omit this option. The default value is NONE (Not Robotic).
The value for density should be consistent with the robot type
If this option is set to any value other than NONE, the -rn option is
required.
Available robot type codes are:
NONE - Not Robotic
TSH - Tape Stacker Half-inch
TLH - Tape Library Half-inch
315
bpsturep
-sm selection_method
Allows you to select the method in which you chose a storage unit group.
This command is only valid for storage units groups, and the valid
values for selection_method are:
Prioritized = 1 (DEFAULT)
Least Recently Selected = 2
Failover = 3 -tt tansfer_throttle
The Transfer Throttle setting appears for SnapVault storage units only.
The setting indicates the maximum SnapVault data transfer bandwidth.
A setting of zero (default) indicates an unlimited bandwidth and data
transfer would occur at the full network bandwidth. (Range: 0 (default) to
9999999.)
-verbose
EXAMPLES
Change the path for a disk storage unit, mkbunit. The path is changed from
C:\tmp\mkbunit to C:\tmp\mkbunit2:
bpstulist
mkbunit 0 beaver 0 -1 -1 1 0 C:\tmp\mkbunit 1 1 2000 *NULL*
bpsturep -label mkbunit -path C:\tmp\mkbunit2
bpstulist
mkbunit 0 beaver 0 -1 -1 1 0 C:\tmp\mkbunit2 1 1 2000 *NULL*
FILES
EMM database
SEE ALSO
bpstuadd, bpstudel, bpstulist
316
bptestbpcd(1M)
bptestbpcd(1M)
NAME
bptestbpcd - Test bpcd connections and verify connect options.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bptestbpcd [-connect_options 0|1|2 0|1|2 0|1|2|3] [-host host_name] [-client client_name] [-M server] [-wait_to_close seconds] [-verbose] [-debug]
DESCRIPTION
The bptestbpcd command will attempt to establish a connection from a
NetBackup server to the bpcd daemon on another NetBackup system. If
successful, it will report information about the sockets that are
established.
The first line of output is three digits representing the effective connect
options. The first digit is 0 if reserved ports are used and 1 if
non-reserved ports are used. The second digit is 0 if legacy (random port)
call-back is used and 1 if vnetd call-back is used. The third digit is 1 if the
connection is initiated on the vnetd port number and 2 if the connection is
initiated on the legacy bpcd port number.
The second and third lines display the NetBackup server IP address and
port number, the direction of the connection, and the bpcd IP address and
port number for the first two sockets established. If the connection is to a
NetBackup client, a third socket is established and the NetBackup server
IP address and port number, the direction of the connection, and the bpcd
IP address and port number is displayed in an additional line.
OPTIONS
-connect_options 0|1|2 0|1|2|3 0|1|2|3
The first setting indicates the type of port to use to connect to bpcd on the
client:
0 = Use a reserved port number.
1 = Use a nonreserved port number. If you select this option, enable
Allow Nonreserved Ports for the client. See the Universal Settings dialog
under Host Properties > Media Servers. (See "Accept Connections on
Non-reserved Ports" in NetBackup System Administrator's Guide for
UNIX, Volume I.)
2 = Use the value defined by the DEFAULT_CONNECT_OPTIONS
configuration entry on the server.
317
bptestbpcd(1M)
The second setting indicates the bpcd call-back method to use to connect
to the client:
0 = Use the traditional call-back method.
1 = Use the vnetd no call-back method.
The third setting indicates the connection method to use to connect the client:
0 = Connect to a daemon on the client using vnetd if possible, otherwise connect using the traditional port number of the daemon.
1 = Connect to a daemon on the host using vnetd only.
2 = Connect to a daemon on the server using the traditional port number of the daemon only.
If -connect_options is not specified, the configured connect options from the client database, the CONNECT_OPTIONS configuration entry
and/or the DEFAULT_CONNECT_OPTIONS configuration entry will be used.
-client client_name
The client name of the system to connect to. If neither -host nor
-client is specified, the host name of the local system will be used.
-debug
Display debug logging information to standard error rather than the
normal debug log file.
-host host_name
The host name of the system to connect to. Typically, host_name will be
the host name of a NetBackup server. If neither -host nor -client is
specified, the host name of the local system will be used.
-M server
The host name of the NetBackup server that inititates the connection. If
-server is specified, the host name of the local system will be used.
-wait_to_close seconds
Number of seconds to wait before closing the sockets after the connection
to bpcd is established. The default is 0.
-verbose
Display additional information about the bpcd host or client such as the
bpcd protocol number.
318
bptestbpcd(1M)
EXAMPLES
Example 1
In this example, a connection from the local system to server fred is
attempted using the legacy connect options:
# cd /usr/openv/netbackup/bin/admincmd
# ./bptestbpcd -host fred -connect_options 0 0 2
0 0 2
10.0.0.32:748 -> 10.0.0.59:13782
10.0.0.32:983 <- 10.0.0.59:635
Example 2
In this example, a connection from the server fred is attempted to the
client barney using the vnetd port number if possible:
# cd /usr/openv/netbackup/bin/admincmd
# ./bptestbpcd -M fred -client barney -connect_options
2 2 0
1 1 1
10.0.0.59:40983 -> 10.0.0.104:13724
10.0.0.59:40984 -> 10.0.0.104:13724
10.0.0.59:40985 -> 10.0.0.104:13724
319
bpup
bpup
NAME
bpup - Starts NetBackup services on Windows systems.
SYNOPSIS
install_path\NetBackup\bin\bpup [-h] [-S|v] [-f] [-a] [-c] [-d]
[-m] [-n] [-s]
DESCRIPTION
The bpup command is used to start NetBackup services including the NetBackup
databases, Media Manager, and clients.
OPTIONS
-h
This option displays the help screen.
-S
This options enables you to select silent mode. With this option, no listing
is generated and no confirmation is requested.
-v
This options selects the verbose mode and generates a detailed listing.
-f
This option forces the startup of the NetBackup services without
prompting the user for a confirmation.
-c
This option starts the client.
-d
This option starts the NetBackup database.
-m
This option starts Media Manager.
-n
This option starts the NetBackup services.
-s
This option starts the server and not the client (NetBackup Media
Manager).
320
bpup
SEE ALSO
bpdown
321
bpverify
bpverify
NAME
bpverify - Verify the backups created by NetBackup.
SYNOPSIS
install_path\NetBackup\bin\admincmd\bpverify [-l] [-p] [-pb] [-v]
[-local] [-client name] [-st sched_type] [-sl sched_label]
[-L output_file [-en]] [-policy name] [-s date] [-e date]
[-M master_server] [-Bidfile file_name] [-pt policy_type]
[-hoursago hours] [[-cn copy number] |
[-primary]][-backupid backup_id] [-id media_id | path]
DESCRIPTION
bpverify verifies the contents of one or more backups by reading the backup volume
and comparing its contents to the NetBackup catalog. This operation does not compare
the data on the volume with the contents of the client disk. However, it does read each
block in the image, thus verifying that the volume is readable. NetBackup verifies only
one backup at a time and tries to minimize media mounts and positioning time.
If either -Bidfile or -backupid is specified, bpverify uses this option as the sole
criterion for selecting the set of backups it will verify. If the command line does not
contain -Bidfile or -backupid, then bpverify selects the backups that satisfy all the
selection options. For instance, if the command line looks like
bpverify -pt Standard -hoursago 10
then bpverify verifies the set of backups with policy type Standard that have been run
in the past 10 hours.
If -p or -pb is specified, bpverify previews the set of backups that meet the selection
criteria. In this case, bpverify displays the backup IDs, but does not perform the
verification.
bpverify sends its error messages to stderr. bpverify sends a log of its activity to
the NetBackup admin log file for the current day (found in
install_path\NetBackup\Logs\admin).
322
bpverify
OPTIONS
-Bidfile file_name
file_name specifies a file that contains a list of backup IDs to be verified.
remove the file.
The file contains one backup ID per line. If this option is specified, other
selection criteria are ignored. The default is no file of backup IDs,
meaning any backup can be verified.
-backupid backup_id
Specifies the backup ID of a single backup to verify. This option takes
precedence over any other selection criteria except -Bidfile. The default
is any backup.
-policy name
Search for backups to verify in the specified policy. The default is any
policy.
-client name
Specifies the name of the client that produced the original backup. The
default is any client.
-cn copy_number|-primary
Determines the copy number of the backup ID to verify. Valid values are 1
through the setting indicated by the bpconfig -max_copies setting,
up to 10. The default is 1.
-primary indicates that the primary copy should be verified rather than
the copy.
-pt policy_type
Specifies the policy type for selecting backups to verify. The default is any policy type.
The valid policy types are the following:
AFS
DataStore
DB2
FlashBackup
Informix-On-BAR
323
bpverify
Lotus-Notes
MS-Exchange-Server
MS-SQL-Server
MS-Windows
NCR-Teradata
NDMP
NetWare
Oracle
OS/2
SAP
Split-Mirror
Standard
Sybase
-e date
Specifies the end of the time range for selecting backups to verify. The -s
option or the -hoursago option specifies the start of the range.
follows:
The default ending time is the current date and time.
-help
the command line.
-hoursago hours
Specifies the number of hours before the current time to search for
backups. This is equivalent to specifying a start time (-s) of the current
time minus hours. Do not use both this option and the -s option.
Hours is a non-negative integer. The default starting time is 24 hours ago.
-id media_id | path
Search the image catalog for backups to verify that are on this media ID
or pathname. If a backup has some fragments on this media ID and some
fragments on another media ID, NetBackup skips verifying that backup.
For images stored on disk rather than removable media, specify an
absolute pathname instead of media_id. The default is any media ID or
pathname.
324
bpverify
default is to not use a progress file, in which case the progress
information is written to stderr. For additional information, see
DISPLAY FORMATS later in this command description.
-l
Specifies that the list type is long, causing bpverify to write additional
information to the progress log. The default list type is short. For
additional information, see DISPLAY FORMATS later in this command
description.
-local
When bpverify is initiated from a host other than master server and the
-local option is not used (default), bpverify starts a remote copy of
the command on the master server.
Monitor.
Use the -local option to prevent the creation of a remote copy on the master server and to run the bpverify only from the host where it was
initiated.
If the -local option is used, bpverify cannot be canceled from the Activity Monitor.
-M master_server
Specifies the master server that provides the bpverify image data. The
master server must allow access by the system issuing the bpverify
command. The default is the master server for the system where
bpverify is entered:
For NetBackup Server:
The default is always the master server where the command is entered.
If the command is entered on a master server, then that server is the
default.
If the command is entered on a remote media server, then the master for
that media server is the default.
325
bpverify
-p
Previews the verification, but does not perform the verification. For
additional information, see DISPLAY FORMATS later in this command
description.
-pb
Previews the verification but does not perform the verification. This is
similar to the -p option, but -pb does not display information about the
individual backups. For additional information, see DISPLAY FORMATS
later in this command description.
-s date
Specifies the start of the range of dates and times that include all
backups to verify. The -e option specifies the end of the range. The format
of date depends on the user's locale setting. See the NOTES section for
more information. For the C locale, the date syntax is as follows:
The default is 24 hours ago.
-sl sched_label
Search for backups to verify that were created by the specified schedule.
The default is all schedules.
-st sched_type
Search for backups to verify that were created by the specified schedule
type. The default is any schedule type.
Valid values are:
FULL (full backup)
UBAK (user backup)
UARC (user archive)
-v
Selects verbose mode. When -v is specified, the debug and progress logs
include more information. The default is not verbose.
DISPLAY FORMATS
PREVIEW DISPLAYS:
bpverify runs a preview by searching for backups and displaying them. bpverify
does not actually verify the backups.
326
bpverify
◆ The -p display lists backup IDs that meet the criteria set by the bpverify
command-line options. The -p display is ordered by volume. For each volume
containing a selected backup, the media ID and server are displayed, followed by the
selected backup Ids that reside on that volume
◆ The -pb display is a brief version of the -p display. It lists the media ID and server for
each volume that contains backups that meet the selection criteria.
VERIFICATION DISPLAYS:
bpverify creates these displays as it verifies images. If the bpverify command line
contains no option to set the list format, the display format is short. If the command line
contains -l, the display format is long. If the command line contains both -l and -L,
bpverify creates a file containing the progress log.
The verification display is ordered by volume.
◆ In long format, bpverify displays the following information for each selected
backup ID:
Policy, schedule, backup ID, media ID or path, and creation time
Files backed up
Any problems that bpverify detects while verifying the image
Whether the image verification is successful or not ◆ In short format, bpverify omits listing the files backed up.
NOTES
The format that you must use for date and time option values varies according to the
locale setting. The examples in this command description are for a locale setting of C.
EXAMPLES
Example 1
The following example verifies the backups run in the past 36 hours:
bpverify -hoursago 36
Verify started Thu Feb 3 11:30:29 2003
INF - Verifying policy mkb_policy, schedule Full
(plim_0949536546), path /tmp/mkbunit, created 02/02/01 18:09:06.
INF - Verify of policy mkb_policy, schedule Full
(plim_0949536546) was successful.
INF - Status = successfully verified 1 of 1 images.
Example 2
The following example compares the two preview displays, -p and -pb:
327
bpverify
bpverify -p -hoursago 2002
Media id = A00002 Server = plim
Bid = plim_0949616279 Kbytes = 32800 Filenum = 1 Fragment = 1
Bid = gava_0949681647 Kbytes = 12191 Filenum = 2 Fragment = 1
Media id = 400032 Server = plim
Bid = toaster2_0950199621 Kbytes = 298180
Bid = toaster2_0950199901 Kbytes = 298180
Filenum = 1
Filenum = 3
Fragment = 1
Fragment = 1
bpverify -pb -hoursago 200
Media id = A00002 Server = plim
Media id = 400032 Server = plim
RETURN VALUES
bpverify: EXIT status = exit status
FILES
install_path\NetBackup\db\error\*
328
bpverify
SEE ALSO
NetBackup System Administrator’s Guide
329
cat_convert
cat_convert
NAME
cat_convert - NetBackup catalog format conversion utility.
SYNOPSIS
install_path\NetBackup\bin\cat_convert.exe -a2b [-o] [-s] [-v]
source_file or directory [target_file or directory]
install_path\NetBackup\bin\cat_convert.exe -dump [-short]
[-noheader] [-nopath] [-nodata] [-srec num] [-sep
char] source_file
DESCRIPTION
cat_convert converts NetBackup catalog .f files between version 3.4, 4.0v or 4.5
ASCII format and 4.5 binary format. cat_convert automatically detects the source
catalog file format and converts it to the other format. NetBackup 6.0 does not support
writing new ASCII catalog images (however, reading existing ASCII catalog images is still
supported).
Starting with NetBackup 6.0, a new -dump option has been added to that enables users to
view the contents of the binary catalog image .f (dot-f) files. Run cat_convert -? to
see this new option. It will echo the contents of the .f file to stdout in a readable format.
There are also some helper options that can be used to limit the output to only certain
records in the file or a subset of the output columns.
OPTIONS
-a2b
Convert NetBackup 3.4, 4.0V, 4.5 ASCII format catalog .f file(s) to
NetBackup 4.5 binary format .f file(s).
-dump
Enables users to view the contents of catalog image .f files.
-o
Overwrite original catalog file content with the new, converting format.
-o cannot be used with target_file_directory.
-s
Show statistic information to the console window.
330
cat_convert
-erec
An option that modifies the output from the cat_convert -dump. Stops
displaying records at this record number.
Note: The record number is not necessarily the same as the file number in
the first column of the output.
-nodata
An option that modifies the output from cat_convert -dump. An option
that modifies the output from the cat_convert -dump. Eliminates the data
column. The data column can result in lots of output that is of no interest
in some situations.
-noheader
that modifies the output from the cat_convert -dump. Eliminates the
column headers.
-nopath
that modifies the output from the cat_convert -dump. Eliminates the path
column. The path column can result in lots of output that is of no interest
in some situations.
-short
An option that modifies the output from cat_convert -dump. Limits the
output to a subset of the usual columns.
-srec num
that modifies the output from the cat_convert -dump. Starts displaying
records at this record number.
Note: The record number is not necessarily the same as the file number in
the first column of the output.
-sep char
that modifies the output from the cat_convert -dump. Use this char to
separate the columns instead of the white space default separation. For
example, you can use this command to generate a comma-separated
output.
-v
Show current progress information.
Specify either a single source file or an entire directory to convert:
◆
To specify a target file, the source must be a file.
◆
To specify a target directory, the source must be a directory.
331
cat_convert
If the source is a directory, you must use -a2b.
The new files created by the conversion are converted to the specified format and the
original file names are used in the target directory.
If the target file or directory is not specified when converting source files, the new files
created by the conversion process will have a suffix appended (_bin.f or _ascii.f).
If the catalog .f file size is more than 4 megabytes, the binary catalog leaves output
files separate and puts them in the catstore directory.
EXAMPLES
Example 1
Consider the following command:
cat_convert -a2b abc.f
If abc.f is in ASCII format, the target_file_path will be abc_bin.f.
Example 2
C:\usr\tmp\abc1.f
abc.f will be converted to binary and copied to C:\usr\tmp\abc1.f.
Example 3
cat_convert -a2b C:\home\john\catalog
Every ASCII .f file in /home/john/catalog will be converted to the NetBackup 4.5
binary format with new file name *_bin.f.
Example 4
The contents of abc.f will be converted to binary.
Example 5
332
cat_convert
cat_convert -dump -short abc.f
The contents of abc.f will be displayed to stdout in a user-readable format.
333
create_nbdb
create_nbdb
NAME
create_nbdb – Used to create the NBDB database manually.
SYNOPSIS
install_path\NetBackup\bin\create_nbdb -db_server server_name
[-drop] [-sz small | medium | large] [-dba new_password] [-data data_directory] [-index index_directory] [-tlog log_directory] [-mlog log_mirror_directory] DESCRIPTION
This command is used to create the NetBackup database (NBDB) manually. This
command can be used to drop the existing NBDB database, and to recreate it using
non-default parameters that were used during installation. A user can change the default
location of the data, index, and transaction log files; change the size of the pre-allocated
database files; and add an additional mirrored transaction log for increased database
protection.
OPTIONS
The create_nbdb command, without any options, verifies the version of an existing
database and is used during upgrades. If a database does not exist, it creates it using
default parameters.
-db_server server_name
This option is the name of the ASA server that is located in the server.conf
file.
-drop
This option is used to drop the existing NBDB database.
-sz small | medium | large
This option changes the size of the pre-allocated database files. The
default size used during installation is small.
-data data_directory
Used to identify the directory of the main database files.
-dba new_password
Sets the password for the NBDB and BMRDB databases for all DBA and
application accounts. The default password used during installation is
nbusql. To only change the password for an existing database, use
nbdb_admin -dba new_password.
334
create_nbdb
-index index_directory
Used to identify the directory of the index database files.
-mlog log_mirror_directory
Used to create a mirrored log for increased database protection.
-tlog log_directory
Identifies the location of the transaction log.
335
duplicatetrace
duplicatetrace
NAME
duplicatetrace – Trace debug logs for duplicate job(s).
SYNOPSIS
install_path\NetBackup\bin\admincmd\duplicatetrace [-master_server name] -job_id number [-start_time hh:mm:ss] [-end_time hh:mm:ss] mmddyy [mmddyy …]
install_path\NetBackup\bin\admincmd\duplicatetrace [-master_server name] -backup_id id [-start_time hh:mm:ss] [-end_time hh:mm:ss] mmddyy [mmddyy …]
install_path\NetBackup\bin\admincmd\duplicatetrace [-master_server name] [-policy_name name] [-client_name name] [-start_time hh:mm:ss] [-end_time hh:mm:ss] mmddyy [mmddyy …]
DESCRIPTION
duplicatetrace consolidates the debug logs for the specified duplicate job[s] and writes
them to standard output. The messages will be sorted by time. duplicatetrace will attempt
to compensate for time zone changes and clock drift between remote servers and clients.
At a minimum, you must enable debug logging for install_path\NetBackup\admin
directory on the master server and for bptm/bpdm on the media server. For best results,
set the verbose logging level to 5 and enable debug logging for bpdbm on the master
server and bpcd on all servers and clients in addition to the processes already identified.
If either -job_id or -backup_id is specified, duplicatetrace uses this option as the sole criteria
for selecting the duplicate job[s] it will trace. The options –policy_name or –client_name
cannot be used in conjunction with –job_id or –backup_id. If –job_id or –backup_id are
not specified then all duplicate jobs that match the specified selection criteria will be
selected. If none of the options namely, -job_id, -backup_id, -policy_name or -client_name
is specified, then all the duplicate jobs executed on the days specified by day stamps
(mmddyy) will be traced. If –start_time/-end_time options are used then the debug logs in
the specified time interval are examined.
If duplicatetrace is started with the -backup_id bid option then duplicatetrace will
look for duplicate jobs started via bpduplicate with -backup_id bid option where the
backup IDs (bid ) match.
If duplicatetrace is started with the –policy_name <policy> option then duplicatetrace will
look for duplicate jobs started via bpduplicate with –policy <policy> option where the
policy names (<policy>) match.
336
duplicatetrace
If duplicatetrace is started with the –client_name <client> option then duplicatetrace will
look for duplicate jobs started via bpduplicate with –client <client> option where the
client names (<client>) match.
duplicatetrace writes error messages to standard error.
OPTIONS
-master_server
-job_id
Job ID number of the duplicate job to analyze. Default is any job ID.
-backup_id
Backup ID number of the backup image duplicated by the duplicate job
to analyze. Default is any backup ID.
-policy_name
Policy name of the duplicate jobs to analyze. Default is any policy.
-client_name
Client name of the duplicate jobs to analyze. Default is any client.
-start_time
-end_time
mmddyy
One or more “day stamps”. This identifies the log file names
(log.mmddyy for UNIX, mmddyy.log for Windows) that will be
analyzed.
OUTPUT FORMAT
daystamp
millisecs
program
The name of program (ADMIN, BPTM, BPCD, etc.) being logged.
337
duplicatetrace
sequence
machine
log_line
EXAMPLES
Example 1
The following example analyzes the log of duplicate job with job ID 3 executed on August
6, 2004.
duplicatetrace -job_id 3 080604
Example 2
The following example analyzes the log of duplicate jobs that duplicate backup image
with backup ID pride_1028666945 executed on August 20, 2004. This command would
analyze only those duplicate jobs, which were executed with option -backupid
pride_1028666945.
duplicatetrace -backup_id pride_1028666945 082004
Example 3
The following example analyzes the log of duplicate jobs executed on policy
Pride-Standard and client pride on August 16, 2004 and August 23, 2004. This command
would analyze only those duplicate jobs, which were executed with options -policy
Pride-Standard and -client pride.
duplicatetrace -policy_name Pride-Standard -client_name pride 081604 082304
Example 4
The following example analyzes the log of all duplicate jobs that are executed on August
5, 2004 and August 23, 2004.
duplicatetrace 080504 082304
338
importtrace
importtrace
NAME
importtrace – Trace debug logs for import job(s).
SYNOPSIS
install_path\NetBackup\bin\admincmd\importtrace [-master_server name] -job_id number [-start_time hh:mm:ss] [-end_time hh:mm:ss] mmddyy [mmddyy]
install_path\NetBackup\bin\admincmd\importtrace [-master_server name] -backup_id id [-start_time hh:mm:ss] [-end_time hh:mm:ss] mmddyy [mmddyy]
install_path\NetBackup\bin\admincmd\importtrace [-master_server name] [-policy_name name] [-client_name name] [-start_time hh:mm:ss] [-end_time hh:mm:ss] mmddyy
[mmddyy]
DESCRIPTION
importtrace consolidates the debug log messages for the specified import job[s] and writes
them to standard output. The messages will be sorted by time. importtrace will attempt to
compensate for time zone changes and clock drift between remote servers and clients.
At a minimum, you must enable debug logging for install_path\NetBackup\admin
directory on the master server, and for bpbrm, bptm and tar on the media server. For best
results, set the verbose logging level to 5 and enable debug logging for bpdbm on the
master server and bpcd on all servers and clients in addition to the processes already
identified.
If either -job_id or -backup_id is specified, importtrace uses this option as the sole criteria
for selecting the import job[s] to trace. The options –policy_name or –client_name cannot
be used in conjunction with -job_id or -backup_id. If -job_id or -backup_id are
not specified then all import jobs that match the specified selection criteria will be
selected. If none of the options namely, -job_id, -backup_id, -policy_name or
-client_name is specified, then all the import jobs executed on the days specified by
day stamps (mmddyy) will be traced. If –start_time/-end_time options are used then the
debug logs in the specified time interval are examined.
If importtrace is started with the -backup_id id option then importtrace will look for
import jobs started via bpimport with -backup_id id option where the backup ids (id)
match.
If importtrace is started with the –policy_name <policy> option then importtrace will look
for import jobs started via bpimport with –policy <policy> option where the policy names
(<policy>) match.
339
importtrace
If importtrace is started with the –client_name <client> option then importtrace will look
for import jobs started via bpimport with –client <client> option where the client names
(<client>) match.
importtrace writes error messages to standard error.
OPTIONS
-master_server
-job_id
Job ID number of the import job to analyze. Default is any job ID.
-backup_id
Backup ID number of the backup image imported by the import job to
analyze. Default is any backup ID.
-policy_name
Policy name of the import jobs to analyze. Default is any policy.
-client_name
Client name of the import jobs to analyze. Default is any client.
-start_time
-end_time
mmddyy
One or more day stamps. This identifies the log file names (log.mmddyy
OUTPUT FORMAT
daystamp
millisecs
program
The name of program (ADMIN, BPBRM, BPCD, etc.) being logged.
sequence
340
importtrace
machine
log_line
EXAMPLES
Example 1
The following example analyzes the log of import job with job ID 4 executed on August 6,
2002.
importtrace -job_id 4 080602
Example 2
The following example analyzes the log of import jobs that import backup image with
backup id pride_1028666945 executed on August 20, 2002. This command would analyze
only those import jobs, which were executed with option -backupid pride_1028666945.
importtrace -backup_id pride_1028666945 082002
Example 3
The following example analyzes the log of import jobs executed on policy Pride-Standard
and client pride on August 16, 2002 and August 23, 2002. This command would analyze
only those import jobs, which were executed with options -policy Pride-Standard and
-client pride.
importtrace -policy_name Pride-Standard -client_name pride 081602 082302
Example 4
The following example analyzes the log of all import jobs that are executed on August 5,
2002 and August 17, 2002.
importtrace 080502 081702
341
nbdb_admin
nbdb_admin
NAME
nbdb_admin – Used to start or stop individual databases, as well as change the default
password.
SYNOPSIS
install_path\NetBackup\bin\nbdb_admin -dba new_password |
[-start|stop [database_name]] | [-vxdbms_nb_data
directory] | [-vxdbms_nbdb_backup_owner y|n]
[-auto_start NONE | NBDB | BMRDB] [-list]
DESCRIPTION
The nbdb_admin command can be used to start or stop the NetBackup database or the
BMR database.
The nbdb_admin command line utility is required to enable the customer to change the
DBA and application passwords. The DBA and application passwords are encrypted and
stored in the vxdbms.conf file. Secure SSL is used for encryption, and keys are handled
in a consistent manner with the rest of NetBackup. The passwords are encrypted with
AES-128-CFB using the NetBackup private key. The permissions on the file will only
enable it to be read or written by the root user on UNIX or a Windows Administrator.
During installation, the default password of nbusql is used for the NBDB and BMRDB
databases for all DBA and application accounts. Note, the same password is used for the
NBDB and BMRDB DBA and application accounts, for example, EMM_MAIN.
OPTIONS
-auto_start NONE | NBDB | BMRDB
Sets which databases are automatically started when the database server
is started. Either the NetBackup database (NBDB), or the BMR database
(BMRDB) can be specified. The database daemon must be stopped and
restarted to take effect. Or the user can elect to not start either database by
using NONE.
-dba new_password
Enbles you to change the default password, nbusql, for the NBDB and
BMRDB databases for all DBA and application accounts.
-list
Lists all database files.
342
nbdb_admin
-start|stop database_name
Starts or stops the NBDB database identified in the database_name field.
Using the database_name field is optional and is where the user specifies
the NBDB or the BMRDB databases. The NBDB database is the default
for this command.
-vxdbms_nb_data directory
This command updates the VXDBMS_NB_DATA parameter that is stored
in the registry. This parameter contains the main location of the NBDB
and BMRDB databases.
-vxdbms_nbdb_backup_owner y|n
This command updates the VXDMS_NBDB_BACKUP_OWNER
parameter in the registry. This command specifies if the master server
owns the backup of the databases that are included in the catalog backup.
The default for this parameter is, yes.
343
nbdb_backup
nbdb_backup
NAME
nbdb_backup – A command line program used to make a backup of the databases in a
directory.
SYNOPSIS
install_path\NetBackup\bin\nbdb_backup [-dbn database_name]
[-offline |-online] destination_directory
DESCRIPTION
The nbdb_backup command enables the customer to make either an online or offline
backup of the ASA database files to a file system directory. A user would use this
command if they are doing some sort of maintenance operation and need to make a copy
of a database.
OPTIONS
-dbn database_name
Sets the database, identified in database_name, to be backed up. The
possible databases are NBDB and BMRDB. The default is to backup both
databases if installed on the server.
-offline |-online
Enables either an offline or online backup of the ASA database files.
Online means the database is up and running during the backup. Offline
shuts down the database.
destination_directory
Used to identify the directory where the backup will be stored.
344
nbdb_move
nbdb_move
NAME
nbdb_move – Enables you to move the location of the NBDB database files after
installation.
SYNOPSIS
install_path\NetBackup\bin\nbdb_move -data data_directory [-index
index_directory] [-tlog log_directory] [-mlog
log_directory] [-config_only]
DESCRIPTION
The nbdb_move command can be used to move the database files from the default
directory locations to customer-specified directories to separate data from indexes and
transaction logs to improve performance. Users can also use this command to move
database files (data files and transaction files) to the default location. On Windows
systems, the default location is install_path\NetBackupDB\data.
nbdb_move will move the database files for both the NBDB and BMRDB database, if
present.
OPTIONS
-config_only
This command only updates the configuration files with the directory
locations specified. The database files will not be moved. A user can use
this command in a recovery situation, when the database files have
already been relocated manually, and they need to save their
configuration settings.
-data data_directory
Used to move the main database files to customer-specified directories
designated by data_directory.
-index index_directory
Used to change the directory of the index database files.
-mlog log_directory
This option can create a mirrored transaction log and put it in a
designated directory location. If a mirrored log already exists, this
command can be used to move it to a different location.
-tlog log_directory
Used to change the transaction log directory.
345
nbdb_ping
nbdb_ping
NAME
nbdb_ping – Displays the status of the NetBackup database (NBDB) or BMR database
(BMRDB).
SYNOPSIS
install_path\NetBackup\bin\nbdb_ping [-dbn BMRDB ]
DESCRIPTION
The nbdb_ping command is used to check and display the status of the NetBackup
database (NBDB) or the BMR database (BMRDB). Entering the command with no options
displays the status of NBDB.
OPTIONS
-dbn BMRDB
Displays the status of the BMRDB database.
346
nbdb_restore
nbdb_restore
NAME
nbdb_restore – Used to recover a database that has been backed up to a directory using
nbdb_backup.
SYNOPSIS
install_path\NetBackup\bin\nbdb_restore -recover source_directory
DESCRIPTION
The nbdb_restore command does a restore and recovery from a backup to a directory
using nbdb_backup. The recommended method for protection of the Sybase ASA NBDB
and BMRDB databases is through the Catalog Backup interfaces.
OPTIONS
-recover source_directory
The location of the backup.
347
nbdb_unload
nbdb_unload
NAME
nbdb_unload – unload the NetBackup databases (NBDB) or BMR (BMRDB)
SYNOPSIS
install_path\NetBackup\bin\nbdb_unload [-dbn database_name] [-t
tablelist] [-s] destination directory
DESCRIPTION
The nbdb_unload command unloads the specified database. By default the NBDB
database is unloaded. The other value for -dbn includes, BMRDB for the Bare Metal
Restore database.
Note The Enterprise Media Manager (EMM) Database is considered a component of the
NBDB database. In the future other components will be added to the NBDB, for
example, IRM, POLICY, etc.
This command creates .dat files, one for each table in the database or table list. Each .dat
file contains comma separated lines, one for each row in the table. There is also a
reload.sql file generated. This file contains the SQL statements required to reload the
database, for example,
LOAD TABLE "BmrDba.BMR_Configuration" FROM c:\temp\data\345.dat.
The contents of the destination directory can be transferred to a support machine and
used to create a copy of the customer's database by running the reload.sql file.
OPTIONS
-dbn database_name
Specifies the database that is to be unloaded.
-s Unloads the schema only - no data is unloaded.
-t tablelist
Specifies a comma separated list of tables to unload instead of all the
tables in the database.
destination directory
The directory where a user wants the dump of the data and schema to go.
EXAMPLES
1. To unload the NBDB database (including all of EMM), data and schema:
348
nbdb_unload
nbdb_unload c:\temp\nbdb_dump
2. To unload just the NBDB schema:
nbdb_unload -s c:\temp\nbdb_dump
3. To unload just the EMM_StorageUnit table (using fully qualified table names):
nbdb_unload -t EMM_MAIN.EMM_StorageUnit c:\temp\emm_stu
4. To unload the BMR database:
nbdb_unload -dbn BMRDB c:\temp\bmr_dump
.
349
nbemm
nbemm
NAME
nbemm – NetBackup Enterprise Media Manager Daemon is used to manage volumes,
volume pools, barcode rules, and devices.
SYNOPSIS
install_path\NetBackup\bin\nbemm [-console] [-terminate]
DESCRIPTION
The Enterprise Media Manager service manages volumes, volume pools, barcode rules
and devices. This daemon performs media, drive, drive path, and storage unit selection.
In addition, nbemm acts as the device allocator (DA) SSO environments. In this case,
nbemm is known as nbemm/DA. For more information about nbemm/DA, refer to the
NetBackup Media Manager System Administrator’s Guide for Windows.
Note: The nbemm service must be active to change the volume configuration, device
configuration, storage unit configuration, and for any tape mount activity.
To start nbemm, enter: install_path\NetBackup\bin\nbemm.
To stop nbemm, enter: install_path\NetBackup\bin\nbemm -terminate.
OPTIONS
-console
This option enables you to start NetBackup in console mode.
-terminate
This option enables you to stop the nbemm binary.
SEE ALSO
nbemmcmd
350
nbemmcmd
nbemmcmd
NAME
nbemmcmd – enables users to update and view information in the EMM database tables.
SYNOPSIS
install_path\NetBackup\bin\admincmd\nbemmcmd [-addhost]
[-changesetting] [-deletehost] [-getemmserver] [-help]
[-listhosts] [-listmedia] [-listsettings]
[-machinealias] [-renamehost] [-servercontrol]
[-updatehost]
The usage statements for each of the subcommands are listed below:
install_path\NetBackup\bin\admincmd\nbemmcmd -addhost
[-activenodename string] [-clustername string]
[-displayname string] [-machinedescription string]
-machinename string -machinetype api | cluster |
master | media | ndmp [-masterserver string]
[-netbackupversion level.major levelminor level]
[-operatingsystem hpux | linux | netware | rs6000 |
solaris | tru64 | windows] [-scanability unsigned
integer]
install_path\NetBackup\bin\admincmd\nbemmcmd -changesetting
[-allow_multiple_retentions_per_media 0 | 1 | no | yes
[-disable_automatic_host_name_add 0 | 1 | no | yes]
[-disable_standalone_drive_extensions 0 | 1 | no |
yes] [-disallow_nonndmp_on_ndmp_drive 0 | 1 | no |
yes] [-do_not_eject_standalone 0 | 1 | no | yes]
[-drive_error_threshold unsigned integer]
-machinename string [-max_realloc_tries unsigned
integer] [-media_error_threshold unsigned integer]
[-media_request_delay unsigned integer]
[-must_use_local_drive 0 | 1 | no | yes]
[-non_robotic_media_id_prefix string]
[-return_unassigned_media_to_scratch_pool no | yes]
[-scratch_pool string] [-sso_scan_ability unsigned
integer] [-time_window unsigned integer]
[-vault_clear_media_desc no | yes]
install_path\NetBackup\bin\admincmd\nbemmcmd -deletehost
-machinename string -machinetype api | cluster |
master | media | ndmp-mediaid string
351
nbemmcmd
install_path\NetBackup\bin\admincmd\nbemmcmd -deletemedia -mediaid
string -originhost string
install_path\NetBackup\bin\admincmd\nbemmcmd -deletemerge
-assignedhost string -mediaid string
install_path\NetBackup\bin\admincmd\nbemmcmd -forcemerge
-assignedhost string -mediaid string
install_path\NetBackup\bin\admincmd\nbemmcmd -getemmserver
[-masterserver string] [-timeout unsigned integer]
install_path\NetBackup\bin\admincmd\nbemmcmd -setemmserver
-emmservername string [-masterserver string]
-newemmservername string [-timeout unsigned integer]
install_path\NetBackup\bin\admincmd\nbemmcmd -listhosts
[-machinename string] [-masterserver string]
[-nbservers] [-netbackupversion level.major levelminor
level] [-verbose]
install_path\NetBackup\bin\admincmd\nbemmcmd -listmedia
[-allrecords] [-conflicts] [-mediaid string]
[-mediatype unsigned integer] [-mergetable] [-poolname
string] [-robotnumber unsigned integer]
[-vaultcontainer string]
install_path\NetBackup\bin\admincmd\nbemmcmd -listsettings
-machinename string
install_path\NetBackup\bin\admincmd\nbemmcmd -machinealias
machinealias [-addalias] [-alias string]
[-deletealias] [-deleteallaliases] [-getaliases]
[-machinename string] -machinetype master | media |
ndmp
install_path\NetBackup\bin\admincmd\nbemmcmd -renamehost
-machinename string -newmachinename string
install_path\NetBackup\bin\admincmd\nbemmcmd -servercontrol
[-resume] [-suspend]
install_path\NetBackup\bin\admincmd\nbemmcmd nbemmcmd -updatehost
[-activenodename string] [-clustername string]
[-displayname string] [-machinedescription string]
-machinename string [-machinestate unsigned integer]
[-machinetype master | media | ndmp |api | cluster]
[-masterserver string] [-netbackupversion level.major
levelminor level] [-operatingsystem hpux | linux |
netware | rs6000 | solaris | tru64 | windows]
352
nbemmcmd
DESCRIPTION
The nbemmcmd command enables users to update a limited set of EMM database
information. In addition, this command enables you to manage host entries, configuration
options, and other miscellaneous items in the EMM database.
OPTIONS
The following commands contain a variety of options that enable you to manage the
EMM database. The options names are purposely long to provide the user with a better
understanding of the command options are to be used to do. Because of the option
lengths, you can type smallest number of characters as a subset of characters that make it
a unique option. For example, if you wanted to use the -renamehost command, you
could type the letters, -r, and that command would be used, because there is no other
command option like it that starts with the letter r.
-addhost This option adds the specified host to the EMM database. The following
entries can be adjusted using this command option:
-activenodename string
The variable, string, identifies the active node in a cluster.
-clustername string
The variable string identifies a cluster to which this machines belongs.
-displayname string
Displays the assigned name of a machine that is equivalent to the
numbered identifier for that machine.
-machinedescription string
Users can use this option as a descriptive field to describe their machine
or system.
-machinename string
Displays the numbered identifier for a machine.
-Machinetype api | cluster | master | media | ndmp
This option enables you to define what the machine will be used as.
-masterserver string
Defines the host master server in a particular domain.
353
nbemmcmd
-netbackupversion level.major levelminor level Enables you to add a host and specify the version it is running. The
level varibable as a range of 0-99. The major level and minor
level variables are single digit fields that are optional. There should be
no spaces between the major level and minor level variables.
-operatingsystem hpux | linux | netware | rs6000 | sgi | solaris | tru64 | windows
Adds a host with a designated operating system.
-scanability unsigned integer
This option works the same as the -nbemmcmd -changesetting -sso_scan_ability command. The following describes this option.
SSO_SCAN_ABILITY = scan_factor
This configuration entry applies only to NetBackup Enterprise Server.
This vm.conf entry is used only with the shared storage option (SSO) feature and is read and interpreted on the host where ltid is running.
A scan ability factor can range from zero to 9, with a default value of 5. This factor allows the assignment of scan hosts to be prioritized, if a drive's scan host changes. Scan hosts that have a higher scan ability factor are chosen first.
In some SSO configurations, you may have servers that are undesirable
for use as the scan host for a drive. This may be because they have limited resources, are behind firewalls, or are being administered by people other than NetBackup administrators. These servers can be configured to never become the scan host for any drive. A scan_factor of zero means that a
server will not become the scan host.
Caution A drive is unavailable for use until a scan host can be assigned for it. If all hosts
that register for a particular drive use scan_factor = 0, the drive will enter an
unusable state until a host with a scan_factor of non-zero registers for the drive.
If all hosts with a scan_factor of non-zero have the drive DOWN, then again the
drive becomes unavailable due to the lack of a scan host.
The decision to use a scan_factor of zero for a server, reduces the level of
resiliency in your SSO configuration. Careful attention to those servers
that can be a scan host is required, asthe loss of a scan host for a drive
makes it unavailable to any server.
354
nbemmcmd
-changesetting
This option changes the configuration setting for a specified host. You
can also use this option to add settings if it did not previously exist. The
following options can be changed by using the -changesetting
command along with each of these options.
The descriptions for each of these options brief summaries. These
settings are describe in detail in the VERITAS NetBackup Media Manager
System Administrator’s Guides.
-allow_multiple_retentions_per_media 0|1|no|yes
The ALLOW_MULTIPLE_RETENTIONS_PER_MEDIA option allows
NetBackup to mix retention levels on media. Default: This option is not
present and each volume can contain backups of only a single retention
level.
Use this option by adding it to the /usr/openv/netbackup/bp.conf file
on NetBackup servers or check the Allow Multiple Retentions per Media
setting in the Media dialog under server host properties.
-disable_automatic_host_name_add 0|1|no|yes Enables EMM to automatically add a host name if the host name appears
to be valid. An example of an invalid host name would be a name that
duplicates another host.
-disable_standalone_drive_extensions 0|1|no|yes
Disables the nonrobotic drive operations. This means that during a
backup, NetBackup does not automatically attempt to use whatever
labeled or unlabeled media it finds in a nonrobotic drive. Default:
Standalone drive extensions are enabled.
-disallow_nonndmp_on_ndmp_drive 0|1|no|yes
This is read by the MDS logic on the EMM server.
NetBackup attempts to use an available drive based on the type of request as follows:
- For a non-NDMP request of any kind, NetBackup always tries to find
an available non-NDMP drive. If a non-NDMP drive is not available, and
a NDMP drive is available, the operation will be done using the slower
NDMP drive. non-NDMP requests include all type of requests apart from
storage unit related requests (backups and write side of duplicates) and
NDMP image restores.
355
nbemmcmd
-do_not_eject_standalone 0|1|no|yes
If this entry is specified on a given host, tapes in standalone drives will
not be ejected when a backup has completed on that host (tapes will be
ejected if end of media is reached during a backup). This entry is read and
interpreted on the host where the standalone drives are defined.
This entry can be used in a NetBackup environment where it is desirable
to keep a standalone drive ready after successful backups are performed.
-drive_error_threshold unsigned integer
Enables you to change the threshold or number of drive errors that can
occur before the media is frozen. The default value for this threshold is 2.
-max_realloc_tries unsigned integer
Enables you to set the maximum number of times some failed mount
requests are allowed to be retried (with a different drive and/or media).
-machinename string
Displays the numbered idenifier for a machine.
-media_error_threshold unsigned integer
Enables you to change the threshold or number of media errors that can
occur before the media is frozen. The default value for this threshold is 2.
-media_request_delay unsigned integer
Applies only to nonrobotic drives and specifies the number of seconds
that NetBackup waits for a drive to become ready. Default: 0 seconds.
For example, assume the delay is 150 seconds:
MEDIA_REQUEST_DELAY = 150
on NetBackup servers or enter a value for Media Request Delay in the
Media host properties.
-must_use_local_drive 0|1|no|yes
If the client is also a master server and this entry is present, backups for
this client must occur on a local drive. If the client is not a master server,
this entry has no effect.
on NetBackup master servers or check the Must Use Local Drive setting
in the General Server host properties dialog.
356
nbemmcmd
-non_robotic_media_id_prefix string
The MEDIA_ID_PREFIX can now be set using nbemmcmd.
C:\Program Files\VERITAS\NetBackup\bin\admincmd\nbemmcmd-changese
tting -machine hamex -non_robotic_media_id_prefix ABC NBEMMCMD, Version:X.X(yyyymmdd) Command completed successfully.
-return_unassigned_media_to_scratch_pool no|yes
RETURN_UNASSIGNED_MEDIA_TO_SCRATCH_POOL = YES|NO
This is an EMM global option that applies to every host that is using the
EMM server. It is not a host option.
If RETURN_UNASSIGNED_MEDIA_TO_SCRATCH_POOL = YES is
specified, Media Manager returns expired and unassigned media (media
that was originally from the same scratch pool) to the scratch volume
pool automatically.
If RETURN_UNASSIGNED_MEDIA_TO_SCRATCH_POOL = NO is
specified, the automatic behavior of returning media to the scratch pool is
disabled and must be done using one of the Media Manager
administration interfaces.
-sso_scan_ability unsigned integer
SSO_SCAN_ABILITY = scan_factor
This configuration entry applies only to NetBackup Enterprise Server.
This vm.conf entry is used only with the shared storage option (SSO) feature and is read and interpreted on the host where ltid is running.
A scan ability factor can range from zero to 9, with a default value of 5. This factor allows the assignment of scan hosts to be prioritized, if a drive's scan host changes. Scan hosts that have a higher scan ability factor are chosen first.
In some SSO configurations, you may have servers that are undesirable
for use as the scan host for a drive. This may be because they have limited resources, are behind firewalls, or are being administered by people other
than NetBackup administrators. These servers can be configured to never become the scan host for any drive. A scan_factor of zero means that a
server will not become the scan host.
357
nbemmcmd
Caution A drive is unavailable for use until a scan host can be assigned for it. If all hosts
that register for a particular drive use scan_factor = 0, the drive will enter an
unusable state until a host with a scan_factor of non-zero registers for the drive.
If all hosts with a scan_factor of non-zero have the drive DOWN, then again the
drive becomes unavailable due to the lack of a scan host.
The decision to use a scan_factor of zero for a server, reduces the level of
resiliency in your SSO configuration. Careful attention to those servers
that can be a scan host is required, asthe loss of a scan host for a drive
makes it unavailable to any server.
-time_window unsigned integer
Enables you to set value that is equal to the amount of time in which
errors can be tracked. You can use this value in conjunction with an error
threshold (for example, media_error_threshold) to monitor the number of
media errors that occur within the time window. The default setting is 12
hours.
-vault_clear_media_desc no | yes
This is an EMM global option that applies to every host that is using the
EMM server. It is not a host option.
When NetBackup media is returned from the off-site vault during a
typical tape rotation, it is expired and is ready for reuse by new backups.
To avoid confusion, it may be helpful to clear the old media description
information when an expired tape is returned to the robot.
If this entry is specified, the media description field will be cleared when
other Vault information is cleared from the Media Manager volume
database.
-deletehost -machinename string
This option removes the specified host from the EMM database.
This option enables you to define what the machine is used as.
-deletemedia
Delete an EMM media record with the specified media id and origin host.
-mediaid string
358
nbemmcmd
This is the media ID of the EMM media record.
-originhost string
This is the origin host name in the EMM media record. It indicates from
which Volume Database host this EMM media record originated.
-deletemerge
Delete a record from the mediaDB merge table with the specified media ID and assigned host.
When using optical media, deletemerge must be run twice, once for each side of the platter.
This nbemmcmd option only exists for the life of the NetBackup 6.0
release. All mediaDB merge table issues must be resolved before the next release of NetBackup is installed. At that time, this nbemmcmd option is
removed from NetBackup and the contents of the mediaDB merge table is deleted.
-assignedhost string
This is the host name in the mediaDB merge table record. It indicates
which media server has this media assigned.
-mediaid string
This is the media id of the record to delete from the mediaDB merge table.
-forcemerge
Move the contents of a specified record in the mediaDB merge table
(media id and assigned host) to the specified EMM media record (media
id and origin host). First, a new record is created in the media DB merge
table and then the existing media DB fields in the EMM media record are
moved there.
When using optical media, forcemerge must be run twice, once for each
side of the platter.
This nbemmcmd option will only exist for the life of the NetBackup 6.0
release. All mediaDB merge table issues must be resolved before the next
release of NetBackup is installed. At that time, this nbemmcmd option
will be removed from NetBackup and the contents of the mediaDB merge
table will be deleted.
-assignedhost string
359
nbemmcmd
This is the host name in the mediaDB merge table record. It indicates
which media server has this media assigned.
-mediaid string
This is the media id of the record in the mediaDB merge table to match to
an EMM media record.
-originhost string
This is the origin host name in the EMM media record. It indicates from
which Volume Database host this EMM media record originated.
-getemmserver
This command displays the information on all the hosts in a particular
EMM domain. You can use this command to insure a level of consistency
in a newly installed or modified domain. The following parameters are
available with this command:
This parameter specifies a name of a master server for an EMM domain.
If you omit this parameter when using this command, the current
machine will be assumed.
-timeout unsigned integer
This parameter specifies a temporary timeout value, in seconds, to be
used during the duration of this command.
-setemmserver
This command can be used to change the EMM server name for certain
hosts in the domain. For each host in the domain whose EMM server
name matches will have it's EMM server name changed. This command
has the following parameters:
-emmservername string
This parameter specifies the EMM server name to be changed.
-newemmservername string
This parameter specifies the new, or replacement, value for the EMM
server.
360
nbemmcmd
This parameter specifies a name of a master server for an EMM domain.
If you omit this parameter when using this command, the current
machine will be assumed.
-timeout unsigned integer
This parameter specifies a temporary timeout value, in seconds, to be
used during the duration of this command.
-help
Provides usage information and detailed help for the nbemmcmd
command. This can be obtained by typing
nbemmcmd -help command
The command variable in this example represents the command you want
help for.
-listhosts
This command and its options enables you to dump the table structure
for each known host.
-machinename string
Defines the host, master server in the domain.
-nbservers
Displays only the media and master servers. (The default for
-listhosts is to display all servers.)
-netbackupversion level.major level minor level
Enables you to add a host and specify the version it is running. The
-verbose
This option controls the amount of information NetBackup includes in its
logs. If this entry is specified, all Media Manager components on the host
are started with verbose logging enabled. This option will then provide
detailed information from the EMM database.
361
nbemmcmd
Use this option only if problems occur or if requested by VERITAS
support. After the problem is resolved, remove any debug logs that were
created or add a DAYS_TO_KEEP_LOGS entry.
-listmedia
-allrecords
Display all media records.
-conflicts
Display all media records whose conflicts field has been set.
-mediaid string
This is the media ID of the EMM media record
-mediatype unsigned integer
Query volumes by media type.
Valid media types for NetBackup Enterprise Server follow:
4mm, 8mm, 8mm2, 8mm3, dlt, dlt2, dlt3, dtf, hcart, hcart2, hcart3, odiskwm, odiskwo, qcart, 4mm_clean, 8mm_clean, 8mm2_clean, 8mm3_clean, dlt_clean, dlt2_clean, dlt3_clean, dtf_clean, hcart_clean, hcart2_clean, hcart3_clean.
Valid media types for NetBackup Server follow:
4mm, 8mm, dlt, hcart, qcart, 4mm_clean, 8mm_clean, dlt_clean, hcart_clean.
-mergetable
Display all records in the mediaDB merge table. These are mediaDB
records that could not be matched to an EMM media record.
This nbemmcmd option will only exist for the life of the NetBackup 6.0
release. All mediaDB merge table issues must be resolved before the next
release of NetBackup is installed. At that time, this nbemmcmd option is
removed from NetBackup and the contents of the mediaDB merge table is
deleted.
-poolname string
Query volumes by pool number. Pool number is an index into the volume
pool. You can use vmpool -listall to determine the index for a given pool
name.
362
nbemmcmd
-robotnumber unsigned integer
Query volumes by robot number. A robot number is a unique, logical
identification number for the robot where the volume is located.
-vaultcontainer string
List the volumes that are stored in the container. The string variable is the
vault_container_id can be a string of up to 29 alphanumeric characters.
-listsettings -machinename string
-machinealias
The following “subcommands” are used to maintain the alias list for a
particular machine. These subcommands enable you to view current
aliases, add new aliases, and delete current aliases for an identified
machine.
-addalias
Use this option to add an alias name to a machine. The proper use of this
command requires that you identify the machine name that will receive
the alias and the machine type as well. For example, to create a media
server with the alias name, blue, use the following command:
-machinealias -machinename 10.80.91.83 - Machinetype
media -addalias -alias blue -alias string
This option identifies the alias name of a machine.
-deletealias Enables you to delete an alias name from the database. This operation
requires that you identify the alias that you want to delete using the
-alias string command and machine type with this option.
-deleteallaliases Enables you to delete all aliases for a particular machine. To perform this
operation you must identify the machine name and the machine type.
-getaliases Chapter 1, NetBackup Commands
363
nbemmcmd
Enables you to retrieve all aliases for a particular machine. To perform
this operation you must identify the machine name and the machine
type.
-machinename string
-renamehost
This command, when used with -machinename string and
-newmachinename string, enables you to rename the current
numbered identifier with a new number identifier and store this name in
the database.
-machinename string
-newmachinename string
Idenifies the new numbered identifer for a machine.
-servercontrol The purpose of this command to suspend and resume control of a
specified server to enable you to perform database maintenance without
worry of corrupting existing data because a job began to run during this
time.
-resume Enables you to resume control of a specified server.
-Suspend Enables you to suspend control of a specified server.
-updatehost -machinename string This command, when used with the following sub-commands, enables
you to make changes to the record for a specified host. -activenodename string
The variable, string, identifies the active node in a cluster.
-clustername string
The variable string identifies a cluster to which this machines belongs.
-displayname string
364
nbemmcmd
Displays the assigned name of a machine that is equivalent to the
numbered identifier for that machine.
-machinename string
Defines the host, master server in the domain.
-netbackupversion level.major levelminor level
Enables you to add a host and specify the version it is running. The
-operatingsystem hpux | linux | netware | rs6000 | solaris | tru64 | windows
Adds a host with a designated operating system.
EXAMPLES
Example 1
nbemmcmd -getemmserver
These hosts were found in this domain: throttle, upwords
Checking with host: throttle...
Checking with host: upwords...
Server Type
MEDIA
MASTER
Host Version
Host Name
UNKNOWN RELEASE (0) throttle
6.0Alpha
upwords
EMM Server
throttle
upwords
One or more hosts had mismatched EMM Servers.
365
nbemmcmd
Run-time failure: The consistency check either failed or was incomplete. Command did
not complete successfully.
Example 2
nbemmcmd -setemmserver -emmservername throttle -newemm upwords
These hosts were found in this domain: throttle, upwords
Checking with host: throttle...
Checking with host: upwords...
Server Type
MEDIA
Host Version
Host Name
UNKNOWN RELEASE (0) throttle
EMM Server
throttle
EMM server name was changed.
MASTER
6.0Alpha
upwords
upwords
One media hosts had EMM Server name changed. Command completed successfully.
366
nbjm
nbjm
NAME
nbjm – NetBackup Job Manager submits jobs and acquires the resources to start the jobs.
SYNOPSIS
install_path\NetBackup\bin\nbjm [-console] [-terminate]
DESCRIPTION
The NetBackup Job Manager, nbjm, binary is a new service introduced in NetBackup 6.0.
This service is started when NetBackup is started and it remains active. The primary
function of this binary is to accept jobs that were determined to be submitted by nbpem,
acquire the resources to run them, and then start the job. This service then waits for the
completion of a job and sends a signal to nbpem when a job completes. This service also
handles all IRM communications to bpjobd for Activity Monitor information, external
resource requests, and it writes to the progress log.
OPTIONS
-console
-terminate
This option accepts an option parameter which is the number of seconds
to wait for jobs to finish before terminating. The default is 60 seconds. A
value of 0 causes nbjm to wait until all jobs are completed before
terminating. If a limit is placed on the termination, once that limit is
reached, nbjm terminates without waiting for the completion of jobs.
SEE ALSO
nbpem, nbrb
367
nbnos
nbnos
NAME
nbnos – Name of the binary for NetBackup
SYNOPSIS
install_path\NetBackup\bin\nbnos [-console] [-terminate] [-Factory
name] [-IORoutput file] [-ChannelName name] [-Channel]
DESCRIPTION
The nbnos command can be used to register an event channel, to set a channel name, to
start NetBackup in console mode, and to set a factory name.
OPTIONS
-channel
Enables you to register an event channel. The default setting is to not
register an event channel.
-ChannelName
Enables you to set the channel name. The default channel name is,
VRTS_NotifyEventChannel.
-console
-Factory name
This option enables you to set the factory name. The default value for this
setting is, VRTS_NotifyEventChannelFactory.
-terminate
This option enables you to stop nbnos.
368
nbpem
nbpem
NAME
nbpem – NetBackup Policy Exceution Manager schedules and submits jobs that are due
based on a policy worklist.
SYNOPSIS
install_path\NetBackup\bin\nbpem [-console] [-terminate]
DESCRIPTION
The NetBackup Policy Execution Manager, nbpem, is a new binary that performs many of
the functions that the bpsched binary did in previous versions of NetBackup. This binary
is a service that is started when NetBackup is started and remains active until NetBackup
is stopped.
Much like bpsched in previous releases, nbpem determines which jobs are due based on
defined policies and the previous backup images. Although the function is the same,
nbpem develops its work list differently than bpsched. The nbpem binary creates its
worklist once when it starts, determines when each job in the worklist needs to be
submitted, and then submits that job to nbjm for processing at the scheduled time. nbpem
rebuilds its work list only when a job finishes, a policy is modified, or an image expires.
Previous versions of bpsched would, based on a time interval, rebuild the work list.
In addition, this nbpem does the following:
◆ Determines a policy’s priority based on how overdue the job is.
◆ Ensures policies are scheduled within the windows in which they are supposed to
run.
◆ Cancels policies that are queued, that are late or outside the parameters of the
scheduled window.
◆ Handles any policy changes and then updates the worklist with the policies that are
due to run accordingly.
◆ Initiates retries if a particular job stopped part way through the backup.
OPTIONS
-console
-terminate
This option enables you to stop the NetBackup policy execution manager.
369
nbpem
SEE ALSO
nbjm, nbrb, nbpemreq
370
nbpemreq
nbpemreq
NAME
nbpemreq – NetBackup Policy Execution Manager Requisition, schedules jobs when jobs
are due.
SYNOPSIS
install_path\NetBackup\bin\admincmd\nbpemreq -predict -date
mm/dd/yyyy HH:MM:SS
install_path\Netackup\bin\admincmd\nbpemreq -predict -dateu
unixtime
install_path\Netackup\bin\admincmd\nbpemreq -updatepolicies
DESCRIPTION
The nbpemreq command enables a user to determine which jobs are coming due in the
near future, and to read in all policy updates that have been entered and are in a pending
state.
OPTIONS
-predict -date mm/dd/yyyy HH:MM:SS
This option provides feedback by showing what jobs are scheduled to run
in the near future. The -date command specifies the time more accurately.
-predict -dateu unixtime
This option provides feedback by showing what jobs are scheduled to run
in the near future. The -dateu command specifies the time in UNIX time
(seconds).
-updatepolicies This option tells the NetBackup policy execution manager to read in all
policy updates that are pending.
SEE ALSO
nbpem
371
nbpushdata
nbpushdata
NAME
nbpushdata – Push information from the current database files to the EMM database.
SYNOPSIS
install_path\NetBackup\bin\nbpushdata -add
install_path\NetBackup\bin\nbpushdata -add_5x_vmhost host
install_path\NetBackup\bin\nbpushdata -remove host
install_path\NetBackup\bin\nbpushdata -modify_5x_hosts
DESCRIPTION
The nbpushdata command moves data from the current database files to the EMM
database. This command is run after the upgrade installation is complete. Data will be
moved to the EMM database only when nbpushdata is run for a host that has been
upgraded to NetBackup 6.0. No data will be moved to the EMM database from any other
host except the host specified for nbpushdata.
Only a NetBackup 5.x environment with a single Global Device Database containing
unique robot numbers and unique drive names can be upgraded by nbpushdata.
Environments containing duplicate robot numbers, duplicate drive names, or other device
configuration inconsistencies will not be upgraded properly.
The EMM and database daemons must be running on the EMM Server to accept data from
nbpushdata. The NetBackup and Media Manager daemons must be started on the local
host before running nbpushdata.
NOTE: You are only to use nbpushdata to upgrade an existing supported NetBackup 5.x
environment that contains a single Global Device Database host. It is not a tool for
merging multiple NetBackup environments.
The list below shows the required order to run nbpushdata. It does not indicate the
order in which the hosts must be upgraded to NetBackup 6.0. The upgrade order may be
different than the order to run nbpushdata. For more information regarding the install
and upgrade to NetBackup 6.0, refer to the NetBackup Installation Guide for Windows .
Required order to run nbpushdata:
1. The server that was the Global Device Database Host in the previous version of
NetBackup (nbpushdata -add)
2. Master servers (nbpushdata -add)
3. Volume Database host(s) (nbpushdata -add or nbpushdata -add_5x_vmhost)
372
nbpushdata
After running nbpushdata for all Volume Database hosts, run nbpushdata
-modify_5x_hosts on each master server if you intend to leave any media servers
at a NetBackup 5.x version level.
4. Any remaining media servers (optional) (nbpushdata -add)
Hosts in groups 1, 2, and 3 must be upgraded to NetBackup 6.0 and have nbpushdata run
on them before the NetBackup environment is functional. Hosts in group 4 are not
required to be upgraded at the same time as the hosts in groups 1, 2, and 3. They may be
upgraded at a later time.
Data will be moved to the EMM database from all of the current database files (that are
listed below) that exist on the specified host. NetBackup 6.0 binaries cannot read these
files (entries for vm.conf and bp.conf) and will only access this data from the EMM
database.
◆
volmgr/database/globDB
◆
volmgr/database/ltidevs
◆
volmgr/database/robotic_def
◆
volmgr/database/.namespace.chksum (NDMP)
◆
volmgr/database/ruleDB
◆
volmgr/database/poolDB
◆
volmgr/database/volDB
◆
netbackup/db/media/mediaDB
◆
netbackup/db/config/storage_units
◆
netbackup/db/config/stunit_groups
◆
volmgr/vm.conf (Some entries)
◆
◆
DISALLOW_NONNDMP_ON_NDMP_DRIVE
◆
DO_NOT_EJECT_STANDALONE
◆
DRIVE_NAME_SEED
◆
RETURN_UNASSIGNED_MEDIA_TO_SCRATCH_POOL
◆
SSO_SCAN_ABILITY
◆
VAULT_CLEAR_MEDIA_DESC
netbackup/bp.conf or the Windows registry (Some entries)
◆
ALLOW_MULTIPLE_RETENTIONS_PER_MEDIA
◆
DISABLE_STANDALONE_DRIVE_EXTENSIONS
373
nbpushdata
◆
◆
MEDIA_ID_PREFIX
◆
MEDIA_REQUEST_DELAY
◆
MUST_USE_LOCAL_DRIVE
Touch files (Some)
◆
netbackup/DONT_USE_SLAVE
◆
netbackup/DRIVE_ERROR_THRESHOLD
◆
netbackup/MEDIA_ERROR_THRESHOLD
◆
netbackup/TIME_WINDOW
◆
volmgr/NO_STANDALONE_UNLOAD
OPTIONS
-add
Read the database files on the local host and push the information to the EMM database. Use this option when running on a master server or a media server.
When NOT_DATABASE_HOST is set in vm.conf, the poolDB, ruleDB,
and volDB files will be ignored.
The estimated time remaining for the globDB, volDB, and mediaDB files is based on the size of the file. Files that contain many deleted records
cause a high estimate for the remaining time.
When nbpushdata is run on the Global Device Database host, it attempts to contact any host found in the globDB file that does not yet have a complete host record in the EMM database. If a host is down or
inaccessible, it can take several minutes before the operation times out and nbpushdata continues with the next host. Users can avoid this delay by using nbemmcmd -addhost to create EMM host entries for down or inaccessible hosts before running nbpushdata.
Some robot conversions are done when nbpushdata is run on a host. The following changes are only done on hosts that have been upgraded to
NetBackup 6.0. Robots on NetBackup 5.x hosts are not converted. LMF
robots are deleted and their drives are changed to be standalone drives. TSD and TS8 robots are changed to TLD and TL8 robots, respectively.
The robot type changes are also made to the corresponding media and storage unit records in the EMM database.
When nbpushdata is run on Windows, the NetBackup 5.x device names
(such as,"Tape0") are converted to NetBackup 6.0 SCSI coordinate device names (such as, "{0,0,0,1}"). When a device does not return its serial
number, nbpushdata cannot do the conversion and uses "{999,999,999,999}" as the device name. After nbpushdata has 374
nbpushdata
completed, the device name can be corrected using two methods. The first method is to manually update the device name using tpconfig. The second method is to run the Device Configuration Wizard and let it update the device name.
At the completion of nbpushdata, one of the following status messages
is displayed.
- "Successfully added <host> records to EMM." All records for this host
have been successfully moved to the EMM database. You can continue. - "Partially successful adding <host> records to EMM." Some records for
this host have not been moved to the EMM database. Depending on the
number and type of records not moved to EMM, this may need to be
resolved before you can continue.
- "Failed to push <host> records to EMM." or another failure message.
This issue must be resolved before you can continue.
After running nbpushdata, restart the NetBackup and Media Manager daemons to get the updated configuration from the EMM database.
The NetBackup 5.x database files are not modified or deleted by
nbpushdata. Do not remove these files.
The vm.conf and bp.conf or Windows registry entries moved to the
EMM database are obsolete in NetBackup 6.0. Use nbemmcmd to modify
these entries. Modifying these entries in vm.conf and bp.conf, or the
Windows registry has no effect.
-add_5x_vmhost host
For situations where a 5.x media server is serving as a Volume Database
Host and cannot be upgraded to NetBackup 6.0, this option can be used
to move the poolDB, ruleDB, and volDB information to the EMM
database. Use this option when running on a master server.
At the completion of the command, the media server will no longer be a
Volume Database host and the NOT_DATABASE_HOST entry will be
added to vm.conf.
This option cannot be used when one of the hosts is a 32-bit platform and
the other host is a 64-bit platform.
-modify_5x_hosts
After nbpushdata has been run on all Volume Database hosts, run this
command on each master server that has media servers running
NetBackup 5.x. The device configuration on the 5.x hosts will be updated
so the EMM Server will always be the volume database host. The pool
numbers in the mediaDB on the NetBackup 5.x hosts will be adjusted to
match the new pool numbers in the EMM database. The
NOT_DATABASE_HOST entry will be added to vm.conf.
375
nbpushdata
Before modifying the database files on a NetBackup 5.x host,
nbpushdata creates the following backup files:
robotic_def.tpacbak, ltidevs.tpacbak, and mediaDB.bak.
Disk only media servers do not require any database modifications.
-remove host
Remove the information from the specified host from the EMM database.
This is intended to be used to clean up after an incomplete run of
nbpushdata, such as when a host crashes or the network fails.This
command only removes the information from the last host on which you
ran nbpushdata. You cannot run this command on host updated before
the last host. Use this option when running on a master server or a media
server.
NOTES
◆ General
◆ A log file is automatically created in netbackup/logs/nbpushdata when
nbpushdata starts.
◆ Since pool access based on host, user id, and group id is not supported in
NetBackup 6.0, these values will be discarded by nbpushdata.
◆ On Windows, a command window must be opened to run nbpushdata. It
cannot be run by clicking on the icon
◆ When running nbpushdata for clusters, you only need to run the nbpushdata
-add command on the active node. nbpushdata obtains the necessary
information from the inactive nodes. You only need to run this command once in
a cluster.
◆ In some configurations, nbpushdata cannot automatically run bpdm -convert_legacy. If it is necessary to run this command manually, nbpushdata will display a message to do so.
◆ Combined Media Record
◆ As nbpushdata is moving records to the EMM database, the corresponding
volDB and mediaDB records will be combined into a single EMM media record
based on media ID and assigned time. If a match cannot be made automatically,
the mediaDB record is saved in a merge table for manual matching later. There are
nbemmcmd options to view this mediaDB merge table and to manually match the
mediaDB and volDB records.
◆ For imported media, the assigned time in the volDB and in the mediaDB records
are not the same, so EMM cannot match them automatically. These records must
be matched manually using nbemmcmd.
◆ Multiple Volume Database Hosts
376
nbpushdata
◆ The former vm.conf options
RETURN_UNASSIGNED_MEDIA_TO_SCRATCH_POOL and
VAULT_CLEAR_MEDIA_DESC, which were applied on a host basis in
NetBackup 5.x, are now global for all hosts using the EMM Server. The values
from the last volDB host where nbpushdata was run become the global options.
◆ Volume groups will be merged into the EMM database by name. If the same
volume group exists on two different volDB hosts, the volume groups will be
merged.
◆ If a volDB host has a pool name that is not a scratch pool, but the same pool name
exists as a scratch pool on another volDB host, the pool will become a scratch
pool. To prevent this from happening, the pool must be renamed before the
upgrade.
◆ Pools from the various Volume Database hosts (volDB hosts) will be merged into
the EMM database by name. This includes the default pools (None, NetBackup,
and DataStore) and the user-defined pools. Scratch pools are the only exception to
this rule. All scratch pools will be merged regardless of name. The merged scratch
pool name that is used is the first scratch pool name encountered during the
upgrade. Pool numbers will be adjusted during the upgrade to be unique within
the EMM database.
◆ Some customers may be using the same pool name on two different volDB hosts.
The volumes will not remain logically separated after the merge. Customers who
have multiple volDB hosts and have the requirement to keep volumes with the
same pool names separate, must rename the pools before the upgrade.
◆ In NetBackup 6.0, a single set of barcode rules is stored in the EMM database. The
barcode rules from the various volDB hosts are added to the EMM database in the
order that they are found. Only the first barcode rule with a particular barcode tag
is added to the EMM database. Additional barcode rules with the same tag are not
added. Manual adjustment of the barcode rules may be necessary after running
nbpushdata.
◆ As media records are being moved to the EMM database while nbpushdata is
running, media record conflicts will be detected and the associated media records
will be marked. The possible conflicts are: media id, barcode, residence, RSM
GUID, and ADAMM GUID.
377
nbrb
nbrb
NAME
nbrb – NetBackup Resource Broker,
SYNOPSIS
install_path\NetBackup\bin\nbrb [-console] [-terminate]
DESCRIPTION
The NetBackup Resource Broker, nbrb, binary is a service that is started when NetBackup
is started and remain active. This service makes the allocations for such things as storage
units, tape drives, and client reservations. This service works closely with the EMM to
obtain physical and logical resources that a job requires to run. Physical resources can be
storage units, tape drives, and media IDs. Logical resources can be named resources, max
jobs per client, max jobs per policy, and multiplexed groups as resources that nbjm uses.
OPTIONS
-console
-terminate
This option enables you to stop the nbrb.
SEE ALSO
nbjm, nbpem
378
restoretrace
restoretrace
NAME
restoretrace – consolidate debug logs for a restore job
SYNOPSIS
install_path\NetBackup\bin\admincmd\restoretrace [-master_server
name] [-job_id number] [-client_name name]
[-start_time hh:mm:ss] [-end_time hh:mm:ss] mmddyy
[mmddyy ...]
DESCRIPTION
The restoretrace utility can be used to consolidate the debug logs for the specified restore
job[s]. It will copy to standard output the debug log lines relevant to the specified restore
job[s]. The messages will be sorted by time. The utility will attempt to compensate for
time zone changes and clock drift between remote servers and clients. The output is
formatted so that it should be relatively easy to sort or grep by time stamp, program
name, and/or server/client name.
At a minimum, you must enable debug logging for bprd on the master server, for bpbrm
and bptm/bpdm on the media server and tar on the client. For best results, set the verbose
logging level to 5 and enable debug logging for bpdbm on the master server and for bpcd
on all servers and clients in addition to the processes already identified.
OPTIONS
-master_server name
-job_id
number
Job ID number of the restore job to analyze.
-client_name name
Client name of the jobs to analyze.
-start_time hh:mm:ss
Earliest time stamp to start analyzing the logs.
-end_time hh:mm:ss
Latest time stamp to finish analyzing the logs.
mmddyy [mmddyy] One or more day stamps. This identifies the log file names (log.mmddyy
379
restoretrace
NOTES
Media Manager logs are not analyzed.
Windows 95/98 and Mac OS 8/9 client logs may not be analyzed.
EXAMPLES
C:\Program Files\Veritas\NetBackup\bin\admincmd\restoretrace client peony install_path C:\Program Files\Veritas 071502 log.peony
This invocation of the utility will consolidate debug logs for all the restore jobs for the
client peony on 071502. Use the start_time/end_time arguments to limit the window for
which jobs are to be evaluated.
380
set_ndmp_attr
set_ndmp_attr
NAME
set_ndmp_attr - authorizes access and sets configuration values for NDMP attached
robots.
On Windows server systems: install_path\Volmgr\bin\set_ndmp_attr
SYNOPSIS
The set_ndmp_attr command can take any of the following sets of parameters as a
single line. Two or more sets can be combined into one line (see Example 4).
set_ndmp_attr [-insert | -update | -delete | -display] -auth
[ndmp-server-host] [user-name] [password]
set_ndmp_attr [-insert | -update | -delete | -display] -robot
[ndmp-server-host] [robot-device] [scsi-controller scsi-id scsi-lun]
set_ndmp_attr -verify [ndmp-server-host]
set_ndmp_attr -probe [ndmp-server-host] (not available for NDMP V2)
set_ndmp_attr [-list | -l]
set_ndmp_attr [-list_compact | -lc]
DESCRIPTION
Authorizes access and sets configuration values for robots attached to an NDMP host, and
places them into the NDMP configuration database.
OPTIONS
-insert (optional)
Allows user to insert a new authorize access entry or a new robot (must
be used with -auth or -robot).
-update (optional)
Updates an NDMP entry (must be used with -auth or -robot).
-delete (optional)
Deletes an NDMP entry (must be used with -auth or -robot).
-display (optional)
Displays an NDMP entry (must be used with -auth or -robot).
-auth
Creates an entry to allow access to an NDMP client.
381
set_ndmp_attr
-robot
Sets the configuration values for an NDMP-attached robot.
-verify
Verifies that the NetBackup for NDMP server has access to the NDMP
host. If a robot is configured on the NDMP host, this option verifies access
to the robot.
-probe
Lists all devices attached to the NDMP host.
-list or -l (optional)
Lists the current entries in the NDMP configuration database.
-list_compact or -lc (optional)
Lists a short version of the NDMP configuration database.
Note If none of the following (-insert, -update, -delete, or -display) precedes the
options -robot or -auth, the default is to either insert or update, depending on
whether the host or robot already exists.
EXAMPLES
Example 1: Setting the authorization of an NDMP client
set_ndmp_attr -insert -auth stripes root
Passwd:XXXXX
Passwd:XXXXX
Example 2: Setting the configuration values for a robot attached to an NDMP client. The
robot is on control 2, SCSI-ID 3, and LUN 0.
set_ndmp_attr -insert -robot stripes c2t3l0 2 3 0
Example 3: Running a verify
set_ndmp_attr -verify
Verify Host name: stripe
Result of Example 3:
Verify Host name: stripes
Connecting to host "stripes" as user "root"...
Waiting for connect notification message...
Opening session with NDMP protocol version 2...
Host info is:
host name "stripes"
os type "SunOS"
382
set_ndmp_attr
os version "5.8"
host id "80dd14ba"
host supports TEXT authentication
host supports MD5 authentication
Getting MD5 challenge from host...
Logging in using MD5 method...
Login was successful
Opening SCSI device "c2t3l0"...
Setting SCSI target controller 2 id 3 lun 0...
Inquiry result is "HP
C5173-7000
3.04"
Example of failed verification due to incorrect password:
Connecting to host "stripes" as user "root"...
Waiting for connect notification message...
Opening session with NDMP protocol version 2...
Host info is:
host name "stripes"
os type "SunOS"
os version "5.8"
host id "80dd14ba"
host supports TEXT authentication
Logging in using TEXT method...
ndmp_connect_client_auth failed
set_ndmp_attr: host "stripes" failed
set_ndmp_attr: unable to continue
Example 4: This shows several sets of parameters combined
set_ndmp_attr -auth stripes root -robot stripes c2t3l0 2 3 0 -verify stripes
383
tl4d
tl4d
NAME
tl4d - Tape Library 4MM (TL4) process
SYNOPSIS
install_path\Volmgr\bin\tl4d
DESCRIPTION
tl4d interfaces with Media Manager to mount and unmount tapes in a Tape Library
4MM (TL4) robot. It is initiated by the NetBackup Device Manager service (ltid), if the
Media Manager device configuration shows drives in the robot. Stopping ltid stops
tl4d.
tl4d communicates with the robotics through a SCSI interface. When the connection is
established (the path for robotics can be opened), tl4d puts the TL4 robot in the UP state
and can mount and unmount tapes. If the robotics are inaccessible, tl4d changes the
robot to the DOWN state. In this state, tl4d is still running and returns the robot to the
UP state if it is able to make a connection.
The media ID and slot number information for 4 mm tapes in a robot must be defined in
the Enterprise Media Manager Database before any tapes can be accessed through the
NetBackup Device Manager service and tl4d.
If a cleaning volume is used, it must be defined in the volume configuration. See tpclean
for information on setting the frequency for automatic drive cleaning.
The Internet service port number for tl4d must be in
create the file install_path\Volmgr\database\ports\tl4d with a single line that
contains the service port number for tl4d. The default service port number is 13713.
ERRORS
Media Manager logs any Tape Library 4MM and robotic errors to the Windows
application event log. Log entries are also made when the state changes between UP and
DOWN.
384
tl8d
tl8d
NAME
tl8d, tl8cd - Tape Library 8MM (TL8) process and control process
SYNOPSIS
install_path\Volmgr\bin\tl8d
install_path\Volmgr\bin\tl8cd
DESCRIPTION
tl8d and tl8cd interface with Media Manager to mount and unmount volumes in a
Tape Library 8MM robot.
tl8d directly interfaces with the NetBackup Device Manager service (ltid). A tl8d
process runs on each host with a drive connection and sends mount and unmount
requests to the control process (tl8cd). tl8cd communicates with the robotics through
a SCSI interface.
The following paragraph applies only to NetBackup Enterprise Server:
Tape Library 8MM robotic control software permits drives in the same robot to be
configured on different hosts. tl8cd may be running on a different host than tl8d,
depending on where the SCSI connection resides (see EXAMPLES). When the connection
is established (that is, the path for robotics can be opened), tl8d puts the TL8 robot in the
UP state and can mount and unmount volumes. If the robotics are inaccessible, tl8d
changes the robot to the DOWN state. In this state, tl8d is still running and returns the
robot to the UP state if tl8cd is able to make a connection.
If drives are on different NetBackup hosts, the robotic information must be entered in the
Media Manager configuration on all machines and the robot number must be the same on
all machines.
tl8d and tl8cd are started when the NetBackup Device Manager service is started and
stopped when this service is stopped.
The control process, tl8cd, is on the host that has the robotic control and is
automatically started by tl8d on that host (see EXAMPLES). tl8cd is stopped when you
stop the NetBackup Device Manager service.
The media ID and slot number information for volumes in a robot must be defined in the
EMM database before any volumes can be accessed through the NetBackup Device
Manager service, tl8d, and tl8cd.
385
tl8d
If the vm.conf configuration option PREVENT_MEDIA_REMOVAL is enabled when tl8cd
is active, tl8cd disables access to the volumes and media access port by issuing a
command to the TL8 robot. If it is necessary to open the door of the cabinet, you must
terminate tl8cd first. By default, access to the library is allowed.
The drives are logically numbered 1 through n, where n is the number of drives in the
robotic library. Use one or more of the following to determine the correct robot drive
numbers:
◆ The Device Configuration wizard (if the robotic library and drives support
serialization).
◆ The robotic library vendor’s documentation on drive indexing.
◆ The robotic test utility, or experiment by mounting media and watching the operator
display.
The Internet service port number for tl8cd must be in
create the file install_path\Volmgr\database\ports\tl8cd with a single line that
contains the service port number for tl8cd. The default service port number is 13705.
ERRORS
Media Manager logs any Tape Library 8MM and robotic errors to the Windows
DOWN.
EXAMPLES
In the following diagram, the drives and the robotics are connected to a single host. ltid
initiates tl8d, which in turn initiates tl8cd.
386
tl8d
The following example applies only to NetBackup Enterprise Server:
In the following diagram, each host is connected to one drive in the robot and the robotics
are connected to host A. ltid on each host initiates tl8d. The tl8d on host A also
initiates tl8cd, since that is where the robotic control is defined. Requests to mount tapes
from host B go to tl8d on host B, which sends the robotic command to tl8cd on host A.
387
tldd
tldd
NAME
tldd, tldcd - Tape Library DLT (TLD) process and control process
SYNOPSIS
install_path\Volmgr\bin\tldd
install_path\Volmgr\bin\tldcd
DESCRIPTION
tldd and tldcd interface with Media Manager to mount and unmount volumes in a
Tape Library DLT (TLD) robot.
tldd directly interfaces with the NetBackup Device Manager service (ltid). tldd runs
on each host with a drive connection and sends mount and unmount requests to the
control process (tldcd). tldcd communicates directly with the robotics through a SCSI
interface.
TLD robotic control software permits drives in the same robot to be configured on
different hosts. tldcd may be running on a different host than tldd, depending on
where the interface connection resides (see EXAMPLES). When the connection is
established (that is, the path for robotics can be opened), tldd puts the TLD robot in the
UP state and can mount and unmount volumes. If the robotics are inaccessible, tldd
changes the robot to the DOWN state. In this state, tldd is still running and returns the
robot to the UP state if tldcd is able to make a connection.
If drives are on different NetBackup hosts, the robotic information must be entered in the
Media Manager device configuration on all machines and the robot number must be the
same on all machines.
tldd and tldcd are started when ltid is started and stopped when this service is
stopped.
tldcd is on the host that has the robotic control and is automatically started by tldd on
that host. tldcd is stopped when you stop the NetBackup Device Manager service.
The media ID and slot number information for volumes in the robot must be defined in
the EMM database before any volumes can be accessed through the NetBackup Device
Manager service, tldd, and tldcd.
388
tldd
The drives are logically numbered 1 through n, where n is the number of drives in the
robotic library. Use one or more of the following to determine the correct robot drive
numbers:
◆ The Device Configuration wizard (if the robotic library and drives support
serialization).
◆ The robotic library vendor’s documentation on drive indexing.
◆ The robotic test utility, or experiment by mounting media and watching the operator
display.
The Internet service port number for tldcd must be in
create the file install_path\Volmgr\database\ports\tldcd with a single line that
contains the service port number for tldcd. The default service port number is 13711.
ERRORS
Media Manager logs any Tape Library DLT and robotic errors to the Windows application
event log. Log entries are also made when the state changes between UP and DOWN.
EXAMPLES
In the following diagram, the two drives and the robotics connect to Host A. ltid
initiates tldd, which in turn initiates tldcd.
The following example applies only to NetBackup Enterprise Server:
389
tldd
In the following diagram, each host connects to one drive and the robotics connect to host
A. ltid on each machine initiates tldd. The tldd on host A also initiates tldcd, since
that is where the robotic control is defined. Requests to mount tapes from host B go to
tldd on host B, which sends the robotic command to tldcd on host A.
390
tldd
391
tlhd
tlhd
NAME
tlhd, tlhcd - Tape Library Half-inch (TLH) process and control process
SYNOPSIS
install_path\Volmgr\bin\tlhd
DESCRIPTION
tlhd and tlhcd interface with Media Manager to mount and unmount tape volumes in a
Tape Library Half-inch (TLH) robot.
tlhd directly interfaces with the NetBackup Device Manager service (ltid). tlhd runs
on each host with a drive connection and sends mount and unmount requests to the
control process, tlhcd.
tlhcd communicates with the IBM Automated Tape Library (ATL) library manager,
which processes all requests and control functions for the robotic library. TLH robotic
control software permits drives in the same robot to be configured on different hosts.
tlhcd can be running on a different host than tlhd, depending on where the IBM library
control is configured (see EXAMPLES). When communication with the library is
established, tlhd puts the TLH robot in the UP state and can request volume mounts and
unmounts. If the library or control process is inaccessible, tlhd changes the robot to the
DOWN state. In this state, tlhd is still running and returns the robot to the UP state if
tlhcd is able to make a connection.
tlhd and tlhcd are automatically started when the NetBackup Device Manager service
is started and stopped when this service is stopped.
tlhcd is on the host that has the robotic control and is automatically started by tlhd on
that host. tlhcd is terminated when you stop the NetBackup Device Manager
serviceltid.
The Media Manager media ID for volumes to be used in the library must be defined in the
EMM database before any volumes can be accessed using the NetBackup Device Manager
serviceltid, tlhd, and tlhcd. Both the initial EMM database population and future
updates can be accomplished using Media Manager robotic inventory options.
The drives are configured using IBM device names. The robotic test utility, tlhtest (or
robtest if the robot is configured), can be used to determine the device names associated
with the robot. You can also use this utility along with IBM's mtlib command-line
interface to verify library communications, status, and functionality.
Drive cleaning for Tape Library Half-inch robotic control must be configured through an
IBM library manager console, since these operations are not made available to
applications that are using the IBM library manager. For this reason, cleaning volumes
392
tlhd
cannot be defined through Media Manager. In addition, you cannot use the Media
Manager utilities or the tpclean command for cleaning operations on drives under TLH
robotic control.
NOTES
If drives are on different hosts, the robotic information must be entered in the Media
Manager device configuration on all machines and the robot number must be the same on
all machines.
ERRORS
Media Manager logs any Tape Library Half-inch and robotic errors to the Windows
DOWN.
EXAMPLES
In the following examples the device hosts can be any supported Windows server or the
following UNIX servers: AIX, HP-UX, IRIX, DYNIX/ptx, or Solaris.
In the following diagram, the drives are attached to and the robotics are controlled from a
single host. ltid initiates tlhd, which in turn initiates tlhcd. The IBM Automated Tape
Library service (lmcpd) must be running on Host A.
393
tlhd
In the following diagram, each host is connected to at least one drive and the robotics are
controlled from Host A. ltid on each machine initiates tlhd. The tlhd on Host A also
initiates tlhcd, since that is where the robotic control is defined. Requests to mount tapes
from Host B go to tlhd on Host B, which sends the robotic command to tlhcd on Host
A.
394
tlmd
tlmd
NAME
tlmd - Tape Library Multimedia (TLM) process
SYNOPSIS
install_path\Volmgr\bin\tlmd
DESCRIPTION
tlmd interfaces with Media Manager to automatically mount and unmount tapes that are
under control of a TLM robot. It is initiated by the NetBackup Device Manager service
(ltid), if the Media Manager device configuration shows drives in an TLM robot.
Stopping ltid stops tlmd.
tlmd performs its tasks by sending requests to the DAS server that controls the robot.
When the connection is established, tlmd puts the TLM robot in the UP mode and can
mount and unmount tapes. If the connection cannot be established or robotic errors exist,
tlmd changes the robot to the DOWN mode. In this state, tlmd is still running and
returns the robot to the UP mode when the problem no longer exists.
The Internet service port number for tlmd must be in
create the file install_path\Volmgr\database\ports\tlmd with a single line that
contains the service port number for tlmd. The default service port number is 13716.
The drives are configured using DAS/SDLL device names. The robotic test utility,
tlmtest (or robtest if the robot is configured), can be used to determine the device
names associated with the robot.
NOTES
ERRORS
Media Manager logs TLM and network errors to the Windows application event log. Log
entries are also made when the mode changes between UP and DOWN.
395
tpautoconf
tpautoconf
NAME
tpautoconf - Manage the Enterprise Media Manager Server
SYNOPSIS
install_path\Volmgr\bin\tpautoconf -get_gdbhost
install_path\Volmgr\bin\tpautoconf -set_gdbhost host_name
install_path\Volmgr\bin\tpautoconf -verify ndmp_host_name
install_path\Volmgr\bin\tpautoconf -probe ndmp_host_name
install_path\Volmgr\bin\tpautoconf -report_disc
install_path\Volmgr\bin\tpautoconf -replace_drive drive_name -path
drive_path
install_path\Volmgr\bin\tpautoconf -replace_robot robot_number
-path robot_path
DESCRIPTION
tpautoconf is normally used by the Device Configuration wizard to automatically
discover and configure devices. This wizard calls tpautoconf with a different set of
options.
The get and set options described here are useful only in special situations; for example,
to specify a different host as the Enterprise Media Manager Server. The Enterprise Media
Manager Server name is automatically defined when NetBackup is installed. See the
Configuring Storage Devices chapter of the NetBackup Media Manager system
administrator’s guide for information about managing the Enterprise Media Manager
Server.
A user can use the -report_disc, -replace_drive, and -replace_robot options
to re-configure the devices on the EMM database to reflect a serial number change caused
by the replacement of configured device. The correction process requires that after
hardware replacement, at least one system must be made available through the operating
system. This may require re-mapping, re-discovery, and/or rebooting the system. Refer
to, "Making Changes to your Existing Configuration", in the NetBackup Shared Storage
System Administrator's Guide for instruction on how to reconfigure the EMM database.
After you configure the server(s), use the -report_disc option to scan the current
hardware, and compare it with the configured hardware. A list of discrepancies is
produced and shows the replaced hardware, and the new hardware.
Note: Not all servers will have access to robotic hardware. Even though this is expected,
these robots will be listed as missing.
396
tpautoconf
All servers must be running NetBackup 5.0 or better for -replace_drive or
-replace_robot to properly reconfigure them. For servers that are running older
versions of NetBackup, manual reconfiguration are required after running
-replace_drive and -replace_robot.
The final step to adding replacement hardware is to configure the hardware on all servers
via their Operating Systems and then run the Device Configuration wizard to configure
the new path information. Again, refer to, "Making Changes to your Existing
Configuration", in the NetBackup Shared Storage System Administrator's Guide.
OPTIONS
-get_gdbhost
Returns the name of the EMM server host.
-set_gdbhost host_name
Sets the name of the EMMSERVER entry in bp.conf.
-probe ndmp_host_name
Lists all devices attached to the NDMP host..
-report_disc
This option enables the device data to be queried from the EMM server to
enable a “diff” to be run on these data records against those scanned. You
can run this command on reconfigured servers to produce a list of new
and missing hardware. This command will scan for new hardware, and
produce a report showing the new and the replaced hardware.
-replace_drive drive_name -path drive_path
The EMM database will be used to query/update robot drives. In
addition, systems running pre-NetBackup 5.1 versions will be updated
from tpautoconf.
NOTE: The drive_path variable is a non-NDMP Windows device path for
drives and should be used in the {p,b,t,l} format where where p is the port,
b is the bus, t is the target and l is the lun of the device. You can find this
information in the registry.
-replace_robot robot_number -path robot_path
The EMM database will be used to query/update robot records. In
addition, systems running pre-NetBackup 5.1 versions will be updated
from tpautoconf.
NOTE: The robot_path variable is a non-NDMP Windows device path for
robots and should be used in the {p,b,t,l} format where where p is the port,
information in the registry.
397
tpautoconf
-verify ndmp_host_name
Verifies the server name of the NDMP host.
EXAMPLES
Example 1
The following command returns the name of the host where the Enterprise Media
Manager Database is stored:
tpautoconf -get_gdbhost
Example 2
The following command sets the Enterprise Media Manager Server to be the host server2:
tpautoconf -set_gdbhost server2
Example 3
The following example shows how the -report_disc command is used to report
discrepancies between detected devices and the EMM Database. In addition, an example
of how to use the -replace_drive drive_name -path drive_path command is
included.
# install_path\Volmgr\bin\tpautoconf -report_disc
======================= New Device (Tape) =======================
Inquiry = "QUANTUM DLT8000
0250"
Serial Number = PXB08P3242
Drive Path = /dev/rmt/119cbn
Found as TLD(6), Drive = 1
===================== Missing Device (Drive) =====================
Drive Name = QUANTUMDLT800014
Drive Path = /dev/rmt/9cbn
Inquiry = "QUANTUM DLT8000
0250"
Serial Number = PXB08P1345
TLD(6) definition Drive = 1
Hosts configured for this device:
Host = dandelion
Host = avocadocat
398
tpautoconf
# install_path\Volmgr\bin\tpautoconf -replace_drive QUANTUMDLT800014
-path /dev/rmt/119cbn
Found a matching device in EMM DB, QUANTUMDLT800014 on host
dandelion
update on host dandelion completed
Found a matching device in EMM DB, QUANTUMDLT800014 on host
avocadocat
update on host avocadocat completed
399
tpclean
tpclean
NAME
tpclean - manages tape drive cleaning
SYNOPSIS
install_path\Volmgr\bin\tpclean -L
install_path\Volmgr\bin\tpclean -C drive_name
install_path\Volmgr\bin\tpclean -M drive_name
install_path\Volmgr\bin\tpclean -F drive_name cleaning_frequency
DESCRIPTION
tpclean enables you to monitor Media Manager tape drive usage and optionally
configure tape drives to be automatically cleaned (except drives in ACS,ODL, or TLH
robots; or QIC drives).
Media Manager tracks the total amount of time that volumes have been mounted in the
drives. You can use tpclean to specify a cleaning frequency (in hours) for a drive.
Drive cleaning occurs, if the following are true:
◆
The mount time exceeds the cleaning frequency.
◆
A TapeAlert “CLEAN NOW” or “CLEAN PERIODIC” flag has been raised.
◆
The drive is in a robot.
◆
The Media Manager volume configuration shows a cleaning tape in the robot.
The Comment field in the tpclean -L output will contain the message, NEEDS
CLEANING, if the following are true. You can then manually clean the drive and reset the
mount time using the -M option.
◆
The mount time exceeds the cleaning frequency.
◆
The drive is a standalone drive or does not have a cleaning tape defined.
For the -C, -M, and -F options, the NetBackup Device Manager service must be running. See the reference topics appendix of the Media Manager system administrator’s guide for information about the TapeAlert feature that is available with most tape drives, and other related drive cleaning topics.
400
tpclean
OPTIONS
-C drive_name
Initiates the cleaning of a drive in a robot. The drive must be defined in a
robot and a cleaning tape defined in the Media Manager volume
configuration. The mount time is reset to zero. The drive name is the
name that was assigned to the drive, when it was added.
-L
Prints cleaning statistics.
-M drive_name
Use this option to indicate that the drive has been manually cleaned. The
mount time is reset to zero. The drive name is the name that was assigned
to the drive, when it was added to the device configuration.
-F drive_name cleaning_frequency
Sets cleaning frequency for the specified drive to cleaning_frequency
hours. The drive name is the name that was assigned to the drive when it
was added. The value of cleaning_frequency must be between 0 and
10,000 hours.
The following applies only to NetBackup Enterprise Server:
Frequency-based cleaning is not supported for shared drives.
NOTES
tpconfig -d, tpconfig -l, and vmoprcmd may truncate long drive names. Please use
tpconfig -dl to obtain the full drive name.
tpclean truncates drive names to 22 characters.
EXAMPLES
The following example displays cleaning statistics. An asterisk next to the drive type
means the device is defined as robotic.
#tpclean -L
Drive Name
**********
rob_A_drv1
4mm_drv5
dlt_drv6
Type
****
8mm*
4mm
dlt
Mount Time
**********
11.4
5.6
3.0
Frequency
**********
30
10
0
Last Cleaned
Comment
************
*******
14:33 05/29/92
13:01 06/02/92
N/A
The following example sets the cleaning frequency for the drive named dlt_drv6 to 25
hours. The drive will be flagged as needing cleaning after 25 hours of mount time has
occurred.
tpclean -F dlt_drv6 25
401
tpclean
The following example resets the mount time for the drive named rob_A_drv1 to zero.
You would normally use this command after you had manually cleaned the drive.
tpclean -M rob_A_drv1
The following example initiates the cleaning of drive rob_A_drv1. This example
assumes the drive is a robotic drive, with a cleaning tape defined. The mount time is reset
to zero.
You can use the -C option to force the cleaning of a drive prior to reaching
cleaning_frequency. Normally, robotic drives are cleaned automatically when their mount
time exceeds the cleaning frequency.
tpclean -C rob_A_drv1
Note To use a cleaning tape, the Cleanings Remaining for that tape (as shown in the
volume list of the Media node in the NetBackup Administration Console or from
the vmquery command) must be greater than zero. This cleaning count refers to
how many more times the cleaning tape can be used. You can change this count
using the Media node or the vmchange command.
402
tpconfig
tpconfig
NAME
tpconfig - Tape configuration utility
SYNOPSIS
(To display device configuration)
install_path\Volmgr\bin\tpconfig -d
install_path\Volmgr\bin\tpconfig -l
install_path\Volmgr\bin\tpconfig -dl
(To add a drive)
install_path\Volmgr\bin\tpconfig -add -drive -type drvtype -port
port -bus bus -target target -lun lun [-asciiname
asciidrivename] [-index drvindex]] [-shared [yes|no]]
[-cleanfreq hours] [-comment comment] [-drstatus
[UP|DOWN|DISABLED]] [-robot robnum -robtype robtype]
[-noverify] [-robdrnum robdrvnum | -VendorDrvName
vendor_drive_name] [-ACS acsnum -LSM lsmnum -PANEL
panelnum -DRIVE drivenum] [preview]
install_path\Volmgr\bin\tpconfig -add -drive -type drvtype -path
drivepath [-nh ndmp_hostname] [-asciiname asciidrivename]
[-index drvindex]] [-shared [yes|no]] [-cleanfreq hours]
[-comment comment] [-drstatus [UP|DOWN|DISABLED]]
[-robot robnum -robtype robtype] [-robdrnum robdrvnum |
-VendorDrvName vendor_drive_name | -ACS acsnum -LSM
lsmnum -PANEL panelnum -DRIVE drivenum] [preview]
(To update a drive)
install_path\Volmgr\bin\tpconfig -update -drive drvindex [-type
drvtype] [-port port -bus bus -target target -lun lun ]
[-nh ndmp_hostname -path drivepath] [-noverify]
[-newasciiname asciidrivename]] [-shared [yes|no]]
[-cleanfreq hours] [-comment comment] [-drstatus
[UP|DOWN|DISABLED]] [-robot robnum -robtype robtype]
[-robdrnum robdrvnum | -VendorDrvName vendor_drive_name]
[-ACS acsnum -LSM lsmnum -PANEL panelnum -DRIVE
drivenum]
(To delete a drive)
install_path\Volmgr\bin\tpconfig -delete -drive drvindex
403
tpconfig
install_path\Volmgr\bin\tpconfig -multiple_delete -drive drvindex1:drvindex2: ... drvindexN
(To add a robot)
install_path\Volmgr\bin\tpconfig -add -robot robnum -robtype robtype
-port port -bus bus -target target -lun lun
[-nh ndmp_hostname] -robpath changername [-bus bus
-target target -lun lun]
-cntlhost cntlhost
(To update a robot)
install_path\Volmgr\bin\tpconfig -update -robot robnum [-robtype
robtype] [-port port -bus bus -target target -lun lun |
-cntlhost cntlhost | -tlh_library_name tlh_library_name]
robtype] [-robpath changername] [-nh ndmp_hostname]
[-bus bus] [-target target] [-lun lun]
robtype] [-pird [yes|no]]
(To delete a robot)
install_path\Volmgr\bin\tpconfig -delete -robot robnum
install_path\Volmgr\bin\tpconfig -multiple_delete -robot robnum1:robnum2: ... robnumN
(To add a drive path)
install_path\Volmgr\bin\tpconfig -add -drpath -path drivepath [-nh
ndmp_hostname] -asciiname asciidrvname [-drstatus
[UP|DOWN|DISABLED]] [-noverify]
install_path\Volmgr\bin\tpconfig -add -drpath -port port -bus bus
-target target -lun lun -asciiname asciidrvname
[-drstatus [UP|DOWN|DISABLED]] [-noverify]
(To update a drive path)
install_path\Volmgr\bin\tpconfig -update -drpath -old_path
drivepath -path drivepath [-nh ndmp_hostname]
-asciiname asciidrvname [-drstatus [UP|DOWN|DISABLED]]
[-noverify]
404
tpconfig
install_path\Volmgr\bin\tpconfig -update -drpath -old_port port
-old_bus bus -old_target target -old_lun lun -port
port -bus bus -target target -lun lun -asciiname
asciidrvname [-drstatus [UP|DOWN|DISABLED]]
[-noverify]
(To delete a drive path)
install_path\Volmgr\bin\tpconfig -delete -drpath -path drivepath
-asciiname asciidrvname [-nh ndmp_hostname]
install_path\Volmgr\bin\tpconfig -delete -drpath -port port -bus
bus -target target -lun lun -asciiname asciidrvname
(To Display NDMP host credentials for this host)
install_path\Volmgr\bin\tpconfig -dnh
(To Display NDMP host credentials for all hosts)
install_path\Volmgr\bin\tpconfig -dnh -all_hosts
(To Display NDMP default credentials for all hosts)
install_path\Volmgr\bin\tpconfig -ddnh
(To add an NDMP host using default credentials)
install_path\Volmgr\bin\tpconfig -add -nh ndmp_hostname
(To add NDMP host credentials)
install_path\Volmgr\bin\tpconfig -add -nh ndmp_hostname
-user_id|-filer_user_id user ID [-password password
[-key encryption key]]
(To update NDMP host credentials)
install_path\Volmgr\bin\tpconfig -update -nh ndmp_hostname
-user_id|-filer_user_id user ID [-password password
[-key encryption key]]
Note If the -key option is specified, tpconfig assumes the password to be provided in MD5
encrypted format.
(To delete NDMP host credentials)
install_path\Volmgr\bin\tpconfig -delete -nh ndmp_hostname
-user_id|-filer_user_id user ID
(To delete multiple NDMP host credentials. This applies only to credentials that are
specific to this host and the specified filer. In other words no default or filer credentials)
405
tpconfig
install_path\Volmgr\bin\tpconfig -multiple_delete -nh ndmp_hostname_1 : ndmp_hostname_2 : ... : ndmp_hostname_N
(To add default NDMP host credentials)
install_path\Volmgr\bin\tpconfig -add -default_user_id user ID
[-password password [-key encryption key]]
(To update default NDMP host credentials. If the -key option is specified, tpconfig
assumes the password to be provided in MD5 encrypted format.)
install_path\Volmgr\bin\tpconfig -update -default_user_id user ID
[-password password [-key encryption key]]
(To delete default NDMP host credentials)
install_path\Volmgr\bin\tpconfig -delete -default_user_id
(To retrieve default NDMP host credentials)
install_path\Volmgr\bin\tpconfig -dev_ping [-drive -path
drivepath|-robpath robotpath] [-nh ndmp_hostname]
install_path\Volmgr\bin\tpconfig -dev_ping [-drive] -port port
-bus bus -target target -lun lun
DESCRIPTION
The tpconfig command can be used to configure drives, robots, drive paths, and NDMP
hosts for use with NetBackup. The default for install_path is C:\Program
Files\VERITAS.
When your device configuration changes are complete, stop and restart the NetBackup
Device Manager service.
OPTIONS
-l
Lists the current device configuration and displays Windows device
paths in the {p,b,t,l} encoded form, where p is the port, b is the bus, t is the
target and l is the lun.
-d
Lists the current configuration information.
-dl
Lists the full drive name.
406
tpconfig
-default_user_id user ID
The user can configure a user name and password for all media servers
and NDMP host combinations under a given master server. A user only
needs to add a user name and password once per filer. Use this option
with the -add, -update, or -delete commands to specify the user
name and password..
-add
Adds a drive or a robot, depending on the accompanying options.
-update
Changes the configuration information for a drive or robot. For example,
you can add a drive to a robot.
-delete
Deletes a drive or robot, depending on the accompanying options.
-multiple_delete
Deletes multiple drives or robots, depending on the accompanying
options.
-drive
Use this option with the -add option to specify that the action is for a
drive.
-drive drvindex
Use this option with the -update, -delete, or -multiple_delete
options to specify the drive index and that the action is for a drive.
-drpath
The drive path that is being added, updated, or deleted.
-type drvtype
Specifies the type of drive that you are configuring.
Drive type can be any of the following for NetBackup Enterprise Server:
4mm for 4mm tape drives
8mm2 for 8mm tape drives 2
8mm3 for 8mm tape drives 3
dlt for DLT tape drives
dlt2 for DLT tape drives 2
dlt3 for DLT tape drives 3
hcart for Half-inch cartridge drives
hcart2 for Half-inch cartridge drives 2
hcart3 for Half-inch cartridge drives 3
qscsi for Quarter-inch cartridge drives
407
tpconfig
Drive type can be any of the following for NetBackup Server:
4mm for 4mm tape drive
dlt for DLT tape drives
hcart for Half-inch cartridge drives
qscsi for Quarter-inch cartridge drive.
-path drivepath
Specifies the drive's device path on the NDMP filer.
NOTE: The drive_path variable is a non-NDMP Windows device path for
drives and should be used in the {p,b,t,l} format where where p is the port,
information in the registry. -pird yes|no
This option sets or clears the PIRD state of the robot (pend if the robot is
down). If a robot is in a PIRD state, any storage unit related mount
requests for this robot will pend when the robotic control is down.
-comment comment
Adds a comment about the drive. This field is useful for storing SCSI
inquiry data so you can easily check the drive type and firmware level.
-index drvindex
A drive index is a unique number that is used to identify the drive. When
you add a drive you are not required to supply a drive index, since the
next available drive index is used by Media Manager. Each drive on a
particular host must have a unique index number.
-drstatus UP|DOWN|DISABLED
Sets the initial status of the tape drive to the UP, DOWN, or DISABLED
state. Discovered drive paths are enabled (UP) by default. An
administrator or operator can disable or configure the drive path
up/down. The user can also perform this action with options in the
Device Management window.
A drive status of DISABLED means NetBackup will store the path but
never to use it. In addition, should subsequent discoveries of this drive
path occur, NetBackup will not to configure it for use.
-cleanfreq hours
Specifies the number of hours between drive cleanings. When you add a
drive, NetBackup starts recording the amount of time that volumes are
mounted in that drive.
408
tpconfig
If the drive is in a robot and a cleaning volume is defined in the robot,
cleaning occurs when the accumulated mount time exceeds the time that
you specify for cleaning frequency. NetBackup resets the mount time
when the drive is cleaned.
If the drive is standalone or if a cleaning tape is not defined, the message
NEEDS CLEANING appears in the comment field of the tpclean -L
output. To clean the drive, use the tpclean command.
-robot robnum
A unique number that identifies the robot to NetBackup. You assign the
robot number when you add the robot using the add option.
Robot numbers must be unique for all robots that share the same EMM
server (and therefore use the same EMM database). This applies
regardless of the robot type or the host that controls them. For example, if
you have two TLD robots controlled by different hosts, but they have the
same EMM server, then the robot numbers must be different.
-robtype robtype
Specifies the type of robot that you are configuring and can be any of the
types supported by NetBackup on Windows servers.
Robot type can be any of the following for NetBackup Enterprise Server:
acs, for Automated Cartridge System robotic libraries
tl4, for Tape Library 4mm robotic libraries
tl8, for Tape Library 8mm robotic libraries
tld, for Tape Library DLT robotic libraries
tlh, for Tape Library Half-inch robotic libraries
tlm, for Tape Library Multimedia robotic libraries
Robot type can be any of the following for NetBackup Server:
tl4 for Tape Library 4mm, tl8 for Tape Library 8mm, tld for Tape
Library DLT.
-noverify
If this option is specified, drive paths are not verified. Normally,
tpconfig verifies that the no rewind on close drive path has the correct
minor number bits relating to no rewind, variable, Berkeley-style, and so
on. This option is normally not required, but may be helpful if using
non-standard platform device files. If this option is specified, caution
should be taken in making sure the device files are correct.
409
tpconfig
-robdrnum robdrvnum
Specifies the physical location (within the robot) of the drive. If you
assign the wrong number, NetBackup does not detect it, but an error
eventually occurs because the robotic control attempts to mount media on
the wrong drive.
You can usually determine the physical location by checking the connectors to the drives or the vendor documentation.
The Robot Slot and Layout appendix of the Media Manager system
administrator’s guide shows drive layouts for many of the robots that NetBackup supports.
-ACS acsnum
-LSM lsmnum
-PANEL panelnum
-DRIVE drivenum
These four options are only applicable for NetBackup Enterprise Server.
These options specify the configuration for ACS (Automated Cartridge System) robots.
acsnum specifies the number for the robotic library as configured on the ACS library software host.
lsmnum specifies the Library Storage Module that has this drive.
panelnum specifies the robot panel where this drive is located.
drivenum specifies the number of this drive.
-VendorDrvName vendor_drive_name
This option is only applicable for NetBackup Enterprise Server.
Specifies the IBM device name for a TLH robotic drive or the DAS drive
name for a TLM robotic drive.
-asciiname asciidrivename
Specifies a name for the drive. This name identifies the drive to Media
Manager. If you do not specify a drive name, Media Manager generates a
name.
If you are adding or updating shared drives, make the drive name as
descriptive as possible.
-newasciiname asciidrivename
Specifies a new name for the drive.
-port port
Specifies the SCSI port number to which the robot or drive connects. You
can find this information in the registry.
410
tpconfig
-old_port port
Specifies an existing SCSI port number that a user may want to add,
upgrade, or delete.
-bus bus
Specifies an existing SCSI bus number to which the robot or drive
connects. You can find this information in the registry.
-old_bus bus
Specifies the SCSI bus number that a user may want to add, upgrade, or
delete.
-target target
Specifies the target number (or SCSI ID) to which the robot or drive
-old_target target
Specifies an existing target number (or SCSI ID) to which the robot or
drive connects. Use this command to add, upgrade, or delete an existing
target.
-lun lun
Specifies the logical unit number (or SCSI ID) to which the robot or drive
-old_lun lun
Specifies the logical unit number (or SCSI ID) to which the robot or drive
connects. You can find this information in the registry. Use this command
to add, upgrade, or delete an existing logical unit number.
-cntlhost cntlhost
For a robot whose robotic control is on another host, this option specifies
the host that controls the robotic library. This option applies only to TL8, TLD, and TLH robots that can have the robotic control on another host, and to ACS and TLM robots.
For an ACS robot, specify the host name where the ACS library software
is installed.
For a TLM robot, specify the host name where the DAS server software is
installed.
-shared yes|no
This option indicates is you are adding or updating shared drives.
-tlh_library_name tlh_library_name
Specifies the TLH robotic library name.
411
tpconfig
-user_id user ID
Enables a user to configure a user name and password for all media
serversand NDMP host combinations under a given master server. Use
this option with the -add, -update, or -delete commands to specify
the user name and password.
-filer_user_id user ID
Enables a user to configure a user name and password for all media
servers connected to a filer. A user only needs to add a user name and
password once per filer. Use this option with the -add, -update, or
-delete commands to specify the user name and password.
-robpath robpath
Specifies the robot's device path on the NDMP filer.
NOTE: The robpath variable is a non-NDMP Windows device path for
robots and should be used in the {p,b,t,l} format where where p is the port, b is the bus, t is the target and l is the lun of the device. You can find this
information in the registry. NOTES
Note The following paragraphs apply only to NetBackup Enterprise Server:
All locally attached drives and robots on Windows need to be configured using the SCSI
port, bus, target and lun. This needs to be done irrespective of whether an operating
system device name (like \\.\Changer0 or \\.\Tape0) is associated with the device.
If the robotic control is on a remote host, use the -cntlhost option.
Note The following paragraph applies only to NetBackup Server:
tpconfig -d may truncate drive names to 22 characters.
tpconfig -l may truncate drive names to 32 characters. Use tpconfig -dl to obtain the full drive name.
EXAMPLES
Note In the following examples, the command that is entered is shown on multiple lines
because of page limitations. The actual command is entered on one line.
Example 1: Robotic Control on Local Windows Server
The following example adds a robot that connects directly to a Windows host, and also
adds drives to that robot.
412
tpconfig
Note The following point applies only to NetBackup Server:
1. Add the robot using the following command:
tpconfig -add -robot 7 -robtype tld -port 0 -bus 0 -target 2 lun
0 2. If there are drives in the robot that have not been configured, add them.
The following command configures the drive with the system name of Tape0 under
control of the robot configured in step 1 (Tape0 has been attached and recognized by
the server.)
tpconfig -add -drive -type dlt -port 1 -bus 2 -target 3 -lun 4 -comment “DEC
DLT2000 8414” -index 0 -drstatus up -robot 7 -robtype tld -robdrnum 1 -asciiname DLT2000_D1
The command in this example uses the comment field. This field is useful for storing
the drive’s SCSI inquiry data so that drive type and firmware level can be easily
checked.
3. If the robot contains drives that are currently configured as standalone drives, update
the drive configuration to place them under robotic control.
The following commands update the configuration for drives 1 and 2:
tpconfig -update -drive 1 -type dlt -robot 7 -robtype tld -robdrnum 1
tpconfig -update -drive 2 -type dlt -robot 7
-robdrnum 2
-robtype tld Note It is important that you assign the correct robot drive number to the drives. If robot
drive numbers are incorrect, tape mounts or backups may fail.
Example 2: Robotic Control on Remote Host (The following example applies only to
NetBackup Enterprise Server:)
This example adds a robot that connects to another host. It assumes that one or more tape
drives that are in the robot, connect to the Windows host where you are currently
managing devices.
1. Add the robot by executing the following command:
tpconfig -add -robot 9 -robtype tld -cntlhost perch
Ensure that the robot number matches the one on the control host.
413
tpconfig
2. If the robot contains drives that are currently configured as standalone, update the
drive configuration to place them under robotic control.
The following commands update the configuration for drives 1 and 2:
tpconfig -update -drive 1 -type dlt -robot 9
-robdrnum 1
-robtype tld tpconfig -update -drive 2 -type dlt -robot 9
-robdrnum 2
-robtype tld Note It is important that drives are assigned the correct robot drive number. If robot drive
numbers are incorrect, tape mounts or backups may fail.
3. If there are drives in the robot that have not been configured, add them now.
The following command configures the drive with the system name of Tape0 under
control of the robot configured in step 1. (Tape0 has been attached and recognized by
the Windows server.)
tpconfig -add -drive -type dlt -port 1 -bus 2 -target 3 -lun 4 -comment ‘DEC
DLT2000 8414’ -index 3 -drstatus up -robot 9 -robtype tld -robdrnum 3 -asciiname DLT2000_D3
Example 3: Configuring New Standalone Drives
The following is an example of adding a standalone drive, after the drive is installed:
tpconfig -add -drive -type dlt -port 1 -bus 2 -target 3 -lun 4 -comment ‘DEC
DLT2000 8414’ -index 6 -asciiname
DLT2000_standalone
Example 4: Demonstrating How Windows Device Paths are Displayed
This example demonstrates how to how the -l option displays the Windows device paths
in the p, b, t, l format.
C:\Program Files\VERITAS\Volmgr\bin>tpconfig -l
Device Robot Drive
Robot
Type
Num Index Type DrNum Status
robot
0
TLD
robot
1
TLD
robot
2
TLD
drive
0
pcd
- DISABL
drive
1 hcart2
2
UP
drive
1 hcart2
2
UP
drive
2 hcart2
1
UP
drive
2 hcart2
1
UP
414
Comment
-
Drive
Name
SONY.SDX-400V.000
IBM.ULTRIUM-TD2.001
IBM.ULTRIUM-TD2.001
IBM.ULTRIUM-TD2.002
IBM.ULTRIUM-TD2.002
Device
Path
{3,1,0,1}
{3,1,0,3}
{3,1,2,0}
{1,0,0,0}
{3,1,0,2}
{3,1,1,2}
{3,1,0,5}
{3,1,1,5}
tpconfig
drive
drive
drive
drive
drive
drive
-
3 hcart
3 hcart
4 hcart
4 hcart
5 hcart2
6 hcart2
1
1
2
2
2
1
DOWN
UP
UP
UP
UP
UP
-
IBM.ULTRIUM-TD1.003
IBM.ULTRIUM-TD1.003
IBM.ULTRIUM-TD1.004
IBM.ULTRIUM-TD1.004
IBM.ULTRIUM-TD2.005
IBM.ULTRIUM-TD2.006
{3,1,0,6}
{3,1,1,6}
{3,1,0,7}
{3,1,1,7}
{3,1,2,1}
{3,1,2,2}
415
tpreq
tpreq
NAME
tpreq - request a tape volume for mounting and associate a file name with the assigned
drive
SYNOPSIS
install_path\Volmgr\bin\tpreq -m media_id [-a accessmode] [-d density]
[-p poolname] [-f] filename
DESCRIPTION
This command initiates a mount request for a tape volume on a removable media device.
The information that you specify with this command identifies and registers the specified
file as a logical identifier for the mount request with Media Manager and manages access
to the volume.
Media Manager automatically mounts the media if it is in a robotic drive. Otherwise, an
operator mount request appears in the Device Monitor window. tpreq will not complete
normally in the case of a mount request for a robotic drive, if operator intervention is
required. These requests also appear in the Device Monitor window.
When the operation is complete, use the tpunmount command to remove the file name
from the directory in which the file was created.
OPTIONS
-m media_id
Specifies the media ID of the volume to be mounted. You can enter the ID
in upper or lowercase; Media Manager converts it to uppercase.
-a accessmode
Specifies the access mode of the volume. Valid access modes are w and r.
If the access mode is w (write), the media must be mounted with write
enabled. The default is r (read), which means the media may be write
protected.
-d density
Specifies the density of the drive. This option determines the type of drive
on which the tape volume is mounted. The default density is dlt.
Valid densities for NetBackup Enterprise Server follow:
416
tpreq
4mm for 4-mm cartridge, 8mm for 8-mm cartridge, 8mm2 for 8-mm
cartridge 2, 8mm3 for 8-mm cartridge 3, dlt for DLT cartridge, dlt2 for
DLT cartridge 2, dlt3 for DLT cartridge 3, hcart for 1/2 Inch cartridge,
hcart2 for 1/2 Inch cartridge 2, hcart3 for 1/2 Inch cartridge 3, qscsi for
1/4-inch cartridge.
The half-inch cartridge densities (hcart, hcart2, and hcart3) can be used to
distinguish between any supported half-inch drive types. However, tape
requests can only be assigned to drives of the associated media type. For
example, a tape request with density hcart2 specifying a media ID with
media type HCART2 will be assigned to an hcart2 drive. Likewise, a tape
request with density hcart specifying an media ID with media type
HCART will be assigned to an hcart drive. The same rules apply to the
DLT densities (dlt, dlt2, and dlt3) and the 8MM densities (8mm, 8mm2,
and 8mm3).
Valid densities for NetBackup Server follow:
4mm for 4-mm cartridge, 8mm for 8-mm cartridge, dlt for DLT cartridge,
hcart for 1/2 Inch cartridge, qscsi for 1/4-inch cartridge.
The mount request must be performed on a drive type that satisfies the
density.
-p poolname
Specifies the volume pool where the volume resides. poolname is case
sensitive. The default is None.
-f filename
Specifies the file to be associated with the volume.
The file name can be a single name or a complete path. If you specify only a file name, the file is created in the current working directory. If you specify a path, the file is created in the directory named in the path. filename cannot be an existing file.
If the tpreq command is successful, Media Manager creates a file with
the name that you specified. This file contains the name of the tape device where the media is mounted. Do not delete this file. Use the tpunmount command to remove it.
Specifying -f before filename is optional.
417
tpunmount
tpunmount
NAME
tpunmount - removes a tape volume from a drive and tape file from the directory
SYNOPSIS
install_path\Volmgr\bin\tpunmount [-f] filename [-force]
DESCRIPTION
tpunmount removes a tape file from the directory and physically removes the tape
volume from the drive (if the media was mounted). Standalone drives are not unloaded when the DO_NOT_EJECT_STANDALONE option is
specified (and the -force option is not specified). This option is now stored in EMM.
The tape file and the device must be closed before you can use tpunmount.
OPTIONS
-f filename
Specifies the file associated with the media. You must specify a file name.
Specifying -f before filename is optional.
-force
Ejects the volume from a standalone drive, even if
DO_NOT_EJECT_STANDALONE was specified in the EMM.
EXAMPLE
The following command unmounts the tape volume associated with file tape1 and
removes the file from the current directory:
tpunmount tape1
418
verifytrace
verifytrace
NAME
verifytrace – trace debug logs for verify job[s]
SYNOPSIS
install_path\NetBackup\bin\admincmd\verifytrace [-master_server name] -job_id number [-start_time hh:mm:ss] [-end_time hh:mm:ss] mmddyy [mmddyy _]
install_path\NetBackup\bin\admincmd\verifytrace [-master_server name] -backup_id id [-start_time hh:mm:ss] [-end_time hh:mm:ss] mmddyy [mmddyy _]
install_path\NetBackup\bin\admincmd\verifytrace [-master_server name] [-policy_name name] [-client_name name] [-start_time hh:mm:ss] [-end_time hh:mm:ss] mmddyy
[mmddyy _]
DESCRIPTION
The verifytrace command consolidates the debug log messages for the specified
verify job[s] and writes them to standard output. The messages will be sorted by time.
verifytrace will attempt to compensate for time zone changes and clock drift between
remote servers and clients.
At a minimum, you must enable debug logging for
install_path\NetBackup\bin\admin directory on the master server, and for
bpbrm, bptm/bpdm and tar on the media server. For best results, set the verbose logging
level to 5 and enable debug logging for bpdbm on the master server and bpcd on all
servers and clients in addition to the processes already identified.
If either -job_id or -backup_id is specified, verifytrace uses this option as the sole
criteria for selecting the verify job[s] it will trace. The options -policy_name or
-client_name cannot be used in conjunction with -job_id or -backup_id. If
-job_id or -backup_id are not specified then all verify jobs that match the specified
selection criteria will be selected. If none of the options namely, -job_id, -backup_id,
-policy_name or -client_name is specified, then all the verify jobs executed on the
days specified by day stamps (mmddyy) will be traced. If –start_time/-end_time options
are used then the debug logs in the specified time interval are examined.
If verifytrace is started with the -backup_id id option then verifytrace looks for a
verify job started using bpverify with -backup_id id option where the backup ids (id)
match.
419
verifytrace
If verifytrace is started with the -policy_name name option then verifytrace will
look for a verify job started via bpverify with -policy_name name option where the
policy names (name ) match.
If verifytrace is started with the -client_name name option then verifytrace will look
for a verify job started via bpverify with -client_name name option where the client
names (name ) match.
verifytrace writes error messages to standard error.
OPTIONS
-master_server
-job_id
Job ID number of the verify job to analyze. Default is any job id.
-backup_id
Backup ID number of the backup image verified by the verify job to
analyze. Default is any backup ID.
-policy_name
Policy name of the verify jobs to analyze. Default is any policy.
-client_name
Client name of the verify jobs to analyze. Default is any client.
-start_time
-end_time
mmddyy
One or more “day stamps”. This identifies the log file names
(log.mmddyy for UNIX, mmddyy.log for Windows) that will be
analyzed.
OUTPUT FORMAT
daystamp
millisecs
420
verifytrace
program
The name of program (ADMIN, BPBRM, BPCD, etc.) being logged.
sequence
machine
log_line
EXAMPLES
Example 1
The following example analyzes the log of verify job with job ID 2 executed on August 6,
2002.
verifytrace -job_id 2 080602
Example 2
The following example analyzes the log of verify jobs that verify backup image with
backup id pride_1028666945 executed on 20th August 2002. This command would analyze
only those verify jobs, which were executed with option -backupid pride_1028666945.
verifytrace -backup_id pride_1028666945 082002
Example 3
The following example analyzes the log of verify jobs executed on policy Pride-Standard
and client pride on August 16, 2002 and August 23, 2002. This command would analyze
only those verify jobs, which were executed with options -policy Pride-Standard and -client
pride.
verifytrace -policy_name Pride-Standard -client_name pride 081602 082302
Example 4
The following example analyzes the log of all verify jobs that are executed on August 5,
2002 and August 17, 2002.
verifytrace 080502 081702
421
vltcontainers
vltcontainers
NAME
vltcontainers - Move volumes logically into containers
SYNOPSIS
install_path\NetBackup\bin\vltcontainers
-run [-rn robot_number]
-run -usingbarcodes [-rn robot_number]
-run -vltcid container_id -vault vault_name -sessionid session_id
-run -vltcid container_id -f file_name [-rn robot_number] [-usingbarcodes]
-view [-vltcid container_id]
-change -vltcid container_id -rd return_date
-delete -vltcid container_id
-version
DESCRIPTION
vltcontainers logically adds media ejected from one or more vault sessions to
containers. vltcontainers also can view, set, or change the return date of containers
that are going off-site or are already at the off-site vault. vltcontainers can delete a
container from the NetBackup and Media Manager catalogs.
You can add media IDs to containers as follows:
◆ Use the keyboard to enter the container and media IDs.
◆ Use a keyboard interface bar code reader to scan the container and media IDs.
(Keyboard interface readers are also known as keyboard wedge readers because they
connect (or wedge) between the keyboard and the keyboard port on your computer.)
◆ Use an input file that contains the media IDs or numeric equivalents of bar codes of all
the media that will be added to one container. To add media to more than one
container, you must enter the IDs using the keyboard or a keyboard interface bar code
reader or you must invoke the vltcontainers command again and specify
different container and filename options.
◆ Add all the media ejected by a specific session to one container. To add media from a
single eject session into more than one container, you must enter the IDs using the
keyboard or a keyboard interface bar code reader.
422
vltcontainers
The vltcontainers command must be invoked from a NetBackup master server
licensed for Vault.
If a directory named install_path\netbackup\logs\vault with public-write access
exists, vltcontainers will write to the daily debug log file (log.DDMMYY where
DDMMYY is the current date) in this directory. Public-write access is required because not
all executable files that write to this file run as administrator or root user.
OPTIONS
-change
Changes the default return date for the container. The default return date
of a container is the date of the volume in the container that will be
returned the latest. Requires the -vltcid container_id option and
argument.
-delete
Deletes the container record from the NetBackup and Media Manager
catalogs. You can delete a container only if it contains no media. Requires
the -vltcid container_id option and argument.
-f file_name
Specifies the file from which to read media IDs. All media listed in the file
will be added to the container specified by the -vltcid option. The file
can be a list of media IDs (one per line) or the numeric equivalents of bar
codes (one per line) scanned into a file by a bar code reader.
-rd return_date
Specifies the return date for the container. The return date format
depends on the locale setting.
-rn robot_number
Specifies the robot, which is used to determine the EMM Server from
which the vltcontainers command should obtain media information.
If -rn robot_number is not used, the master server is considered as the
EMM server. Only media in the database on the EMM server can be
added to containers.
-run
Logically adds media to the container. If you specify no other options,
you must enter the container and media IDs by using the keyboard. To
use a bar code reader to scan the container and media IDs, specify the
-usingbarcodes option. To add the media ejected by a specific session,
use the -vault vault_name and -sessionid session_id options.
To add the media specified in a file, use the -f file_name option. To
specify a EMM server other than the master server, use the -rn
robot_number option.
423
vltcontainers
-sessionid session_id
The ID of a vault session. All media ejected by the session specified will
be added to the container specified by the -vltcid option.
-usingbarcodes
Specifies that a keyboard interface bar code reader will be used to scan
the container IDs and media IDs or that bar code numbers are used in the
file specified by the -f file_name option. Keyboard interface bar code
readers (also called keyboard wedge bar code readers) connect between
the keyboard and the keyboard port on your computer.
-vault vault_name
The name of the vault to which the profile that ejected the media belongs.
You also must specify the ID of the session (-sessionid) that ejected the
media to be added to the container.
-version
Display the vltcontainers version and exit.
-view [-vltcid container_id]
Shows the return date assigned to all containers. Use the -vltcid
container_id option and argument to show the return date of a
specific container.
-vltcid container_id
Specifies the container ID. Container ID can be a string of up to 29
alphanumeric characters (no spaces). When changing a container return
date, requires the -rd return_date option and argument.
EXAMPLES
Example 1:
To add the volumes ejected from robot number 0 to containers and use a bar code reader
to scan the container and media IDs, use the following command:
vltcontainers -run -usingbarcodes -rn 0
Example 2
To view the return date of container ABC123, use the following command:
vltcontainers -view -vltcid ABC123
Example 3
To change the return date of container ABC123 to December 07, 2004, use the following
command:
vltcontainers -change -vltcid ABC123 -rd 12/07/2004
Example 4
424
vltcontainers
To delete container ABC123 from the NetBackup and Media Manager catalogs, use the
following command:
vltcontainers -delete -vltcid ABC123
Example 5
To add all media ejected by session 4 of vault MyVault_Cntrs to container ABC123, use the
following command:
vltcontainers -run -vltcid ABC123 -vault MyVault_Cntrs -sessionid 4
Example 6
To add media listed in file C:\home\jack\medialist that are ejected from robot
number 0 to container ABC123, use the following command:
vltcontainers -run -vltcid ABC123 -f C:\home\jack\medialist -rn 0
Example 7
To add media to container ABC123 that was ejected from a robot that is attached to the
master server and read the bar codes for that media from file
C:\home\jack\medialist, use the following command:
vltcontainers -run -vltcid ABC123 -f C:\home\jack\medialist -usingbarcodes
RETURN VALUES
Vault may exit with a status code greater than 255. Such status codes are called extended
exit status codes. For such a case, the exit status returned to the system is 252, and the
actual exit status is written to stderr in the format EXIT status = exit status
The extended exit status values are documented in the NetBackup Troubleshooting Guide for
UNIX and Windows and in the NetBackup Troubleshooting Wizard.
FILES
install_path\NetBackup\vault\sessions\cntrDB
install_path\NetBackup\db\vault\vault.xml
install_path\netbackup\logs\vault
NOTES
The format that you use for date and time option values varies according to your locale
setting. The examples in this command description are for a locale setting of C.
425
vltcontainers
SEE ALSO
vltadm, vltoffsitemedia, vltopmenu
426
vlteject
vlteject
NAME
vlteject - Eject media and/or generate reports for previously run sessions
SYNOPSIS
The syntax for the command is:
install_path\NetBackup\bin\vlteject
-eject [-profile profile_name] [-robot robot_name] [-vault vault_name [-sessionid id]] [-auto y|n] [-eject_delay seconds]
-report [-profile profile_name] [-robot robot_name] [-vault vault_name [-sessionid id]] [-legacy]
-eject -report [-profile profile_name] [-robot robot_name] [-vault vault_name [-sessionid id]] [-auto y|n] [-eject_delay seconds] [-version] [-legacy]
-preview [-profile profile_name] [-robot robot_name] [-vault vault_name [-sessionid id]]
DESCRIPTION
vlteject ejects media and generates the corresponding reports (as configured in the
profiles) for vault sessions for which media have not yet been ejected. vlteject can
process the pending ejects and/or reports for all sessions, for a specific robot, for a specific
vault, or for a specific profile. To process all pending ejects and/or reports, do not use the
-profile, -robot, or -vault option.
vlteject operates only on sessions for which the session directory still exists. After that
directory is cleaned up (removed by NetBackup), vlteject can no longer eject or report
for that session.
Depending on how it is called it can run interactively or not. Running interactively is most
useful when you will be ejecting more media than will fit in the media access port.
Do not modify your vault configuration while vlteject is running.
vlteject can be run in any of the following ways:
◆ Directly from the command line
◆ By NetBackup policy scheduling. The policy must be of type Vault, and the policy's
file list must consist of a vlteject command.
◆ By using vltopmenu to run an eject operation or a consolidated eject or consolidated
report operation
427
vlteject
If a directory named install_path\netbackup\logs\vault with public-write access
exists, vlteject will write to the daily debug log file (log.DDMMYY where DDMMYY is
the current date) in this directory. Public-write access is required because not all
executable files that write to this file run as administrator or root user. The host property
Keep vault logs for n days determines how long the vault session directories are retained.
OPTIONS
-auto y|n
Specifies automatic (y) or interactive mode (n). In automatic mode (y),
vlteject runs without input from the user and does not display output.
In interactive mode (n, the default), vlteject runs interactively,
accepting input and displaying output.
-eject
Eject media for the indicated sessions. This is optional in case eject has
been completed and only generating reports is desired.
-eject_delay seconds
The number of seconds to delay before ejecting. This is desirable if an
operation such as backing up or duplication has just occurred on the
affected media. The default is 0. The maximum is 3600 (one hour).
-help
Displays a synopsis of command usage when it is the only option on the
command line.
-legacy
Generates reports using the old-style consolidation. Valid only with the
-report option.
-preview
Lists the sessions and the media that will be ejected for the sessions. Does
not eject the media.
-profile profile_name
The name of a profile or a robot number, vault, and profile for which to
eject media and/or generate reports. If profile is used without robot and
vault, the profile must be unique. To process all pending ejects and/or
reports, do not use the -profile, -robot, or -vault option.
-report
Generate reports for the indicated sessions. If the corresponding eject
process has been completed, pending reports from the sessions selected
are generated and distributed; the reports will not be generated again if
428
vlteject
vlteject is run again. If eject has not been completed, the subset of
reports that do not depend on completion of eject will be generated; these
reports will be generated again if vlteject -report is run again after
eject has been completed.
-robot robot_name
The robot for which to eject media and/or generate reports. All vaults in
the robot should use the same off-site volume group. To process all
pending ejects and/or reports, do not use the -profile, -robot, or
-vault option.
-sessionid id
The numeric session ID. If the -profile, -robot, or -vault option is
specified but the -session id option is not specified, vlteject will
operate on all sessions for the specified profile, robot, or vault.
-vault vault_name
The vault for which to eject media and/or generate reports. To process all
pending ejects and/or reports, do not use the -profile, -robot, or
-vault option.
-version
Display the vlteject version and exit.
EXAMPLES
Example 1
To eject media and generate reports for all robots that have sessions for which media have
not yet been ejected, enter the following:
vlteject -eject -report
Example 2
To eject all media that have not yet been ejected for all sessions for the CustomerDB vault
and to generate corresponding reports, enter the following:
vlteject -vault CustomerDB -eject -report
RETURN VALUES
actual exit status is written to stderr in the format, EXIT status = exit status
The extended exit status values are documented in the NetBackup Troubleshooting Guide for
UNIX and Windows and in the NetBackup Troubleshooting Wizard.
429
vlteject
FILES
install_path\NetBackup\logs\bpbrmvlt\mmddyy.log
install_path\NetBackup\logs\vault\mmddyy.log
install_path\NetBackup\vault\sessions\vault_name\sidxxx\detail.log
install_path\NetBackup\vault\sessions\vault_name\sidxxx\summary.lo
g
install_path\NetBackup\vault\sessions\vault_name\sidxxx\vlteject.s
tatus
install_path\NetBackup\vault\sessions\vlteject.mstr
install_path\NetBackup\bp.conf
SEE ALSO
vltopmenu
430
vltinject
vltinject
NAME
vltinject – inject volumes into a robot for a specified vault configuration
SYNOPSIS
install_path\NetBackup\bin\vltinject profile|robot/vault/profile [-version]
DESCRIPTION
vltinject injects volumes into a robot and updates the Enterprise Media Manager
Database. It accomplishes this by running the vmupdate command, giving it the robot
number, robot type, and robotic volume group from the vault configuration matching the
specified profile.
If you create a directory named install_path\netbackup\logs\vault with
public-write access, vltinject will create a daily debug log called log.DDMMYY (where
DDMMYY is the current date) file in this directory that can be used for troubleshooting.
Public-write access is needed because not all executables that write to this file run as root.
OPTIONS
profile|robot/vault/profile
The name of a profile or a robot number, vault, and profile nested within
the vault configuration file. If profile is used without robot and vault, the
profile must be unique. vltinject executes vmupdate with the robot
number, robot type, and robotic volume group from this profile's
configuration.
-version
Display the vltinject version and exit.
EXAMPLE
Example 1
To inject volumes that were vaulted by the Payroll profile and that have been returned
from the offsite vault, the user would enter the following:
vltinject Payroll
Example 2
431
vltinject
To inject volumes that were vaulted by the Weekly profile in the Finance vault and that
have been returned from the offsite vault, the user would enter the following:
vltinject 8/Finance/Weekly
RETURN VALUES
0
The EMM Database was successfully updated.
not = 0
There was a problem updating the EMM Database.
The extended exit status values are documented in the NetBackup Troubleshooting Guide
and in the NetBackup Troubleshooting Wizard.
FILES
432
vltoffsitemedia
vltoffsitemedia
NAME
vltoffsitemedia - list the offsite parameter values for a group of media, or change the
offsite parameter value for a single media.
SYNOPSIS
install_path\NetBackup\bin\vltoffsitemedia -list [-W] [-vault
vault_name] [-voldbhost host_name]
install_path\NetBackup\bin\vltoffsitemedia -change -m media_id
[-voldbhost host_name] [-d media_description]
[-vltname vault_name] [-vltsent date][-vltreturn date]
[-vltslot slot_no] [-vltcid container_id] [-vltsession
session_id]
install_path\NetBackup\bin\vltoffsitemedia -version
DESCRIPTION
Allows the user to change the vault-specific parameters of a given media. This allows the
user to change one or more parameters using a single command. It allows the user to view
the various vault parameters of all media for a particular EMM server or vault.
If you create a directory named:
UNIX: /usr/openv/netbackup/logs/vault
Windows: install_path\netbackup\logs\vault
with public-write access, vltoffsitemedia will create a daily debug log called
log.DDMMYY (where DDMMYY is the current date) file in this directory that can be used
for troubleshooting. Public-write access is needed because not all executables that write to
this file run as root.
OPTIONS
-change
Change the attributes of the specified volume.
-d media_description
Specifies the description for the volume.
To configure NetBackup so that the media description field is cleared
automatically when volumes are returned to the robot, set the VAULT_CLEAR_MEDIA_DESC parameter in EMM.
433
vltoffsitemedia
-list
Lists the off-site parameters for the media in the local EMM database. To
restrict the list to a specific vault for the local EMM database, include the
-vault option with the command. To list the off-site parameters for media
for a specific EMM database, include the -voldbhost option with the
command.
-m media_id
Media ID of the volume whose vault parameters are to be changed.
-vault vault_name
Name of the vault for which all media ids and their vault-specific
parameters are to be listed.
-version
Display the vltoffsitemedia version and exit.
-vltcid container_id
Specifies the container in which a volume is stored. container_id (a
string of up to 29 alphanumeric characters (no spaces)) specifies the new
container for the volume. You must specify an existing container ID. You
cannot assign media from one EMM server to a container that has media
from a different EMM server. Use the -m option to specify the media ID of
the volume.
-vltname vault_name
Specifies the name of the logical vault configured for the robot that
ejected the volume.
-vltreturn date
Specifies the date and time the media was requested for return from the
vault vendor. For Catalog Backup volumes, this is the date that the media
will be requested for return from the vault vendor.
follows:
-vltsent date
Specifies the date and time the media was sent to the offsite vault.
follows:
-vltsession session_id
Specifies the identifier of the Vault session that ejected this media.
434
vltoffsitemedia
-vltslot slot_no
Specifies the vault vendor's slot number for the slot that this volume
occupies.
-voldbhost host_name
Name of the EMM server.
-W
Specifies parsable output format for the media off-site parameters. For
containers, the output includes the length of the container description,
the container description, and the container ID. The output header line is
a space separated line of column labels; the output data lines are space
separated fields.
EXAMPLES
Example 1
The following command will change the vault name and the vault sent dates of the media
with the ID BYQ123:
vltoffsitemedia -change -m BYQ123 -vltname THISTLE -vltsent 08/01/2003 12:22:00
Example 2
The following command will change the vault slot number to 100 for a media with ID
000012:
vltoffsitemedia -change -m 000012 -vltslot 100
Example 3
The following command can be used to clear out the vault-specific fields for a media:
vltoffsitemedia -change -m 000012 -vltname "" -vltsession 0 -vltslot 0 -vltsent 0 -vltreturn 0
or:
vltoffsitemedia -change -m 000012 -vltname - -vltsession 0 -vltslot 0 -vltsent 00/00/00 -vltreturn 00/00/00
Example 4
To change the container ID and media description of volume ABC123:
vltoffsitemedia -change -m ABC123 -vltcid Container001 -d "Media Added By Jack"
Example 5
To clear the container ID and media description of volume ABC123:
435
vltoffsitemedia
vltoffsitemedia -change -m ABC123 -vltcid - -d "" or:
vltoffsitemedia -change -m ABC123 -vltcid "" -d ""
The vltoffsitemedia command uses the Media Manager commands to query/update
the EMM database. If the vltoffsitemedia command fails, look at the debug log in the
install_path\netbackup\logs\vault directory for detailed information about the
actual Media Manager command that failed. Status codes returned by Media Manager
commands are documented in Chapter 5 of the NetBackup Troubleshooting Guide, Media
Manager Status Codes and Messages.
RETURN VALUES
Vault may exit with a status code greater than 255. Such status codes are called "extended
exit status codes". For such a case, the exit status returned to the system is 252, and the
NOTES
436
vltopmenu
vltopmenu
NAME
vltopmenu - Start the NetBackup Vault menu interface for operators
SYNOPSIS
install_path\NetBackup\bin\vltopmenu [-version]
DESCRIPTION
Allows the user to invoke a menu screen containing the various options that an Operator
of the NetBackup Vault feature can use. It allows the user to eject or inject media, print
various reports individually or collectively, as well as consolidate all reports and ejects for
all sessions which have not yet ejected media. This interface can be used from any
character-based terminal (or terminal emulation window) for which the user has a
termcap or terminfo definition.
See the NetBackup Operator’s Guide for detailed operating instructions.
OPTIONS
-version
Display the vltopmenu version and exit.
RETURN VALUES
FILES
install_path\NetBackup\vault\sessions\vlteject.mstr
install_path\NetBackup\vault\sessions\vlteject_status.log.timestam
p
install_path\NetBackup\vault\sessions\*\sid*\detail.log
437
vltrun
vltrun
NAME
vltrun - Run a NetBackup Vault session
SYNOPSIS
install_path\NetBackup\bin\vltrun profile | robot/vault/profile
[-preview] [-verbose|-v] [-version] [-help]
DESCRIPTION
vltrun drives a NetBackup Vault session by issuing a sequence of calls to the vault
engine. Optionally, the session can include callouts to user-provided notify scripts.
OPTIONS
profile|robot/vault/profile
The name of a profile or a nested robot number, vault, and profile in the
vault parameter file. If profile is used without robot and vault, the profile
must be unique within the vault parameter file. This option is required.
-preview
Generate the Preview list of images to be vaulted in a vault session. The
results go to the file preview.list in the session directory..
-verbose|-v
Report verbosely on the session in the vault debug log.
-version
Display the vltrun version and exit.
-help
Displays a synopsis of command usage when it is the only option on the
command line.
USAGE
The vltrun session follows this sequence:
438
◆
Run the vlt_start_notify script
◆
Inventory media
◆
Initialize Enterprise Media Manager Database for vault media returned to the robot
◆
Generate the list of preview images to be vaulted
◆
Duplicate images
vltrun
◆ Inventory Enterprise Media Manager Database (first time)
◆ Assign media for the NetBackup catalog backup
◆ Inventory Enterprise Media Manager Database (second time)
◆ Inventory images
◆ Suspend media
◆ Run the vlt_end_notify script
◆ Re-inventory images
◆ Assign slot IDs
◆ Backup the NetBackup catalog
◆ Inventory the Enterprise Media Manager Database (third and final time)
◆ Run the vlt_ejectlist_notify script
◆ Generate the eject list
◆ Run the vlt_starteject_notify script
◆ Eject and report
◆
Run the vlt_end_notify script
vltrun can be run in any of the following ways:
◆ directly from the command line;
◆ by NetBackup policy scheduling. In this case, the policy must consist of type Vault,
and the policy's file list must consist of a vltrun command;
◆ by running the command Start Session for a profile in the Vault GUI or vltadm.
vltrun uses the option profile|robot/vault/profile to run a vault session. You can use the
profile form of the option if there is no other profile with the same name in your vault
configuration. In this case, the profile name is sufficient to uniquely identify the
configuration information.
If there is more than one profile with the same name, then use the robot/vault/profile form to
uniquely identify the configuration.
Do not modify your vault configuration while a vault session is running.
When the session starts, it creates a directory to hold the files created by vltrun and the
vault engine during the session.
The vault session directory is
install_path\NetBackup\vault\sessions\vault_name\sidxxx where xxx is
an integer uniquely assigned to this session. For each vault name, session identifiers are
sequentially assigned, starting with 1.
439
vltrun
If you have configured an email address in your vault properties, then email will be sent
to this address at the end of the session, reporting the results. By default, email is sent to
root.
vltrun produces an overview of the session, called summary.log, in the session
directory.
You can control vault processing at several points in the session by installing notify scripts
in the directory for NetBackup binaries, /usr/openv/netbackup/bin. Refer to the
NetBackup Vault System Administrator’s Guide for more information on notify scripts.
You can monitor the progress of your vltrun session in the NetBackup Activity Monitor.
The Operation field on the main Activity Monitor window shows the progress of your
vault session:
◆
Choosing Images
◆
Duplicating Images
◆
Choosing Media
◆
Catalog Backup
◆
Eject and Report
◆
Done
If you create a directory named install_path\NetBackup\logs\vault with public-write
access, vltrun will create a daily debug log called log.DDMMYY (where DDMMYY is the
current date) file in this directory that can be used for troubleshooting. Public-write access
is needed because not all executables that write to this file run as root.
You can adjust the level of logging information provided in this log file by adjusting the
vault logging level parameter on the Logging page of the master server’s properties via
Host Properties on the NetBackup Console.
You must have administrator privileges on the master server to execute this command.
EXAMPLES
Example 1
To vault the profile my_profile, enter:
vltrun my_profile
Example 2
The following command vaults the images for robot 0, vault Financials, and profile
Weekly:
vltrun 0/Financials/Weekly
440
vltrun
RETURN VALUES
FILES
install_path\NetBackup\vault
install_path\NetBackup\bp.conf
install_path\NetBackup\logs\bpbrmvlt\mmddyy.log
install_path\NetBackup\logs\bpcd\mmddyy.log
install_path\NetBackup\vault\sessions\vault_name\sidxxx
install_path\NetBackup\vault\sessions\vault_name\sidxxx\summary.lo
g
install_path\NetBackup\vault\sessions\vault_name\sidxxx\detail.log
SEE ALSO
vltadm, vlteject, vltinject, vltoffsitemedia, vltopmenu
441
vmadd
vmadd
NAME
vmadd - Add volumes to the Enterprise Media Manager database.
SYNOPSIS
install_path\Volmgr\bin\vmadd -m media_id -mt media_type [-h
EMM_server | volume_database_host] [-verbose] [-b
barcode] [-rt robot_type] [-rn robot_number] [-rh
robot_host] [-rc1 rob_slot] [-rc2 rob_side] [-p pool_number]
[-mm max_mounts | -n cleanings] [-op optical_partner] [-d
"media_description"]
DESCRIPTION
Add volumes to the Enterprise Media Manager (EMM) Database.
NetBackup System Administrator's Guide or the NetBackup Media Manager System
OPTIONS
-m media_id
Specifies the media ID of the volume to add. The media ID can be a
maximum of 6 ASCII characters. The actual character input is restricted to
alpha numerics and '.', '+', '_', and '-' if they are not the first character.
If you are adding an optical disk, specify the media ID for the A side of
the optical platter. Media IDs for an API robot type (ACS, TLH, TLM, or )
must always match the barcodes.
-mt media_type
Specifies the media type of the volume to add.
4mm, 8mm, 8mm2, 8mm3, dlt, dlt2, dlt3, dtf, hcart, hcart2, hcart3,
odiskwm, odiskwo, qcart, 4mm_clean, 8mm_clean, 8mm2_clean,
8mm3_clean, dlt_clean, dlt2_clean, dlt3_clean, dtf_clean, hcart_clean,
hcart2_clean, hcart3_clean.
4mm, 8mm, dlt, hcart, qcart, 4mm_clean, 8mm_clean, dlt_clean,
hcart_clean.
442
vmadd
-h EMM_server | volume_database_host
The name of the Enterprise Media Manager database host which contains
information about volumes. If no host is specified, the configured EMM
server is used by default. For communicating with pre-NetBackup 6.0
systems not in the EMM domain, this is the EMM server.
For systems prior to NetBackup 6.0, you should ensure that the host
specified matches the EMM server name associated with the robot or set
of standalone drives, as indicated in the device configuration.
-verbose
Selects verbose mode.
-b barcode
Specifies the barcode attached to the volume.
-rt robot_type
Specifies the robot type of the robot where the volume is located.
Valid robot types for NetBackup Enterprise Server follow:
none, acs, odl, tl4, tl8, tld, tlh, tlm, tsh.
Valid robot types for NetBackup Server follow:
none, tl4, tl8, tld.
-rn robot_number
Unique, logical identification number for the robot where the volume is
located.
-rh robot_host
Name of the host which controls the robot, where the volume is located.
-rc1 rob_slot
Robot coordinate 1 is the slot number in the robot where the volume is
located.
Do not enter slot information for Media Manager API robot types. The
robot software tracks the slot locations for these robots.
-rc2 rob_side
Robot coordinate 2 is the platter side for optical disks (A or B).
-p pool_number
Index of the volume pool which will contain this volume. You can use
vmpool -listall to determine the index for a given pool name.
443
vmadd
-mm max_mounts
Maximum number of mounts allowed for this volume. Only used for
non-cleaning media. When this limit is exceeded, the volume can be
mounted for read operations only.
-n cleanings
Number of cleanings remaining for this volume. Only used for cleaning
media.
-op optical_partner
If this is an optical disk, specify the media ID of the opposite side of the
optical platter.
-d "media_description"
Media description of the volume. The double quote marks are required if
the description contains any spaces.
EXAMPLES
The following command adds volume AJU244 in the NetBackup volume pool to the EMM
database on the host named llama.
The volume, with a barcode of AJU244, is in slot 2 of TLD robot 1. For write operations,
the volume may be mounted a maximum of 1000 times.
The following point applies only to NetBackup Server:
There is only one host (the master), so the -h option is not needed.
Note This command is usually entered on only one line.
vmadd -m AJU244 -mt dlt -h llama -b AJU244 -rt tld -rn 1 -rh llama -rc1 2 -p 1 -mm 1000 -d "vmadd example"
NOTES
Only limited validation of the option parameters is done.
SEE ALSO
vmchange, vmdelete, vmpool, vmquery
444
vmchange
vmchange
NAME
vmchange - change media information in the Enterprise Media Manager database
SYNOPSIS
Change volume group residence
install_path\Volmgr\bin\vmchange [-h EMM_server |
volume_database_host] -vg_res -rt robot_type -rn
robot_number -rh robot_control_host -v volume_group
Change volume residence
volume_database_host] -res -m media_id -mt media_type -rt
robot_type -rn robot_number -rh robot_control_host -v
volume_group -rc1 rob_slot [-rc2 rob_side]
Change volume expiration date
volume_database_host] -exp date -m media_id
Change the barcode for a volume
volume_database_host] -barcode barcode -m media_id [-rt
robot_type]
Change the container ID for a volume by media ID
volume_database_host] -m media_id -vltcid
vault_container_id
Change the container ID for a volume by bar code
volume_database_host] -barcode barcode -vltcid
vault_container_id
Change the media description for a volume
volume_database_host] -d "media_description" -m media_id
Associate this volume with a different pool
volume_database_host] -p pool_number -m media_id
445
vmchange
Change a volume's maximum mount count
volume_database_host] -maxmounts max_mounts -m media_id
Change a volume's number of cleanings
install_path\Volmgr\bin\vmchange [-h EMM_server | volume_database_host] -clean cleanings left -m media_id
Change a volume's number of mounts count
install_path\Volmgr\bin\vmchange [-h EMM_server | volume_database_host] -n num_mounts -m media_id
Change a volume's media type
volume_database_host] -new_mt media_type -m media_id
Change a volume's robot type
volume_database_host] -new_rt robot_type -m media_id -rn
robot_number
Change a volume's group
volume_database_host] -new_v volume_group [-m media_id |{-b
barcode -mt media_type -rt robot_type}]
Change a volume's vault name
volume_database_host] -vltname vault_name -m media_id
Change the date the volume was sent to the vault
install_path\Volmgr\bin\vmchange [-h EMM_server | volume_database_host] -vltsent date -m media_id
Change the date when the volume returns from the vault
install_path\Volmgr\bin\vmchange [-h EMM_server | volume_database_host] -vltreturn date -m media_id
Change a volume's vault slot number
install_path\Volmgr\bin\vmchange [-h EMM_server | volume_database_host] -vltslot vault_slot -m media_id
Change the volume's vault session id
446
vmchange
volume_database_host] -vltsession vault_session_id -m media_id
Move (eject) volumes from an ACS, TLH, or TLM robot to standalone
install_path\Volmgr\bin\vmchange -api_eject -map map_id:mapid:...:mapid
| any -w [-h EMM_server | volume_database_host] -res -ml
media_id:media_id: ...:media_id -rt robot_type -rn robot_number
-rh robot_control_host [-v volume_group]
Move (eject) multiple volumes from a TL8 or TLD robot to standalone
install_path\Volmgr\bin\vmchange -multi_eject -w [-h EMM_server |
volume_database_host] -res -ml media_id:media_id: ...:media_id
-rt robot_type -verbose -rn robot_number -rh
robot_control_host
Move (inject) multiple volumes into a TL8 or TLD robot
install_path\Volmgr\bin\vmchange -multi_inject -w -res -rt
robot_type -verbose -rn robot_number -rh robot_control_host
Get robot information for a TL8 or TLD robot type
install_path\Volmgr\bin\vmchange -res -robot_info -verbose -rn
robot_number -rt robot_type -rh robot_control_host
DESCRIPTION
Change volume information in the Enterprise Media Manager database.
OPTIONS
information about volumes.. If no host is specified, the configured EMM
server is used by default. For communicating with pre-6.0 systems not in
the EMM domain, this is the EMM server.
-vg_res
Change volume group residence.
-rt robot_type
Specifies the robot type of the robot where the volume is located.
447
vmchange
-rn robot_number
Unique, logical identification number for the robot where the volume is
located.
-rh robot_control_host
-v volume_group
A volume group is a logical grouping that identifies a set of volumes
that reside at the same physical location.
-res
Change the volume’s residence.
-m media_id
Specifies the media ID of the volume to change.
-mt media_type
Specifies the media type of the volume to change.
hcart_clean.
-rc1 rob_slot
Robot coordinate 1 is the slot number in the robot where the volume is
located.
Do not enter slot information for API robot types. The robot software
tracks the slot locations for these robots.
-rc2 rob_side
Robot coordinate 2 is the platter side for optical disks (A or B).
-exp date
Expiration date for this volume.
448
vmchange
follows:
-barcode barcode
-d "media_description"
Media description for the volume. The double quote marks are required
if the description contains any spaces.
-p pool_number
Index of the volume pool which will contain this volume. You can get
the pool index using vmpool -listall.
-maxmounts max_mounts
Maximum number of mounts allowed for this volume. Only used for
non-cleaning media.
-n num_mounts
For non-cleaning media, num_mounts is the number of times this volume
has been mounted.
-clean cleanings left
For cleaning media, cleanings left is the number of cleanings left for this
cleaning tape.
-new_mt media_type
Specifies the media type of the volume to change. See the -mt option for
a list of media types.
-new_rt robot_type
Specifies the robot type. See the -rt option for a list of robot types.
-new_v volume_group
A volume group is a logical grouping that identifies a set of volumes
that reside at the same physical location.
-b barcode
-vltcid vault_container_id
Change the container in which a volume is stored.
vault_container_id (a string of up to 29 alphanumeric characters)
specifies the new container for the volume. Use the -m or -barcode
option to specify the volume.
449
vmchange
-vltname vault_name
Specifies the name of the logical vault configured for the robot that
ejected the volume.
-vltsent date
Specifies the date the volume was sent offsite.
follows:
-vltreturn date
Specifies the date the volume was requested for return from the vault
vendor. For catalog backup volumes, this is the date that the volume will
be requested for return from the vault vendor.
follows:
-vltslot vault_slot
Specifies the vault vendor's slot number for the slot that this volume
occupies.
-vltsession vault_session_id
Specifies the id of the vault session that ejected this media.
-api_eject
Eject ACS, TLH, or TLM volumes from the specified robot. For ACS and
TLM robots, the ejection timeoout period is one week. For TLH robots,
the robot allows an unlimited period to remove media.
-map map_id:mapid: ...:mapid | any
For ACS robots, this option can specify multiple media access ports
(MAPs) to use for eject operations. The map_id (also known as the CAP
ID) can be all or ALL, which specifies all MAPs in the robot, or a colon
separated list of MAP IDs in the format of ACS,LSM,CAP. When the
-map option is used, media are ejected to the MAPs specified using a
nearest MAP algorithm. The algorithm assumes that the LSMs are
connected in a line; if your LSMs are connected in a configuration other
than a line, see Adjacent LSM Specification for ACS Robots and Media
Access Port Default for ACS Robots in the NetBackup Media Manager
System Administrator’s Guide.
For TLM robots, use map_id “ANY” to eject to the MAP configured for
each media type on the DAS/SDLC server.
450
vmchange
For TLH robots, select the “standard” MAP or the “BULK” MAP,
depending on the library’s hardware configuration.
-w
Wait flag. This flag must be used with the eject, multiple eject, and
multiple inject commands.
-verbose
Selects verbose mode.
-ml media_id:media_id: ...:media_id
Specifies a list of media to be ejected from the robot.
-multi_eject
This option is valid only for TL8 and TLD robot types. Use the robotic
library’s media access port to eject multiple volumes. The ejection
timeout period is 30 minutes.
-multi_inject
This option is valid only for TL8 and TLD robot types. Used the robotic
library’s media access port to inject multiple volumes.
-robot_info
Used to retrieve information about a robotic library. This option is valid
only for TLD and TL8 robot types
CAUTIONS
Some robotic libraries implement different functionality for their media access ports. For
example, some libraries have front-panel inject and eject features that conflict with
NetBackup’s use of the media access port (for example, Spectra Logic Bullfrog). Other
libraries require front-panel interaction when using the media access port (for example,
Spectra Logic Gator).
If you are using an eject option and the media is not removed and a time-out condition
occurs, the media is returned to (injected into) the robot. If this occurs, you should
inventory the robot and then eject the media that was returned to the robot.
Make sure you read the operator manual for your robotic library to gain an understanding
of its media access port functionality. Libraries such as the ones noted may not be fully
compatible with NetBackup’s inject and eject features if not properly handled. Other
libraries may not be compatible at all. In addition, VERITAS performs limited validation
of these option parameters.
EXAMPLES
Example 1
The following command changes the expiration date of volume AJS100:
vmchange -exp 12/31/99 23:59:59 -m AJS100
451
vmchange
Example 2
The following command changes the pool (which contains volume AJS999) to pool 1
(which is the NetBackup pool):
vmchange -p 1 -m AJS999
Example 3
The following command ejects volumes abc123 and abc124 from ACS robot number
700. The residences for these two volumes are changed to standalone.
vmchange -res -api_eject -w -ml abc123:abc124 -rt acs -rn 700 -rh verbena -map 0,0,0
Example 4
The following command changes the container ID of volume ABC123:
vmchange -vltcid Container001 -m ABC123
NOTES
SEE ALSO
vmadd, vmdelete, vmpool, vmquery
452
vmcheckxxx
vmcheckxxx
NAME
vmcheckxxx - Report the media contents of a robotic library
SYNOPSIS
install_path\Volmgr\bin\vmcheckxxx -rt robot_type -rn robot_number [-rh
robot_host] [-h EMM_server | volume_database_host] [[-if
inventory_filter_value] [-if inventory_filter_value] ...] [-full]
[-list]
DESCRIPTION
Report the media contents of a robotic library and optionally compare its contents with
the volume configuration.
If no options are specified, the media contents of the robot and the volume configuration
are listed along with a list of any mismatches detected.
OPTIONS
-rt robot_type
Specifies the robot type of the robot to inventory.
-rn robot_number
Unique, logical identification number of the robot to inventory.
-rh robot_host
Name of the host which controls the robot. If no host is specified, the host
where you execute this command is assumed.
information about the volumes in a robot. If no host is specified, the
configured EMM server is used by default. For communicating with
453
vmcheckxxx
pre-NetBackup 6.0 systems not in the EMM domain, this is the EMM
server. If no host is not specified, but a pre-NetBackup 6.0 robotic control
host is specified on the -rh option, the robotic control host will be used as
the EMM server.
-if inventory_filter_value
Specifies inventory filter values. Multiple -if options may be specified.
The inventory filter value is an ACS scratch pool ID, or a TLH volume
category.
The -if and -full options cannot be specified together.
-full
Specifies full inventory. The -full and -if options cannot be specified
together.
-list
Lists the robot contents.
NOTES
EXAMPLES
The following command lists the media contents of TLD robot 1 and the volume
configuration for that robot on the host named server2, along with a list of any
mismatches that are detected:
vmcheckxxx -rt tld -rn 1 -rh server2
The following command lists the contents of TLH robot 2 that is connected to the host
where the vmcheckxxx command was executed:
vmcheckxxx -rt tlh -rn 2 -list
SEE ALSO
vmupdate
454
vmdelete
vmdelete
NAME
vmdelete - Delete volumes from the Enterprise Media Manager database
SYNOPSIS
install_path\Volmgr\bin\vmdelete [-h EMM_server |
volume_database_host] [-m media_id | -v volume_group]
DESCRIPTION
Delete volumes from the Enterprise Media Manager database.
OPTIONS
-m media_id
Specifies the media id of the volume to delete from the volume database.
-v volume_group
Specifies the volume group to delete. All volumes in this group are
deleted from the volume database.
NOTES
EXAMPLES
The following command deletes a single volume:
vmdelete -m AJS144
The following command deletes all volumes with the volume group name of
DELETE_ME:
vmdelete -v DELETE_ME
455
vmdelete
SEE ALSO
vmadd, vmchange, vmquery
456
vmoprcmd
vmoprcmd
NAME
vmoprcmd - Perform operator functions on drives
SYNOPSIS
Device Host commands
install_path\Volmgr\bin\vmoprcmd -devmon [pr | ds | hs] default operation
install_path\Volmgr\bin\vmoprcmd -dp [pr | ds | ad] [-h device_host] Up/Down/Reset drive commands
install_path\Volmgr\bin\vmoprcmd -down | -up | -upopr | -reset drive_index [-h device_host]
install_path\Volmgr\bin\vmoprcmd -downbyname | -upbyname | -upoprbyname | -path drive_path] [-nh ndmp_hostname] [-h device_host]
install_path\Volmgr\bin\vmoprcmd -resetbyname drive_name [-h device_host]
Assign mount request to drive commands
install_path\Volmgr\bin\vmoprcmd -assign drive_index
mount_request_id [-h device_host]
install_path\Volmgr\bin\vmoprcmd -assignbyname drive_name
mount_request_id [-h device_host]
Deny or resubmit mount request command
install_path\Volmgr\bin\vmoprcmd -deny | -resubmit mount_request_index [-h device_host]
Comment the drive command
install_path\Volmgr\bin\vmoprcmd -comment drive_index
["comment"] [-h device_host]
install_path\Volmgr\bin\vmoprcmd -commentbyname drive_name
["comment"] [-h device_host]
SCSI release of SSO drive command
install_path\Volmgr\bin\vmoprcmd -crawlreleasebyname drive_name
[-h EMM_Server]
457
vmoprcmd
Activate/Deactivate host command
install_path\Volmgr\bin\vmoprcmd [-activate_host | -deactivate_host] [-h device_host]
Get host status command
install_path\Volmgr\bin\vmoprcmd -hoststatus [-h device_host]
Display usage command
install_path\Volmgr\bin\vmoprcmd -help
The following usage is provided for backward compatibility only:
install_path\Volmgr\bin\vmoprcmd [-h volume_database_host] {-d [pr
| ds | ad] | -dps [drive_name]}
DESCRIPTION
Perform operator functions on drives. The -h option is not required, but you must choose
one and only one of the other options listed below.
Non NDMP Windows device paths will be displayed as {p,b,t,l} where p is the port, b is
the bus, t is the target and l is the lun. When vmoprcmd is invoked using the -path
argument, the path should be specified in the {p,b,t,l} format.
OPTIONS
-assign drive_index mount_request_id
Assign a drive to a mount request.
-assignbyname drive_name mount_request_id
This option is similar to the -assign option, except the drive is
specified by the drive name instead of drive index.
The following point applies only to NetBackup Server:
The device host is the host where Media Manager is installed.
-comment drive_index ["comment"]
Add a comment for the drive. The quotes are required if your comment
contains any spaces. If you do not specify comment, any existing
comments for the drive are deleted.
-commentbyname drive_name ["comment"]
This option is similar to the -comment option, except the drive is
specified by the drive name instead of drive index.
458
vmoprcmd
-crawlreleasebyname drive_name
This option forces all hosts (that are registered to use the drive) to issue a
SCSI release command to the drive. Issue this option on the host that is
the SSO device allocator (DA host) or use the -h option to specify the DA
host.
Caution Use this option after a PEND status has been seen in Device Monitor. Do not
use this option during backups.
-down | -up | -upopr | -reset drive_index
-down Sets the drive to the DOWN state, if it is not assigned.
-up Sets the drive to UP in Automatic Volume Recognition (AVR)
mode. This is the normal mode for all drives.
-upopr Sets the drive to UP in Operator (OPR) mode. This mode is
normally used only for security reasons. For a drive in a robot, OPR and
AVR are treated identically while the robot process is up.
-reset Resets the specified drive, terminating the drive assignment
and taking control away from the assigned user.
Caution Do not reset an assigned drive unless directed by site policy or the system
administrator. Terminating an active job can destroy user data.
-downbyname | -upbyname | -upoprbyname | -resetbyname drive_name
These options are similar to -down, -up, -upopr, and -reset
respectively, except the drive is specified by the drive name instead of
drive index.
-deny | -resubmit mount_request_id
-deny Denying a mount request returns an error message to the user.
-resubmit Resubmit a mount request. If a pending action message
involves a robot, you must correct the problem and resubmit the request
that caused the message.
-d [pr | ds | ad]
This command is supported for pre-NetBackup 6.0 systems. If none of the
following optional display parameters are specified, all information is
displayed.
pr Displays pending requests.
ds Displays the status of drives under control of Media Manager.
ad Displays additional status of drives under control of Media
Manager.
459
vmoprcmd
-devmon | -dp [pr | ds | hs]
The -dp command lists all of the drive paths that are configured for a
given drive name. If none of the following optional display parameters
are specified, all information is displayed.
pr Displays pending requests.
ds Displays the status of drives under control of Media Manager.
hs Displays additional status of drives under control of Media Manager.
-dps [drive_name]
Lists all of the drive paths that are configured for a given drive name..
-h EMM_Server | volume_database_host | device host
Name of the Enterprise Media Manager database host where the drives
are attached and configured. (For communicating with pre-6.0 systems
not in the EMM domain, this is the EMM server.) If no host option is
specified, the device host where you execute the command is default.
The device host is the host where the device is attached and configured.
The volume_database_host is the host where the device is attached
and configured for pre-6.0 systems.
-help
Displays the usage statement for this command.
-hoststatus
Displays the current status of the host. Possible states that may be displyed are:
DEACTIVATED - This state prevents any new jobs from starting on this
host.
ACTIVE - The media server is available to run any jobs.
ACTIVE-DISK - The media server is available to run jobs for disk storage units only.
ACTIVE-TAPE - The media server is available to run jobs for tape storage units only.
OFFLINE - The media server is not available to run jobs for either tape or
disk storage units. This state occurs because the media server is not active for tape or disk, or because the master server cannot communicate with the media server.
-nh ndmp_hostname
Specifies the hostname of the NDMP server.
-activate_host
Makes the host available to run jobs.
460
vmoprcmd
-deactivate_host
Makes the host unavailable to run jobs.
-path drivepath
Specifies the system name for the drive. For example, /dev/rmt/0cbn.
-setpath drivepath drive_name ndmp_hostname
Specifies the system name and the drive name of the NDMP host.
NOTES
tpconfig -d, tpconfig -l, and vmoprcmd may truncate long drive names. Please use tpconfig -dl to obtain the full drive name.
vmoprcmd may truncate drive names to 20 characters.
EXAMPLES
Example 1
The following command sets the drive, with a drive index of 0, to UP mode:
vmoprcmd -up 0
Example 2
The following command displays the drive status of all drives:
vmoprcmd -d ds
Example 3
The following command displays pending requests and the drive status of all drives on
the device host named crab:
vmoprcmd -h crab
Example 4
The following command demonstrates how non-NDMP Windows device paths will be
displayed.
C:\Program Files\VERITAS\Volmgr\bin>vmoprcmd
HOST STATUS
Host Name
=========================================
Version
=======
Host Status
===========
461
vmoprcmd
hamex
600000
ACTIVE
PENDING REQUESTS
<NONE>
DRIVE STATUS
Drive Name
Label
Ready RecMID ExtMID Wr.Enbl. Type
Host
DrivePath
Status
=====================================================================
IBM.ULTRIUM-TD2.001
No
No
No
hcart2
hamex
{3,1,0,2}
TLD
hamex
{3,1,1,2}
TLD
IBM.ULTRIUM-TD2.002
hamex
hamex
No
No
{3,1,0,5}
{3,1,1,5}
No
hcart2
TLD
TLD
IBM.ULTRIUM-TD1.003
hamex
hamex
No
No
{3,1,0,6}
{3,1,1,6}
No
hcart
TLD
TLD
IBM.ULTRIUM-TD1.004
hamex
hamex
No
No
{3,1,0,7}
{3,1,1,7}
No
hcart
TLD
TLD
IBM.ULTRIUM-TD2.005
hamex
Yes
Yes
J945L2
{3,1,2,1}
Yes
hcart2
TLD
IBM.ULTRIUM-TD2.006
hamex
No
No
hcart2
TLD
No
{3,1,2,2}
C:\Program Files\VERITAS\Volmgr\bin>
C:\Program Files\VERITAS\Volmgr\bin>vmoprcmd -downbyname IBM.ULTRIUM-TD1.003 -path {3,1,0,6}
C:\Program Files\VERITAS\Volmgr\bin
SEE ALSO
tpconfig(1M)
462
vmphyinv
vmphyinv
NAME
vmphyinv - Physically inventory the media contents of a robotic library or standalone
drive and update the volume database.
SYNOPSIS
install_path\volmgr\bin\vmphyinv -rn robot_number] [-rh
robot_control_host] [-h device_host]
[-pn pool_name] [-v volume_group] [-rc1 robot_coord1 -number
number]
[-drv_cnt count] [-non_interactive] [-mount_timeout timeout]
[-verbose]
-ml media_id:media_id:...:media_id [-drv_cnt count]
[-non_interactive] [-mount_timeout timeout] [-verbose]
[
{ { [-slot_range from to] [-slot_list s1:s2:...:sN] } -d
density }
{ { [-slot_range from to] [-slot_list s1:s2:...:sN] } -d
density }
]
[-drv_cnt count] [-non_interactive] [-mount_timeout timeout]
[-verbose]
install_path\volmgr\bin\vmphyinv {-u drive_number | -n drive_name}
[-h device_host]
[-non_interactive] [-mount_timeout timeout] [-verbose]
463
vmphyinv
DESCRIPTION
Physically inventory the media contents of a robotic library or standalone drive and
update the EMM database. vmphyinv mounts each media specified by the search
criterion, reads the tape header, and updates the EMM database based on the information
obtained from the tape header. For more information about this command, refer to the
NetBackup Media Manager systems administrator’s guide.
OPTIONS
-rn robot_number
Specifies the Media Manager robot number whose media will be
inventoried. robot_number should correspond to a robot which has
drives that have already been configured. vmphyinv inventories each of
the media, having robot_number in the volume database of
robot_number.
-rh robot_host
Specified the name of the host that controls the robot. If no host is
specified, the host where this command is executed is assumed.
-h device_host
Specifies the device host name. This option is used to obtain the
Enterprise Media Manager Server name. If not specified, the current host
is used to obtain the EMM server name.
-pn pool_name
Specifies the case-sensitive pool name of the volumes, corresponding to
robot specified by the -rn option, which need to be inventoried. Valid
only when the -rn option is specified.
-v volume_group
Specifies the volume group of the volmes, corresponding to robot
specified by the -rn option, which need to be inventoried. Valid only
when the -rn option is specified.
-rc1 robot_coord1
Specifies the starting slot of the media which needs to be inventoried.
Valid only when the -rn option is specified.
-number number
Specifies the number of slots starting from robot_coord1 which need to be
inventoried. Valid only when -rn and -rc1 are also specified.
464
vmphyinv
-ml media_id1:media_id2: … :media_idN
Specifies a list of media, which need to be inventoried. Valid only when
-rn option is specified. If the media ID specified does not belong to the
specified robot, the media will be skipped.
-slot_range from to
Specifies a range of slots that need to be inventoried. If one or more slots
are empty those slots are skipped.
-slot_list s1:s2:…sN
Specifies a list of slots that need to be inventoried. If one or more slots are
empty those slots are skipped.
-d density
Specifies the density of the media. The user must specify the media
density while inventorying the media by slot range/list.
-u drive_number
Specifies the drive index that needs to be inventoried. The drive must
contain media and be ready. The number for the drive can be obtained
from the Media Manager device configuration.
-n drive_name
Specifies the drive name that needs to be inventoried. The drive must
contain media and be ready. The name for the drive can be obtained from
the Media Manager device configuration.
-non_interactive
vmphyinv, in the default mode displays a list of recommendation and
ask for confirmation before modifying volume database and Enterprise
Media Manager Database (if required). If this option is specified, the
changes are applied without any confirmation.
-mount_timeout timeout
Specifies the mount timeout in seconds. If the media cannot be mounted
within the time specified, the mount request is cancelled. The default
value is 15 minutes.
-drv_cnt count
Specifies the maximum number of drives that can be used simultaneously
by vmphyinv. The actual number of drives used by vmphyinv is
determined by the total number of drives configured and this value. The
number of drives used by vmphyinv is the minimum of the drive count
specified and the total number of drives configured. The default is to use
all the drives.
465
vmphyinv
-verbose
Selects the verbose mode. When specified, more information (for
example, the number of available drives, what is found on each tape, and
catalog identification if the media is a catalog) is displayed to the caller.
For more information about this option and the output it produces, refer
to the NetBackup Media Manager System Administrator’s Guide.
EXAMPLES
The following command updates the EMM database of robot 1 connected to host shark:
vmphyinv -rn 1 -rh shark
The following command updates the EMM database of robot 7 connected to host whale.
Only the media belonging to the pool name "some_pool" will be inventoried:
vmphyinv -rn 7 -rh whale -pn some_pool
The following command updates the EMM database of robot 3 connected to host dolphin.
Only the media A00001, A00002, A00003 will be inventoried.
vmphyinv -rn 3 -rh dolphin -ml A00001:A00002:A00003
The following command updates the EMM database of robot 2 of type TLD connected to
host phantom. Only the media in slots 3 to 8 will be inventoried.
vmphyinv -rn 2 -rh phantom -slot_range 3 8 -d dlt
The following command updates the EMM database of standalone drive (drive index 3)
attached to host tigerfish:
vmphyinv -u 0 -h tigerfish
SEE ALSO
vmupdate, vmcheckxxx, vmoprcmd
466
vmpool
vmpool
NAME
vmpool - Manage volume pools
SYNOPSIS
install_path\Volmgr\bin\vmpool [-h EMM_server |
volume_database_host] -listall [-b] | -listscratch |
-list_catalog_backup_pool | -add pool_name "description"
host uid gid | -change pool_name "description" host uid gid |
-delete pool_name | -set_scratch pool_name |
-unset_scratch pool_name | -set_catalog_backup_pool
pool_name | -unset_catalog_backup_pool pool_name
DESCRIPTION
Use this command to add, change, delete, or list volume pools.
The -h option is not required, but you must choose one and only one of the other seven
options (for example, -listscratch).
OPTIONS
server is used by default. For communicating with pre-6.0 systems not in
the EMM domain, this is the EMM server.
-listall [-b]
List information about all volume pools. You can use the -b option to
specify a brief format for volume pool information.
-listscratch
List all configured scratch pools.
-list_catalog_backup_pool
Lists the volume pool to be used for catalog backup.
-add pool_name "description" host uid gid
Add a new volume pool.
467
vmpool
-change pool_name "description" host uid gid
Change an existing volume pool.
-delete pool_name
Delete a volume pool.
“description”
Description of the volume pool. The double quote marks are required if
host
Name of the host that will be permitted to request and use volumes in
this volume pool.
To permit only a specific host to access the volume pool, enter the name of
that host. To permit any host to access the volume pool, enter ANYHOST.
Using the value ANYHOST is recommended.
The following applies only to NetBackup Server:
You can only specify the value ANYHOST.
uid
Enter the default value, -1 (ANY), to permit any user id to access the
pool.
gid
Enter the default value, -2 (NONE), to permit only the user id specified
by uid to request or access the volume pool.
-set_scratch pool_name
If pool_name is a previously defined volume pool, pool_name will
become the scratch pool and its description will not be changed. The
NetBackup, DataStore, Catalog Backup, and None volume pools cannot
be changed to scratch pools.
If pool_name is a new volume pool, a new pool will be created with
"Scratch Pool" as the description.
Only one scratch pool at a time can be defined.
-set_catalog_backup_pool pool_name
Enables you to use this volume pool to back up the NetBackup catalog.
You can also create a dedicated catalog backup pool to be used for catalog
policies. A dedicated catalog volume pool reduces the number of tapes
needed during catalog restores since catalog backup media are not mixed
with other backup media.
-unset_catalog_backup_pool pool_name
Enables you to define a volume pool that you do not want to use to back
up the NetBackup catalog.
468
vmpool
-unset_scratch pool_name
Undefines pool_name as the scratch pool and defines it as a regular
volume pool. The pool can be deleted using vmpool -delete
pool_name.
NOTES
uid and gid should only be used for restricting access to volumes by user or by group on
UNIX hosts.
A pool cannot be both a scratch pool and Catalog Backup.
EXAMPLES
The following command adds a new pool named MyPool on the host named llama with
the default host, user id, and group id permissions:
vmpool -add MyPool "my description with spaces" ANYHOST -1 -2
The following command lists all pools configured on the host where the command is
executed:
vmpool -listall -b
469
vmquery
vmquery
NAME
vmquery - Query the Enterprise Media Manager database, or assign and unassign
volumes
SYNOPSIS
install_path\Volmgr\bin\vmquery [-h EMM_server, ... -h EMM_server |
volume_database_host, ... -h volume_database_host] [-vltcid
vault_container_id] [-W] [-b | -w] -a | -m media_id | -v
volume_group | -rn robot_number | -rt robot_type | -mt
media_type | -p pool_number | -pn pool_name | -res
robot_type robot_number robot_host rob_slot rob_side |
-assignbyid media_id media_type pool_number stat asg_time |
-deassignbyid media_id pool_number stat
DESCRIPTION
Query the EMM database for volume information. The -h, -b, and -w options are not
required, but you must choose only one of the other (eleven) options.
The -b or -w option can be used in conjunction with any of the other eleven options, but
the -b or -w options cannot be specified together.
OPTIONS
-h EMM_Server | volume_database_host
-b
Specifies the brief output format for volume information. This option
can be used in conjunction with any of the other eleven options.
-w
Specifies the wide output format for volume information. This option
includes additional information not shown by the -b option and can be
used in conjunction with any of the other eleven options.
470
vmquery
-a
Show all volumes.
-m media_id
Query volumes by media id. The media id is a maximum of 6 ASCII
characters.
-v volume_group
Query volumes by volume group. A volume group is a logical grouping
that identifies a set of volumes that reside at the same physical location.
-rn robot_number
Query volumes by robot number. A robot number is a unique, logical
identification number for the robot where the volume is located.
-rt robot_type
Query volumes by the type of the robot where the volume is located.
-mt media_type
Query volumes by media type.
hcart_clean.
-p pool_number
Query volumes by pool number. Pool number is an index into the
volume pool. You can use vmpool -listall to determine the index for
a given pool name.
-pn pool_name
Query volumes by pool name.
-res robot_type robot_number robot_host rob_slot rob_side
Query volumes by residence.
robot_host
471
vmquery
rob_slot
This is the slot number in the robot (robot coordinate 1) where the
volume resides.
rob_side
This is the platter side (robot coordinate 2) for optical disks (A or B). If the
volume is not an optical disk, specify zero for rob_side.
-assignbyid media_id media_type pool_number stat asg_time
Assign volume by media id, pool, and status.
stat
Status applies only to volumes that are assigned to NetBackup or
Storage Migrator.
A status of 0 means the volume is assigned to NetBackup regular backups.
A status of 1 means the volume is assigned to NetBackup catalog
backups.
A status of 2 means the volume is assigned to Storage Migrator.
A status of 3 means the volume is assigned to Storage Migrator for Microsoft Exchange or Storage Migrator for Windows 2000.
asg_time
Applies only to volumes assigned to NetBackup or Storage Migrator.
asg_time is the time when the volume was assigned and is the number of
seconds since 00:00:00 UTC, January 1, 1970. asg_time was originally
created using the time() call.
-deassignbyid media_id pool_number stat
Unassign volume by media ID, pool, and status. Starting with NetBackup
6.0, this option can only deassign non-NetBackup media.
Non-NetBackup media includes media used by VERITAS Storage
Migrator, VERITAS Data Lifecycle Manager, or by users working outside
of the NetBackup policy framework (for example, those using tpreq
directly). To deassign NetBackup tapes, use the bpexpdate command.
-vltcid vault_container_id
List the volumes that are stored in the container. vault_container_id
can be a string of up to 29 alphanumeric characters.
-W
Specifies parsable output format for volume information. The output data
lines are space separated fields except: the MediaID field is padded to 6
characters by adding spaces to the end of the string, the MediaType field
is padded to 8 characters by adding spaces to the end of the string, and
the MediaDescription field may contain spaces within the field. For Vault
472
vmquery
containers, the output includes the length of the container description
(DescriptionLength), the container description, and the container ID. The
output header line is a space separated line of column labels.
NOTES
EXAMPLES
The following command lists all volume information, in brief format from the Enterprise
Media Manager database on the host named llama:
vmquery -h llama -b -a
The following command assigns volume A23456, which is in pool 1 (NetBackup), and sets
the status to 0 and the assign time to 12/31/98 15:50:22:
vmquery -assignbyid A23456 8mm 1 0 915141022
The following command unassigns volume A23456, which is in pool 2 (Storage Migrator),
with a status of 0:
vmquery -deassignbyid A23456 0
SEE ALSO
vmadd, vmchange, vmdelete, vmpool
473
vmrule
vmrule
NAME
vmrule - Manage barcode rules
SYNOPSIS
install_path\Volmgr\bin\vmrule [-h EMM_server | volume_database_host]
-listall [-b] | -add barcode_tag media_type pool_name
max_mounts “description” | -change barcode_tag media_type
pool_name max_mounts “description“ | -delete barcode_tag
DESCRIPTION
Use this command to add, change, delete, or list barcode rules. The -h option is not
required, but you must chose one and only one of the other four options.
OPTIONS
server.
-listall [-b]
List information about all barcode rules. You can use the -b option to
specify a brief format for the barcode rule information that is displayed.
-add barcode_tag media_type pool_name max_mounts “description”
Add a new barcode rule.
-change barcode_tag media_type pool_name max_mounts “description”
Change a barcode rule.
-delete barcode_tag
Delete a barcode rule.
barcode_tag
Specifies the barcode prefix which will invoke the barcode rule.
474
vmrule
media_type
Specifies the media type of the volume, a barcode rule attribute. This
affects whether the rule will be used and also affects the media type for
volumes added using a robot inventory update.
hcart_clean.
pool_name
Specifies the pool to which the volumes will be added.
max_mounts
Maximum number of mounts allowed for this volume (when the volume
is added). This option is used only for non-cleaning media. When this
limit is exceeded, the volume can only be mounted for read operations.
Note: Numbers larger than 99999 are stored in the database, but vmrule
displays the max_mounts as 0 if the value is larger than 99999. A value of
0 means that the number of mounts is unlimited.
“description”
Description of the barcode rule. The double quote marks are required if
NOTES
EXAMPLES
The following command creates a rule that defines any tape with a barcode starting with
ABC is a DLT tape in the NetBackup pool. The tape can be mounted up to 100 times for
writes and is given a description.
vmrule -add ABC dlt NetBackup 100 "DLT cleaning tape"
SEE ALSO
vmupdate
475
vmupdate
vmupdate
NAME
vmupdate - Inventory the media contents of a robotic library and update the Enterprise
Media Manager database
SYNOPSIS
install_path\Volmgr\bin\vmupdate -rt robot_type -rn robot_number [-rh
robot_host] [-h EMM_Server | volume_database_host] [[-if
inventory_filter_value] [-if inventory_filter_value] ...] [-full]
[-recommend] [-interactive] [-involgrp volume_group]
[-outvolgrp volume_group] [-mt media_type] [-p pool_name]
[-use_barcode_rules] [-use_seed] [-mp media_id_prefix]
[-no_sides] [-no_format_optical] [-overwrite_labels]
[-empty_map]
DESCRIPTION
Inventory the media contents of a robotic library and update the Enterprise Media
Manager database. If no options are specified, the volume configuration is updated to
match the robot contents.
OPTIONS
-rt robot_type
Specifies the robot type of the robot to inventory.
-rn robot_number
Unique, logical identification number for the robot to inventory.
-rh robot_host
Name of the host which controls the robot. If no host is specified, the host
where you execute this command is assumed.
476
vmupdate
server. If no host is specified, but a pre-NetBackup 6.0 robotic control
host is specified on the -rh option, the robotic control host will be used as
the EMM server.
-if inventory_filter_value
Specifies inventory filter values. Multiple -if options may be specified.
The inventory filter value is an ACS scratch pool ID, or a TLH volume
category.
The -if and -full options cannot be specified together.
-full
Specifies full inventory. The -full and -if options cannot be specified
together.
-recommend
Lists changes required to update the volume configuration.
-interactive
Prompts you before updating the volume configuration.
-involgrp volume_group
Specifies the volume group for media moved into the robot.
-outvolgrp volume_group
Specifies the volume group for media moved out of the robot.
-mt media_type
Specifies the media type of the volume.
hcart_clean.
-p pool_name
Specifies the name of the volume pool to which new media will be
assigned.
477
vmupdate
-use_barcode_rules
Specifies that barcode rules will be used for assigning attributes to new
media.
-use_seed
Specifies automatic generation of media IDs for media with no barcodes.
-mp media_id_prefix
Specifies the prefix that is used as a seed to generate new media IDs for
media with no barcodes. This prefix should be between 1 and 5 characters
in length and contain only valid media ID characters (alpha-num, "+", "_",
".", and "-" if it is not the first character).
-no_sides
Specifies that any new optical media IDs will not always contain platter
side A or B.
-no_format_optical
Specifies to NOT format new optical media.
-overwrite_labels
Specifies that existing labels will be overwritten when formatting optical
media.
-empty_map
Specifies that volumes in the media access port (map) will be moved into
the robot before the robot inventory is started. This option is only valid
for TL8, TLD, or TLM robot types.
NOTES
EXAMPLES
The following command updates the volume configuration on the EMM server named
mymaster to match the contents of TLD robot 7 connected to the host macris:
vmupdate -rt tld -rn 7 -rh macris -h mymaster
SEE ALSO
vmcheckxxx
478
vopie_util
vopie_util
NAME
vopie_util - Manage local vopie authentication files
SYNOPSIS
install_path\NetBackup\bin\vopie_util [-log_dir path] [-severity
mask] [-debug] [-local_name name] [-always_write]
[-hashed | -unhashed] remote_name [sequence seed hash]
DESCRIPTION
The vopie_util program is available on Windows and UNIX NetBackup servers and
clients. It updates the hashed (public) and unhashed (secret) key files for the vopie
authentication method on the local system. Typically, vopie_util is used to synchronize
the vopie key files between two systems. This command will not longer be supported at
the next major release of NetBackup after the release of NetBackup 6.0.
OPTIONS
-log_dir path
Specifies the directory where the vopie_util log directory resides. The
default is:
install_path\NetBackup\logs (Windows)
/usr/openv/netbackup/logs (UNIX)
To enable logging, create a vopie_util directory in the path directory
before starting vopie_util. For example:
C:\VERITAS\NetBackup\logs\ vopie_util
-severity mask
Specifies the type of messages to be logged. mask is the sum of zero or
more of these values:
1 Unknown
2 Debug
4 Information
8 Warning
16 Error
32 Critical
The default is 48 decimal (0x30 hexadecimal or 060 octal), which specifies
critical and error.
479
vopie_util
-debug Specifies that additional information is logged to standard error.
-local_name name
Specifies the name of the local system. The default is the network host
name of the system. We recommend that this name match the NetBackup
client name for the system.
-always_write
Always update the file even if it already exists. The default is to not
overwrite existing files.
-hashed
Updates the hashed (public) key file. This file contains the challenges that
this system presents to other systems during authentication. If the
sequence, seed, and hash options described below are not specified, the
hashed-key file data matches any secret key.
-unhashed
Updates the unhashed (secret) key file. A secret key is randomly
generated and written to the unhashed key file. The unhashed file
contains the responses that the system returns when challenged by
another system.
The corresponding hashed-key file data is displayed after running the
command with this option.
remote_name
Specifies the name of the remote system with which this one is being
synchonized.
sequence seed hash
Can be used with the -hashed option and specifies data that is written in
the hashed (public) key file:
sequence is a decimal number between 10 and 499. seed is a 6 to 20 character string.
hash is a 16 digit hexadecimal number.
EXAMPLES
Example 1
In this example, the vopie key files are set up so the first connection between systems red
and blue is not fully authenticated. After the connection, the key files are updated so full
authentication is required. This is the easiest way to synchronize the key files but it leaves
a small window of insecurity.
480
vopie_util
1. On system red:
a. Create a secret key file on red by running the following command:
vopie_util -local_name red -unhashed blue
The public key (hashed) file information for red is displayed:
red 0167 jp0167 0aa47eae2d86231d
This information can be ignored in this example.
b. Create a public key file on red that will match any secret key on blue:
vopie_util -local_name red -hashed blue
2. On system blue:
a. Create a secret-key file on blue by running the following command:
vopie_util -local_name blue -unhashed red
The public key (hashed) file information for blue is displayed:
blue 0431 gw3251 0aa47eae2d86231d
This information can be ignored in this example.
b. Create a public key file on blue that will match any secret key on red by running
the following command:
vopie_util -local_name blue -hashed red Example 2
In this example, the vopie key files on systems green and yellow are synchronized. Full
authentication is required immediately. This is a more secure method than in example 1.
1. On system green, create a secret key file on green by running the following command:
vopie_util -local_name green -unhashed yellow
The public key (hashed) file information for green is displayed:
green 0209 fz9365 f852019bde05e92f
yellow uses this key when it issues challenges.
2. On system yellow:
481
vopie_util
a. Create a public key file on yellow that matches the secret key file on green by
running the following (all on one line):
vopie_util -local_name yellow -hashed green 0209 fz9365 f852019bde05e92f
b. Create a secret key file on yellow by running the following by command:
vopie_util -local_name yellow -unhashed green
The public key (hashed) file information for yellow is displayed:
yellow 0468 yq0860 82723984b43bf474
green uses this key when it issues challenges.
3. On system green, create a public key file on green that matches the secret key file on
yellow by running the following (all on one line):
vopie_util -local_name green -hashed yellow 0468 yq0860 82723984b43bf474
SEE ALSO
bpauthsync, vopied
482
vopied
vopied
NAME
vopied - Daemon to provide VERITAS One-time Password user authentication
SYNOPSIS
install_path\NetBackup\bin\vopied [-standalone] [-debug] [-portnum
number] [-max_time seconds] [-log_dir path] [-severity
mask]
DESCRIPTION
This program is available on Windows and UNIX NetBackup clients. It accepts
connections from remote NetBackup servers and clients that are attempting to verify the
identity of requests from the local NetBackup system. The authentication method is
VERITAS One-time Password (vopie). Normally, vopied is started by the NetBackup
Client service on Windows and inetd on UNIX.
When you install NetBackup on a Windows client or UNIX client, the installation process
adds entries for vopied to %System Root%\system32\drivers\etc\services on
Windows and /etc/services and /etc/inetd.conf on UNIX.
The services entry looks like this:
vopied
13783/tcp
vopied
The inetd.conf entry on UNIX looks like this:
vopied
stream
tcp
nowait
root
/usr/openv/bin/vopied vopied
OPTIONS
-standalone
Available only on UNIX clients and specifies that vopied will run
continuously rather than being started by inetd.
-debug
Available only on UNIX clients and implies -standalone (that is,
vopied runs continuously). This option prevents vopied from forking
and does not disconnect it from standard input, output, and error.
-portnum number
Available only on UNIX clients and implies -standalone (that is,
vopied runs continuously). Specifies the port number where vopied
listens for requests. The default is the vopied entry in:
/etc/services
483
vopied
-max_time seconds
Specifies a time out value for network connections. The default is 60
seconds.
-log_dir path
Specifies the directory where the vopied log directory resides. The
default is:
install_path\NetBackup\logs (Windows)
/usr/openv/netbackup/logs (UNIX)
To enable logging, create a vopied directory in the path directory before
starting vopied. For example:
install_path\NetBackup\logs\vopied
-severity mask
Specifies the type of messages to be logged. mask is the sum of zero or
more of these values:
1 Unknown
2 Debug
4 Information
8 Warning
16 Error
32 Critical
The default is 48 decimal (0x30 hexadecimal), which specifies critical and
error.
SEE ALSO
bpauthsync, vopie_util
484
vxlogcfg
vxlogcfg
NAME
vxlogcfg - Modifies unified logging configuration settings.
SYNOPSIS
install_path\NetBackup\bin\vxlogcfg -a -p ProductID -c ConfigPath
-n Names [-q]
install_path\NetBackup\bin\vxlogcfg -a -p ProductID [-o
OriginatorID ] -s keyname=value [-q]
install_path\NetBackup\bin\vxlogcfg -r -p ProductID [-o
OriginatorID ] [-s keyname ] [-q]
install_path\NetBackup\bin\vxlogcfg -l [-p ProductID ] [-o
OriginatorID ] [-q]
install_path\NetBackup\bin\vxlogcfg -v
install_path\NetBackup\bin\vxlogcfg -h
DESCRIPTION
Use the vxlogcfg command to change the logging settings for a product that uses
unified logging, such as NetBackup.
Unified logging uses a standardized naming format for log files, as follows:
productID-originatorID-hostID-date-rotation.log For more information about the unified logging naming format, and the logging
originator ID’s, refer to the NetBackup Troubleshooting Guide for UNIX, Windows, and Linux.
OPTIONS
Specify the product log configuration to modify. Use fully-qualified path names for all
directory paths. If a directory name contains spaces, use quotes around the path name for
that directory (for example, “Program Files”).
-a, --add
Modify the product’s unified logging settings, in conjunction with other
options on vxlogcfg. This is a required option.
Note Although this option can be used to add a product to the list of those using unified
logging, it should not be used for that purpose (all existing log settings will be
overwritten). Use this option only to modify existing unified logging settings. See
examples.
485
vxlogcfg
-r, --remove
Remove the specified product from the list of products using unified
logging and remove unified logging configuration settings for this
porduct.
Note Although the -r option is available, it should not be used. All existing log settings will
be removed and no further logging will take place.
-l, --list
Display the configuration settings that are defined. This is a required
option.
-c, --config ConfigPath
Provide the path from which the product log configuration settings
should be read. On Windows, it should be the absolute path to the product log registry
settings or log file, such as install_path\NetBackup\nblog.conf
for NetBackup.
On UNIX, it should be the absolute path to the product log configuration
file, such as /usr/openv/netbackup/nblog.conf for NetBackup.
This is a required option.
-n, --names Name
Specify one or more abbreviated or short names for the product. Multiple
names should be separated by a comma. This is a required option.
-s, --setting keyname=value
Set individual configuration settings. keyname is the configuration
setting's name and value is the value for that setting. You can supply
multiple keyname=value pairs separated by commas. See the KEYNAMES
AND VALUES section for particular keynames and values. This is a
required option.
-s, --setting keyname
While removing a configuration setting, provide only keyname with the -r
option. Multiple settings can be removed by providing multiple -s
options. See the KEYNAMES AND VALUES section for particular
keynames.
-p, --prodid ProductID
Create/modify log configuration settings for a productID. This is a
required option.
-o, --orgid OrgID
Create/modify log configuration settings for the specified originator ID.
This is a required option. The Originator ID can be supplied as a valid
originator ID (a number), it can be "Default," or it can be “ALL.” If the
486
vxlogcfg
Originator ID is "Default" then the configuration settings given by -s are
taken as the default settings. If the Originator ID is "ALL" then the
configuration settings given by -s will be considered for all the originators
of a given product ID.
-h, --help
List and describe the command-line options available for this command.
Optional.
-q, --quiet
Do not display error or informational messages; quiet mode. Optional.
-v, --version
Display the version information for this command. Optional.
KEYNAMES AND VALUES
Following are the keynames and values that can be specified on the -s option. For
NetBackup, the vxlogcfg command places these keynames and values in the
/usr/openv/netbackup/nblog.conf file on UNIX and in
install_path\NetBackup\nblog.conf on Windows. For PBX, these are placed in
/etc/vx/VxICS/icsul.conf on UNIX and in the registry entry
SOFTWARE\VERITAS\VxICS\logcfg on Windows.
Keynames and values for UNIX and Windows
LogDirectory
Provides an absolute path to a directory.
DebugLevel
Sets the verbosity level for the debug log messages. (Debug logs are
intended for VERITAS engineers.) Valid values are 0 through 6.
DiagnosticLevel
Sets the verbosity level for the diagnostic log messages. (Diagnostic logs
are intended for NetBackup adminsitrators and users.) Valid values are 0
through 6.
LogToStdout
Sends all log messages to standard output (by default the terminal) in
addition to sending them to the log file. Valid values are true, false.
LogToStderr
Sends application log messages to Stderr (by default the terminal) in
addition to sending them to the log file. Valid values are true, false.
LogToOslog
Sends application log messages to the operating system log (syslog on
UNIX and the Event Log on Windows). Valid values are true, false.
487
vxlogcfg
RolloverMode
Specifies when log files are rolled over. Rolling over a log file means
closing the current log file and opening a new one, to keep log file size
low and allow older log files to be deleted or archived. Valid values are
FileSize, LocalTime, Periodic, and None.
FileSize indicates rollover occurs when the log reaches the size set by MaxLogFileSizeKB.
LocalTime indcates the log file should be rolled over once per day at a time specified by RolloverAtLocalTime.
Periodic indcates the log file should be rolled over after the number of
seconds specified by RolloverPeriodInSeconds.
None indicates that log files will not be rolled over.
MaxLogFileSizeKB
Specifies the maximum size allowed for the log file (in kilobytes) before
rollover occurs, if the RolloverMode is set to FileSize. Valid values are 1
through 4294967295.
RolloverPeriodInSeconds
Specifies a period of time in seconds after which the log file is rolled over,
if the RolloverMode is set to Periodic. Valid values are 1 through
2147483648.
RolloverAtLocalTime
Specifies the time of day at which the log file is rolled over, if the
RolloverMode is set to LocalTime. Valid values are 00:00 through 23:59.
NumberOfLogFiles
Specifies the maximum number of files to retain in the log directory for
each unified logging originator. Valid values are 1 through 4294967295.
The vxlogmgr --auto command uses NumberOfLogFiles to
determine how many log files to delete or move, starting with the oldest
files. For example, if a log directory contains seven log files created by a
particular originator, and NumberOfLogFiles is set to 5, the vxlogmgr
--auto --del command will delete the two oldest files created by that
originator.
OIDNames
Specifies one or more alternate names for the unified logging originator
specified on the -o option. These names can be used in place of Originator
IDs when performing searches using the vxlogview command. Each
name can be up to 80 characters in length. Multiple names can be
specified, seperated by a space.
488
vxlogcfg
L10nLib
Specifies the absolute path and filename of the external localization
library. This option is for VERTAS internal use only. Use of this option
could disable unified logging.
L10nResource
Specifies the name of a localization resource associated with a unified
logging product or originator. This option is for VERTAS internal use
only. Use of this option could disable unified logging.
L10nResourceDir
This setting specifies the name of a localization resource directory
associated with a unified logging product or originator. This option is for
VERTAS internal use only. Use of this option could disable unified
logging.
Keynames and values for UNIX only
LogFilePermissions
An octal number specifying UNIX file permissions assigned to log files
created by the originator that was specified by the -o option. In most
cases, there should be no need to use this option.
SyslogIdent
Specifies a string that is attached to the beginning of every syslog
message when LogToOslog is set to true. Can be any string up to 80
characters long. In most cases, there should be no need to use this option.
SyslogOpt
Specifies the syslog option value passed to the syslog openlog function.
Log messages are directed to the UNIX syslog when LogToSyslog is
enabled. Valid values are 0 through 4294967295. In most cases, there
should be no need to use this option.
SyslogFacility
Specifies the syslog facility value associated with log messages directed to
the syslog. Log messages are directed to the UNIX syslog when
LogToSyslog is enabled. In most cases, there should be no need to use this
option.
Valid values are: LOG_KERN, LOG_USER, LOG_MAIL,
LOG_DAEMON, LOG_AUTH, LOG_LPR, LOG_NEWS, LOG_UUCP,
LOG_CRON, LOG_LOCAL0, LOG_LOCAL1, LOG_LOCAL2,
LOG_LOCAL3, LOG_LOCAL4, LOG_LOCAL5, LOG_LOCAL6,
LOG_LOCAL7. The default is LOG_USER.
489
vxlogcfg
Keynames and values for Windows only
NtEventLogCategory
Specifies the category number that will be associated with log messages
that are directed to the Windows Event Log, if LogToOslog is enabled. In
most cases, there should be no need to use this option.
LogFileSDDL
Specifies the Windows Security Descriptor Definition Language (SDDL)
string that sets the Access Control List (ACL) for log files created by the
originator that was specified by the -o option. In most cases, there should
be no need to use this option.
NtEventLogSourceName
Specifies the Windows Event log that log messages will be directed to if
the LogToOslog option is enabled on Windows. This option is for
VERTAS internal use only. Use of this option could disable unified
logging.
EXAMPLES
Example 1
The following sets the LogDirectory for NetBackup and originator ID 111 on UNIX:
vxlogcfg -a --prodid 51216
-orgid 111 -s LogDirectory=/usr/openv/logs
Example 2
The following sets the DebugLevel and DiagnosticLevel for all unified logging originators
in NetBackup:
vxlogcfg -a --prodid 51216
DiagnosticLevel=3
-orgid ALL -s DebugLevel=3 -s
Example 3
The following sets the default RolloverMode for product ID 1:
vxlogcfg -a --prodid 1 -orgid Default -s RolloverMode=FileSize
Example 4
The following displays all configuration settings for originator 2 for product ID 1.
vxlogcfg -l --prodid 1 --orgid 2 Example 5
The following lists all the originators configured for product ID 1.
vxlogcfg -l --prodid 1
Example 6
490
vxlogcfg
The following lists all configured products.
vxlogcfg -l
FILES
/usr/openv/netbackup/nblog.conf
/etc/vx/VxICS/icsul.conf
SEE ALSO
vxlogview, vxlogmgr
491
vxlogmgr
vxlogmgr
NAME
vxlogcmgr - Manages the log files generated by products that support Unified Logging.
SYNOPSIS
install_path\NetBackup\bin\vxlogmgr {-d | -c | -m | -s} [-a] [-f
AbsoluteDir] [-q]
install_path\NetBackup\bin\vxlogmgr {-d | -c | -m | -s} [-p
ProductID] [-o OriginatorID] [-n Days] [-t Time] [-b
Date] [-e Date] [-f AbsoluteDir] [-q] [-z]
install_path\NetBackup\bin\vxlogmgr {-d | -c | -m | -s} [-w
QueryString] [-f AbsoluteDir] [-q]
install_path\NetBackup\bin\vxlogmgr -h
install_path\NetBackup\bin\vxlogmgr -v
DESCRIPTION
The vxlogmgr utility manages the log files generated by unified logging-enabled
applications. Log file management includes actions such as deleting or moving log files
based on log management configuration settings.
OPTIONS
Specify the log management action to perform.
-a, --auto
Retrieve log files based on individual configuration settings for
NumberOfLogFiles. The action will be taken based on the given action
type (such as move, copy, or delete). When the -a option is specified, the
other options cannot be used.
-b, --stdate ‘Date’
Manage the log files created at the specified start date. The Date format is
set from the current locale at run-time and is locale-specific.
NOTE: In Windows, use double-quotes.
492
vxlogmgr
-c, --cp
Copy log files from the folder configured by the product to the specified
folder.
-d, --del
Delete log files from the folder configured by the product.
-e, --endate ‘Date’
Manage the log files created up to the specified date. The Date format is
set from the current locale at run-time and is locale-specific.
NOTE: In UNIX, use single quotes to enclose the date. In Windows, use double-quotes.
-f, --dir AbsoluteDir
Specify the absolute name of the directory into which the log files are to
be copied. This option is valid only with the -c option.
-h, --help
List and describe the command-line options available for this command.
-m, --mv
Move log files from the folder configured by the product to the specified
folder.
-n --days NumberOfDays
Manage the log files created in last NumberOfDays days for the specified
action
-o, --origid OriginatorID
Manage the log files identified by a given originator ID (OriginatorID).
Manage the log files identified by a given product ID (ProductID) for the
specified action. Instead of an identifier, the user can provide the product
name.
-q, --quiet
Do not display any messages; quiet mode.
-s, --vw
View the log files for a given query.
-t, --tail hh:mm:ss
Manage the log files for the last hh:mm:ss hours.
-v, --version
Display the version information for this command.
-w, --where QueryString
Retrieve a subset of logs based on a query string or condition
(QueryString).
493
vxlogmgr
-z, --displaytimezone
Display the timezone information along with the log file listing.
EXIT STATUS
The following exit values are returned:
0
Successful completion.
-1
An error occurred.
QUERY STRINGS
A query string is a text expression, similar to a database WHERE clause, that is used to
retrieve log entries from the unified logging system. The expression is a combination of
relational operators, constant integers, constant strings, and names of log fields that
evaluate to a single value. Logical operators, such as AND and OR, are used to group
expressions.
Supported relation operators include:
<
Less than
>
Greater than
<=
Less than and equal to
>=
Greater than and equal to
=
Equal to
!=
Not equal to
Supported logical operators include && (logical AND) and || (logical OR).
Predefined log fields include:
PRODID
Product identifier (integer or string)
ORGID
Originator identifier (integer or string)
STDATE
Locale-specific start date (long integer or string [such as ‘mm/dd/yy’])
ENDATE
Locale-specific end date (long integer or string [such as ‘mm/dd/yy’])
PREVTIME Previous time (string [hh:mm:ss])
EXAMPLES
Example 1
The following automatically moves the older log files created by NetBackup to the folder
/tmp/nblogs. The --auto option depends on the configuration setting
NumberOfLogFiles.
494
vxlogmgr
vxlogmgr -m --auto --dir /tmp/nblogs
Example 2
The following deletes log files that NetBackup created 15 days back:
vxlogmgr -d --prodid NB -n 15
Example 3
The following copies log files that are one hour old to the folder c:\temp\logfiles:
vxlogmgr -c --tail 1:00:00 --dir c:\temp\logfiles
Example 4
The following copies to folder c:\temp\logfiles the log files created from date
01/22/04 by NetBackup:
vxlogmgr -c --where "(prodid = NB) && (stdate >= '01/22/04')" --dir c:\temp\logfiles
Example 5
The following copies to folder c:\temp\logfiles the log files created between 10/10/03
and 10/28/03 inclusive by product ID 100:
vxlogmgr -c --where "(PRODID == 100) && ((STDATE >= '10/10/03') &&
(ENDATE <= '10/28/03'))" --dir c:\temp\logfiles
SEE ALSO
vxlogview, vxlogcfg
495
vxlogview
vxlogview
NAME
vxlogview - Displays logs generated by the unified logging component.
SYNOPSIS
install_path\NetBackup\bin\vxlogview [options] [-l LocaleName] [-d
DisplayOption[,DisplayOption...]]
install_path\NetBackup\bin\vxlogview [-w queryString] [-l
LocaleName] [-d DisplayOption[,DisplayOption...]]
install_path\NetBackup\bin\vxlogview [-a] [-l LocaleName] [-d
DisplayOption[,DisplayOption...]]
install_path\NetBackup\bin\vxlogview -v
install_path\NetBackup\bin\vxlogview -h
DESCRIPTION
Use the vxlogview utility to view the logs generated by unified logging. Search criteria
can be specified with command-line options to view specific logs.
OPTIONS
Specify the logs you want to view.
-A, --audit
Display audit messsages.
-a, --all
Display all log messages from log files generated by multiple VERITAS
products.
-b, --stdate
Display messages logged starting at the given start time. The date format
is set from the current locale at run-time and is locale-specific
NOTE: In UNIX, use single quotes to enclose the date/time argument. In
Windows, use double-quotes.
496
vxlogview
-C, --crit
Display application log messages having a severity of critical.
-D, --debug
Display debug log messages.
-d, --display DisplayOption
Display specified message fields. If multiple DisplayOptions are specified,
each must be separated by a comma. DisplayOption may be one or more of
the following:
D - Display date
T - Display timestamp
m - Display message type
p - Display process ID
t - Display thread ID
P - Display product ID
O - Display originator ID
c - Display context token
s - Display application log entry severity
u - Display application or diagnostic Unique Message ID
x - Display actual log message text
w - Display who logged the diagnostic or debug message
i - Display short name for a product
o - Display short name for an originator
all - Display all fields of the log record
If -d is not specified, the following fields are displayed by default.
- Date
- Time
- Who (for diagnostic and debug messages only)
- Severity (application messages only)
- UMI (application and diagnostic messages only)
- message text
-E, --err
Display application log messages having a severity of error.
-e, --endate
Display messages logged up to a given end time. If an end time is not
specified, it displays messages from the given start time to the end of the
log. If the date is not specified, it takes the current date as default. The
date format is set from the current locale at run-time and is locale-specific
497
vxlogview
NOTE: In UNIX, use single quotes to enclose the date/time argument. In
Windows, use double-quotes.
-F, --info
Display application log messages having a severity of info.
-G, --logdir dir
Display logs from a given directory instead of a configured log directory.
-h, --help
List and describe the command line options available for this command.
-I, --diag
Display diagnostic log messages.
-i
--fileid FileID
Display messages logged by a given file ID or shared originator ID.
-L, --app
Display application log messages.
-l, --locale LocaleName
Display messages in the locale given by localeName. The messages are
displayed in the current system locale if this option is not given. If the
messages cannot be displayed in the desired locale, the messages are
displayed in English.
-M, --emerg
Display application log messages having a severity of emergency.
-N, --level
Display debug/diagnostic log messages for a given level.
-n, --days NumberOfDays
Display the messages logged for last NumberOfDays days.
-o, --orgid OriginatorID
Display messages logged by the given originator identified by a given
originator ID. Instead of an identifier, the user can provide the
abbreviated name of the product.
-P, --pid ProcessID
Display messages logged by a given process ID.
Display messages logged by the product identified by a given product ID.
Instead of an identifier, the user can provide the abbreviated name of
product.
498
vxlogview
-R, --resdir dir
Use resources from a given directory instead of a configured localization
resource directory.
-r, --res Result
Display audit messages having the specified Result. Result should be
either 0 or 1.
-s, --subject Subject
Display audit messages having the specified Subject.
-T, --tid ThreadID
Display messages logged by a given thread ID.
-t, --tail hh:mm:ss
Display messages for last hh:mm:ss hours.
-v, --version
Display the version information for this command.
-W, --warning
Display application log messages having a severity of warning.
-w, --where QueryString
Specify a WHERE clause to use when querying the log messages such
that a subset of messages can be displayed. For more detail on
QueryString, refer to the “Using Logs and Reports” chapter of the
NetBackup Troubleshooting Guide.
-X, --ctx ContextToken
Display messages belonging to the given context instance. Context
instances are identified by context tokens. If the context token specified is
“all,” it displays all of the context names and associated tokens.
-z, --timezone
Display messages with time adjusted as per the given timezone.
EXIT STATUS
The following exit values are returned:
0
Successful completion.
-1
An error occurred.
EXAMPLES
Note The following examples are valid for UNIX, which uses single quotes to enclose
option arguments. In Windows, use double-quotes.
Example 1
499
This example displays the log messages for all the products installed:
vxlogview --all
Example 2
This example displays the log messages for NetBackup. It displays only the date, time,
message type, and message text:
vxlogview --prodid NB --display D,T,m,x
Example 3
This example displays the log messages for NetBackup that were logged between the
dates 1/18/04 and 1/21/04:
vxlogview --where "(prodid = 'NB') && (stdate >= '1/18/04 0:0:0 AM' && endate <= '1/21/04 10:12:00 AM'))"
Example 4
This example displays the log messages that were created on or after the date and time
1/03/03, 11:00:00 a.m.:
vxlogview --stdate '1/03/03 11:00:00 AM'
Example 5
This example displays the log messages that were logged within the last hour:
vxlogview --tail 1:00:00
Example 6
This example displays the audit log messages that have a result of 0:
vxlogview --audit -r 0
Example 7
This example displays the context log messages for the “job_context” instance:
vxlogview --ctx 'jobid=4'
SEE ALSO
vxlogcfg, vxlogmgr
500
Index
A
accessibility features xi
ACS library
Automated Cartridge System 1
acsd command 1
Add Media Server on Clients
add_media_server_on_clients 3
add_media_server_on_clients command 3
ASA database files 344
Automated Cartridge System 1
B
Backup Exec
listing files 165
backupdbtrace command 4
backuptrace command 6
Bare Metal Restore (BMR)
bmrc 11
bmrconfig 14
bmrepadm 19
bmrprep 22
bmrs 25
bmrsrtadm 29
beconv command 8
BMR client program 11
BMR database 346
bmrc command 11
bmrconfig command 14
bmrepadm command 19
bmrprep command 22
bmrs command 25
bmrsrtadm command 29
bparchive command 30
bpauthorize command 34
bpauthsync command 37
bpbackup command 40
bpbackupdb command 46
bpcatarc command 50
bpcatlist command 51
bpcatres command 54
bpcatrm command 55
bpcd command 56
bpchangeprimary command 58
bpclassnew command 250
bpclclients command 208
bpclient command 62
bpclinclude command 216
bpclinfo command 221
bpclntcmd 66
bpclntcmd commnad 66
bpclsched command 232
bpclschedrep command 243
bpcompatd command 68
bpconfig command 70
bpdbjobs command 80
bpdown 87, 256
bpduplicate command 89
bperror command 97
bpexpdate command 108
bpgetconfig commnad 117
bpgetdebuglog commnad 119, 288
bpimagelist command 120, 125
bpimmedia command 132
bpimport command 142
bpinst command
examples 154
man page 148
recreate a key file 153
bpkeyfile command
man page 156
bpkeyutil command
man page 158
bplabel command 160
bplist command 163
bpmedia command 169
bpmedialist command 172
bpminlicense command 183
501
bpnbat command 185
bpnbaz command 191
bppficorr command 206
bpplclients command 208
bppldelete command 215
bpplinclude command 216
bpplinfo command 221
bppllist command 230
bpplsched command 232
bpplschedrep command 243
bppolicynew command 250
bpps 256
bprecover command 260
bprestore command 266
bpschedule command 275
bpschedulerep command 282
bpsetconfig 288
bpstuadd command 290, 294
bpstudel command 302
bpstulist command 304
bpsturep command 310
bptestbpcd command 317
bpup 320
bpverify command 322
F
cat_convert utility 330
change_key_file_pass_phrase option 156
change_netbackup_pass_phrase option 156
configuring
encryption, using bpinst command 148
create_nbdb command 334
crypt_option 150
crypt_strength option 150
M
C
File authentication
bpauthsync 37
force_install option 149
G
generating DES encryption keys 156
I
Importing backups
bpimport 142
importtrace command 339
Inline Tape Copy option 93
installation
using bpinst command 148
K
key file 152
pass phrase 152
L
LEGACY_CRYPT option 150
Licenses
managing with bpminlicense command 183
ltid
acsd command 1
Managing barcode rules 350
Managing devices 350
Managing volume pools 350
Managing volumes 350
Media Contents Report 174
Media Count Report 175
Media List Report 172
Media Manager daemons
nbpushdata 372
Media Summary Report 174
D
DES
keys, generating from bpkeyfile 156
device allocator 350
disaster recovery 153
display option 156
drive
reset 459
E
EMM database 373, 375
Enterprise Media Manager 350
Enterprise Media Manager (EMM)
EMM database 372
502
N
nbdb_admin command 342
nbdb_backup command 344
nbdb_move command 345
nbdb_ping command 346
nbdb_restore command 347
nbdb_unload command 348
nbemmcmd command 351
nbjm command 350, 367
nbnos command 368
nbpem command 369, 371
nbpushdata
upgrades
Volume Database host 372
nbrb command 378
NetBackup Access Management 13, 18
NetBackup commands
beconv 8
NetBackup daemons
nbpushdata 372
NetBackup database 346
NetBackup Encryption 148
Legacy Encryption 148
Standard Encryption 148
NetBackup media
freeze 169
suspend 169
unfreeze 169
unsuspend 169
NetBackup Policy Execution Manager 369
NetBackup Policy Execution Manager Requisition 371
NetBackup Resource Broker 378
NetBackup troubleshooting commands
backupdbtrace 4
backuptrace 6
NetBackup Vault 93
P
pass phrase 152
restrictions 157
passphrase_prompt option 151
passphrase_stdin option 151
policy_encrypt option 151
policy_names option 149, 151
R
recovery (disaster) 153
reset drive 459
restoretrace command 372, 379
robtest 392, 395
S
set_ndmp_attr command 381
SSO environment 350
stdin option 156
Synchronize authentication files 37
Index
T
tl4d command 384
tl8cd command 385
tl8d command 385
tldcd command 388
tldd command 388
tlhcd command 392
tlhd command 392
tlhtest 392, 395
tlmd command 395
tpautoconf command 396
tpclean command 400
tpconfig command 403
tpreq command 416
tpunmount command 418
U
Unified logging 485
vxlogmgr 492
vxlogview 496
update_libraries option 150
V
verbose option 149, 151
vlteject 427
vltinject 431
vltoffsitemedia 433
vltopmenu 437
vltrun 438
vmadd command 442
vmchange command 445
vmcheckxxx command 453
vmdelete command 455
vmoprcmd command 457
vmphyinv command 463
vmpool command 467
vmquery command 470
vmrule command 474
vmupdate command 476
Volume Database host 372, 375, 377
vopie_util command 479
vopied command 483
vxlogcfg 485
vxlogcfg command 485
vxlogmgr command 492
vxlogview command 496
503

NetBackup Commands for Windows

Transcription

Similar documents

dcVAST — Symantec Appliance / NetBackup Media Server

Storage and Information Management Brief VERITAS and Network

(C) Engine - Automotriz En Video

PDF Assembly Instructions Now-Click Here - Port-A-Wall

2pm_1726_NetBackup 7.6 Best Practices Improving - VOX

BUMP Data sheet English (Page 1)

TOP TEN 10 CYBER TIPS FOR SMALL BIZ (2)

CheCk ServiCeS

Install Instructions for V olvo 8.1 Install Instructions for V olvo 8.1

HB 125 HYDRAULIC CHAIN TENSIONER INSTRUCTIONS