VERITAS NetBackup 6.0 Commands Manual

Download

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 V ERITAS Software Corporation or its affiliates in the U.S. and other countries. Other names may be trademarks of their respective owners.

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 NetBackup Commands for Windows

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

Accessibility Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Comment on the Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xii

Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xii

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv

Chapter 1. NetBackup Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

acsd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

Finding NetBackup Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

Accessing the VERITAS Technical Support Web Site . . . . . . . . . . . . . . . . . . . . . . . . . .x

Contacting VERITAS Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xii

NetBackup Command Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii

NetBackup Media Manager Command Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv

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 NetBackup Commands for Windows

bpkeyutil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158

bplabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .160

bplist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .163

bpmedia . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .169

bpmedialist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .172

bpminlicense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .183

bpnbat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .185

bpnbaz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 91

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 NetBackup Commands for Windows

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

vopied . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .483

vxlogcfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .485

vxlogmgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .492

vxlogview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .496

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .500

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501

Contents vii

viii NetBackup Commands for Windows

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 Win dows system. Each co mmand co ntains 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 entir e Ne tBackup do cumenta tion s et appea rs 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.

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 an y of the following:

◆ Obtain updated information about NetBac kup, 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 VERIT AS 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 s p ecific 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 NetBackup Commands for Windows

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 produ ct 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 conta c t 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 amercustomercare@veritas.com.

In the Asia and Pacific areas, send email to apaccustomercare@veritas.com. In all other areas, send email to internationallicense@veritas.com.

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. A ccessibility features include:

◆ Support for assistive technolog ie s 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

Let us know what you like and dislike about the documentation. Wer e 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 NBDocs@veritas.com. 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 NetBackup Commands for Windows

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 b e 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 Pr ompt” to see the re sults.

◆ 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 exa mple, th e 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 NetBackup Commands for Windows

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

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 NetBackup Commands for Windows

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.

add_media_server_on_clients

Chapter 1, NetBack up Commands 3

backupdbtrace

NAME

backupdbtrace – trace debug logs of backupdb (NetBackup image catalog backup) job[s]

SYNOPSIS

install_path\NetBackup\bin\admincmd\backupdbtrace [-server

DESCRIPTION

backupdbtrace consolidates the debug log mess ages 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 chan ges 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 o n th e master server and bpcd on all servers in addition to the processes already identified.

name] [-job_id number] [-start_time hh:mm:ss] [-end_time hh:mm:ss] [-install_path path] mmddyy [mmddyy ...]

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. You must have administrator privileges to execute this command.

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 NetBackup Commands for Windows

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

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

backupdbtrace

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

Chapter 1, NetBack up Commands 5

backuptrace

NAME

backuptrace – consolidate the debugs logs for a NetBackup job.

SYNOPSIS

install_path\NetBackup\bin\admincmd\backuptrace [-master_server

DESCRIPTION

The backuptrace utility can be used to consolidate the debug logs for a specif ied 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.

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

The backuptrace utility can be used for regular file system, database extension and alternate backup method backup jobs.

You must have administrator privileges to execute this command.

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 NetBackup Commands for Windows

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 for UNIX, mmddyy.log for Windows) that will be analyzed.

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 th e window for which the jobs are to be evaluated.

Chapter 1, NetBack up Commands 7

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 Medi a Manager records with the media being assigned to NetBackup. The media is kept in a frozen state so t hat NetBa ckup 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 NetBackup Commands for Windows

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

beconv

-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 th e -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:

Chapter 1, NetBack up Commands 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 NetBackup Commands for Windows

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 r epair envir onment on a re storing 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.

Chapter 1, NetBack up Commands 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 resto r e tas k:

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 NetBackup Commands for Windows

bmrc

Complete a restore task and set a final status code:

bmrc -operation complete -resource restoretask -client clientName

-status numericStatus

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

bmrc -operation create -resource log -client clientName

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

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

Example 7 Pull a file from the server:

bmrc -operation pull -resource info -client clientName -source sourceFileName -destination destinationFileName

Example 8 Pull an external procedure from the server:

bmrc -operation pull -resource procedure -client clientName

-source sourceFileName -destination destinationFileName

NOTES

If 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 th e com mand’s usage statement when it is the only option on the command line.

Chapter 1, NetBack up Commands 13

bmrconfig

NAME

bmrconfig - change con f iguration settings

SYNOPSIS

install_path\NetBackup\bin\bmrconfig -help [-resource

resourceType

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 s ystem, 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 NetBackup Commands for Windows

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. Volu me 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 Volu me Manager

bmrconfig

-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 t o the configurat ion 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

Chapter 1, NetBack up Commands 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 drive r 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; equivale nt to volume softpart – a SVM soft partition volume – a logical division of a disk or disk group

NetBackup Commands for Windows

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 physic al 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 a ixp3 1:

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

Chapter 1, NetBack up Commands 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 clien t aixp31:

bmrconfig -operation map -configuration mynew -client aixp31

-resource volumegroup -name rootvg

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 befor e 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 a synopsis of command usage when it is the only option on the command line.

SEE ALSO

bmrs

18 NetBackup Commands for Windows

bmrepadm

NAME

bmrepadm - manage external procedures

SYNOPSIS

bmrepadm

install_path\NetBackup\bin\bmrepadm [-data] -list [

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

pattern]

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.

Chapter 1, NetBack up Commands 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).

If NetBackup Access Management is used in your environment, you have to renew your user credentials and the machine credentials if the credentials expired befor e 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 a synopsis of command usage when it is the only option on the 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 NetBackup Commands for Windows

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

Chapter 1, NetBack up Commands 21

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; op tional if -client and

-config options are sp e cified.

-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 NetBackup Commands for Windows

-default defaultGateway

(UNIX and Linux clients only.) Default gateway address, in dotted decimal notation. Required only for a -discover operation; optional if -client 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.

bmrprep

-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 notation. Required only for a -discover operation; optional if -client and -config options are specified.

-newconfig configurationName

(UNIX and Linux clients only.) Name to be given to the discovered configuration.

-policy policyName

Name of the policy to be used.

-quickformat

(Microsoft Windows clients only.) Quick format Windows partitions.

-restore

Perform a normal restore. Cannot be used with -discover.

Chapter 1, NetBack up Commands 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

If NetBackup Access Management is used in your environment, you have to renew your user credentials and the machine credentials if the credentials expired befor e 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.

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.

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

SEE ALSO

bpnbat

24 NetBackup Commands for Windows

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.

Chapter 1, NetBack up Commands 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 preceden ce.

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 Ja nuary 1, 1970. If bo th -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 NetBackup Commands for Windows

bmrs

client config discovertask discovertasklog package restoretask restoretasklog srt

-status numericStatus

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

EXAMPLES

Example 1 List the configurations in the BMR database:

bmrs -operation list -resource config

Example 2 Copy the current configuration (read-only) and create a new configuration (mynew) that

you can edit for client aixp31:

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

-destination mynew

Example 3 Delete configuration mynew for client aixp31:

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

Example 4 Verify the integrity of shared resource tree aixsrt:

bmrs -operation verify -resource srt -name aixsrt

NOTES

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

Chapter 1, NetBack up Commands 27

bmrs

The format that you must use for date and time values in NetBackup commands varies 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 NetBackup Commands for Windows

bmrsrtadm

NAME

bmrsrtadm - create and manage shared resource trees and create bootable CD images

SYNOPSIS

DESCRIPTION

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.

bmrsrtadm

<install_path>\NetBackup\bin\bmrsrtadm

bmrsrtadm command launches the Create Shared Resource Tree wizard. Use the

Chapter 1, NetBack up Commands 29

bparchive

NAME

bparchive - This command archives files to the NetBackup server.

SYNOPSIS

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 fore ground and returns completion status after a specified time period.

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

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 s pecify 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 comm and:

◆ 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 policy

Names the policy to use for the user archive. If it is not specified, the NetBackup server uses the first policy it finds that includes the client and a user archive schedule.

30 NetBackup Commands for Windows

-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 numb ers correspondi ng 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

bparchive

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.

Chapter 1, NetBack up Commands 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 ma y 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

Prints a command line usage message when -help is the only option on 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 f iles 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 NetBackup Commands for Windows

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

bparchive

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

Chapter 1, NetBack up Commands 33

bpauthorize

NAME

bpauthorize - Manage the authorize.txt file on remote servers.

SYNOPSIS

install_path\NetBackup\bin\admincmd\bpauthorize [-M nb_server]

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 long er be supported a t the next major release of NetBackup after the release of NetBackup 6.0.

[-g user_if_host] [-debug] [-verbose] [-get_privileges] file

[-debug] [-verbose] -get_authorize file

[-debug] [-verbose] -set_authorize file

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 NetBackup Commands for Windows

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 administr ator according t o t h e

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

Chapter 1, NetBack up Commands 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 NetBackup Commands for Windows

bpauthsync

NAME

bpauthsync - Synchronize authentication files on NetBackup servers and clients.

SYNOPSIS

install_path\NetBackup\bin\admincmd\bpauthsync [-verbose]

DESCRIPTION

bpauthsync

[-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] ]

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.

Chapter 1, NetBack up Commands 37

bpauthsync

-methods_deny path_name

Specifies the local copy of the methods_deny.txt file to push to the servers and clients. If this option is not included, NetBackup uses 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 servers and clients. If this option is not included, NetBackup uses 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 NetBa c kup 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 tha t 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 client s and all servers ar e 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 NetBackup Commands for Windows

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

bpauthsync

Chapter 1, NetBack up Commands 39

bpbackup

NAME

bpbackup - Back up files to the NetBackup server.

SYNOPSIS

DESCRIPTION

bpbackup starts either of the following processes:

On clients

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

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 comm and:

◆ You must be the owner of the file or an administrator to back up a file with

bpbackup.

40 NetBackup Commands for Windows

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 submitted. The command works in the background and does not return completion status directly to you. The -w option lets you change this behavior so the command works in the fore ground and returns completion status after a specified time period.

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 policy

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 imm ediate-manual backup (-i option).

-i

Starts an i m mediate-ma nual backup. This is the equivalent of starting a manual backup from the NetBackup administrator interface. Y ou 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 hostname

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 schedule

Names the schedule to use for the backup. If it is not specified, the NetBackup server uses the first user backup schedule it finds for the client in the policy it is using (see the -p option).

Chapter 1, NetBack up Commands 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

Specifies one of the following numb ers correspondi ng 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 a file in which to write progress information. NetBackup creates the file if it doesn’t exist.

For example: c:\proglog The default is to not use a progress log. 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 ma y create logs of various languages.

42 NetBackup Commands for Windows

-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 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 com pletion 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 manua l 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 tha n 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 sel ect ed, yo u can include the -h option to restrict the operat ion to one client and obtai n 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.

bpbackup

-help

Prints a command line usage message when -help is the only option on 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 ( ‘...’).

The default keyword phrase is the null (empty) string.

Chapter 1, NetBack up Commands 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:

filepathlen filepath

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 NetBackup Commands for Windows

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) ass ocia tes 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_p olicy.

bpbackup -k "Policy Win 01/01/01" -i -h slater -p win_nt_policy -t 13

FILES

install_path\NetBackup\logs\bpbackup\*.log

Chapter 1, NetBack up Commands 45

bpbackupdb

NAME

bpbackupdb - Back up Net Backup image catalogs.

SYNOPSIS

install_path\NetBackup\bin\admincmd\bpbackupdb [{-dpath

install_path\NetBackup\bin\admincmd\bpbackupdb [-p policy_name

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.

disk_path}] | {-tpath tape_device_path [-m media_ID]} | {-opath optical_device_path [-m media_ID]}] [-nodbpaths] [-v] [path...]

-s sched_label]

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 inclu des t wo destinations (media IDs or disk

pathnames) for NetBackup catalog backups. bpbackupdb uses the less-recently used of the two destinations as its defa ult value for the backup destination.

The NetBackup System Administrator’s Guide explains how to configure and display these values.

You must have administrator privileges to execute this command. Only one copy of bpbackupdb can run at a time. The bpbackupdb command fails if it

determines that a NetBackup catalog ba ckup 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 pai r 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 NetBackup Commands for Windows

bpbackupdb

The NetBackup System Adm i nistrator’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 destinatio n f or 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

Prints a command line usage message when -help is the only option on the command line.

Chapter 1, NetBack up Commands 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 additio nal 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, n ot a co mma. Th e comp lete 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 (thi s c onfiguration 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 tha t 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 NetBackup Commands for Windows

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

Chapter 1, NetBack up Commands 49

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 NetBackup Commands for Windows

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 |

-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 archivi ng 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 catal og, 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

-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

Chapter 1, NetBack up Commands 51

nnn | -since-weeks nnn |

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

Display the help text.

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 NetBackup Commands for Windows

(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

bpcatlist

SEE ALSO

bpcatarc, bpcatres, bpcatrm

Chapter 1, NetBack up Commands 53

bpcatres

NAME

bpcatres - Restore NetBackup catalog.

SYNOPSIS

DESCRIPTION

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

OPTIONS

install_path\NetBackup\bin\admincmd\bpcatres [-version] [-help]

-version

Display the bpcatres version and exit.

-help

Display the help text.

SEE ALSO

bpcatarc, bpcatlist, bpcatrm

54 NetBackup Commands for Windows

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 ima ge fi le.

OPTIONS

-version

Display the bpcatrm version and exit.

-help

Display the help text.

SEE ALSO

bpcatarc, bpcatlist, bpcatres

Chapter 1, NetBack up Commands 55

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 activa ted by the NetB ackup Client Service bpinetd(1M) on Wi ndows 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. Th is 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 NetBackup Commands for Windows

-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 Administ rator's Guide for additional information.

SEE ALSO

bpclient, bpkeyfile

bpcd

Chapter 1, NetBack up Commands 57

bpchangeprimary

NAME

bpchangeprimary - Promote a copy of a backup to be the primary copy.

SYNOPSIS

install_path\NetBackup\bin\admincmd\bpchangeprimary -copy

DESCRIPTION

The bpchangeprimary command lets you change which copy is th e primary copy for a set of backup images. Y ou can choose the copy to be promoted to primary by specifying a copy number, volume pool, or volume group. You can apply several option al criteria to identify the backup images to be affected.

number | -pool volume_pool | -group volume_group [-id backup_id] [-M master_server]

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]

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 NetBackup Commands for Windows

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 belon ging to volume_group should be promoted to primary.

Combinations of one or more of the followin g criteria can be applied to specify which copies will be made primary. None of the following options are required.

-cl client_name

Specifie s tha t ba ckup s 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 opti on 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 prim ary 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). Y ou 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 identify ing backup images for which the primary copy will be changed.

Chapter 1, NetBack up Commands 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

Specifie s 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 NetBackup Commands for Windows

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

The format that you must use for date and time values in NetBackup commands varies 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 ba ckups 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

Chapter 1, NetBack up Commands 61

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]

install_path\NetBackup\bin\admincmd\bpclient -client client_name

[-M master_server] {-add | -update} {[-dynamic_address 0|1] [-free_browse 0|1|2] [-list_restore 0|1|2|3] [-max_jobs [1-99] [-current_host host_name] [-current_ip_addr ip_address] [-current_host host_name [:ip_address]|:ip_address [-WOFB_enabled 0|1] [-WOFB_FIM 0|1] [-WOFB_usage 0|1] [-WOFB_error 0|1] [-connect_options 0|1|2 0|1|2 0|1|2|3]}}

install_path\NetBackup\bin\admincmd\bpclient -client client_name

[-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 NetBackup Commands for Windows

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

Chapter 1, NetBack up Commands 63

bpclient

1 = The client is assumed to have a dynamic host nam e (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 s etup for 1 (deny).

-H

List host specific client information.

-l

Lists limited client information .

-L

List all client information in a VE RBOSE 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 , sel e ct 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 NetBackup Commands for Windows

-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 indi vid ual drive. When this property is enabled, snapshot creation and file backup is done sequentially on a p er 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 Sn apshot and Cont inue. 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.

bpclient

NOTES

Chapter 1, NetBack up Commands 65

bpclntcmd

NAME

bpclntcmd - Tests the functionality of a NetBackup system.

SYNOPSIS

DESCRIPTION

The bpclntcmd command tests functionality and displays information about a NetBackup system.

You must have administrative privileges to execute this command.

OPTIONS

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]

-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 o n th e loca l system.

-get_pbx_port hostname

Displays the number that hostname cons iders the PBX port number. If hostname is not specified, the option displays the number that the local

host considers the PB X 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 NetBackup Commands for Windows

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

-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

bpclntcmd

Chapter 1, NetBack up Commands 67

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 use d in te rna lly by new NetB ack up s erv ic es t o co mmun ic ate wit h le gac y 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 NetBackup Commands for Windows

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.

Chapter 1, NetBack up Commands 69

bpconfig

NAME

bpconfig - Modify or display the global configuratio n a ttributes for NetBackup.

SYNOPSIS

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.

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

◆ The first form of bpconfig m odifies 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 m ore detail on th e displays.

Errors are se nt 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 NetBackup authorization, refer to "Enhanced Authorization and Authentication" in the NetBackup System Administrator's Guide.

70 NetBackup Commands for Windows

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 a nd in th e 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 r emo te medi a serv er 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).

bpconfig

-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

Chapter 1, NetBack up Commands 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 FORM ATS for more detail.

-M master_server,...

A list of master servers. This is a comma-separated list of hostna me s. If this option is present, the command is run on each of the master servers in this list. The master servers must all ow a cce ss 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 NetBackup Commands for Windows

-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 cli e nt/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 be tween 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 de fault 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.

bpconfig

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

Chapter 1, NetBack up Commands 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 fo r the number of tries is legal but stops all sch e d uled 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 fo r mor e 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 a re scheduled to begin. A long wakeup interval can cause the schedu ler 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 th e -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 NetBackup Commands for Windows

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 lay out 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

Chapter 1, NetBack up Commands 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 timeou t (s eco nds; 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: 1 minutes Max Simultaneous Jobs/Client: 1 Backup Tries: 2 time(s) in 12 hour(s) Keep Error/Debug Logs: 28 days Max drives this master: 0 Keep TrueImageRecovery Info: 1 days Compress Image DB Files: (not enabled) Media Mount Timeout: 0 minutes (unlimited) Display Reports: 24 hours ago Preprocess Interval: 0 hours Maximum Backup Copies: 10

The second display format, -L, looks like this:

bpconfig -L Mail Admin: *NULL* Job Retry Delay: 1 minutes Max Jobs/Client: 1 Backup Tries: 2 in 12 hours Keep Logs: 28 days Max drives/master: 0 Compress DB Files: (not enabled) Media Mnt Timeout: 0 minutes (unlimited) Postprocess Image: immediately Display Reports: 24 hours ago

76 NetBackup Commands for Windows

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 unl imited

bpconfig

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 successfu lly. Any exit status other than 0 means that an error occurred. 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

Chapter 1, NetBack up Commands 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: ichabod@null.null.com Job Retry Delay: 10 minutes Max Simultaneous Jobs/Client: 1 Backup Tries: 1 time(s) in 8 hour(s) Keep Error/Debug Logs: 6 days Max drives this master: 0 Keep TrueImageRecovery Info: 1 days Compress Image DB Files: (not enabled) Media Mount Timeout: 30 minutes Display Reports: 24 hours ago Preprocess Interval: 0 hours Maximum Backup Copies: 10

Example 2 Set the Compress- i mage-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: 10 minutes Max Simultaneous Jobs/Client: 1 Backup Tries: 2 time(s) in 12 hour(s) Keep Error/Debug Logs: 28 days Max drives this master: 0 Keep TrueImageRecovery Info: 2 days Compress Image DB Files: older than 7 day(s) Media Mount Timeout: 0 minutes (unlimited) Display Reports: 24 hours ago Preprocess Interval: 0 hours Maximum Backup Copies: 10

Example 3 Set the Media Mount Timeout to 1800 seconds.

bpconfig -to 1800 bpconfig -U

Admin Mail Address: sasquatch@wapati.edu Job Retry Delay: 10 minutes Max Simultaneous Jobs/Client: 1 Backup Tries: 1 time(s) in 12 hour(s)

78 NetBackup Commands for Windows

bpconfig

Keep Error/Debug Logs: 3 days Max drives this master: 0 Keep TrueImageRecovery Info: 24 days Compress Image DB Files: (not enabled) Media Mount Timeout: 30 minutes Display Reports: 24 hours ago Preprocess Interval: 0 hours Maximum Backup Copies: 10

FILES

install_path\NetBackup\logs\admin\*

install_path\NetBackup\db\config\behavior

SEE ALSO

bpimage

See the NetBackup Med i a Manager System Admi nistrator ’s Guide for information on Multi Hosted Drives.

Chapter 1, NetBack up Commands 79

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.

80 NetBackup Commands for Windows

OPTIONS

-all_columns

bpdbjobs

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

Chapter 1, NetBack up Commands 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.

NetBackup Commands for Windows

-gdm

Displays less information than -most_columns.

-help

Prints a command line usage message when -help is the only option on 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 ma ny 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 ma ny hours bpdbjobs keeps successful done jobs. Default is 72 hours.

This value must be less than the -keep_hours value .

bpdbjobs

-L

Report in long format.

-lvault

Displays additional column s specific to Vault jobs.

-M master_servers

Applies to an environment where there are m ultiple 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 ma ste r 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 va lues are consistent between admin clients.

Chapter 1, NetBack up Commands 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.

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

84 NetBackup Commands for Windows

-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 eli gible checkpointed backup s or restore jobs ind icated 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

bpdbjobs

-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 column s 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\*

Chapter 1, NetBack up Commands 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 tha t 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 q ueued.) 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 ge t 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-tim e 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 NetBackup Commands for Windows

VERITAS NetBackup 6.0 Commands Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Preface

Getting Help

Finding NetBackup Documentation

Accessing the VERITAS Technical Support Web Site

Contacting VERITAS Licensing

Accessibility Features

Comment on the Documentation

Conventions

Command Usage

Navigating Multiple Menu Levels

NetBackup Command Conventions

Introduction

NetBackup Media Manager Command Notes

NetBackup Commands

acsd

add_media_server_on_clients

backupdbtrace

backuptrace

beconv

bmrc

bmrconfig

bmrepadm

bmrprep

bmrs

bmrsrtadm

bparchive

bpauthorize

bpauthsync

bpbackup

bpbackupdb

bpcatarc

bpcatlist

bpcatres

bpcatrm

bpcd

bpchangeprimary

bpclient

bpclntcmd

bpcompatd

bpconfig

bpdbjobs