Tivoli Storage Manager for Windows Using the … Storage Manager for Windows Using the...

Tivoli Storage Manager for Windows Usingthe Backup-Archive ClientVersion 4 Release 2

NoteBefore using this information and the product it supports, read the generalinformation under “Notices” on page xix.

Third Edition (September 2001)

This edition applies to version 4, release 2, modification 1 of Tivoli Storage Manager(5698-TSM), Tivoli Storage Manager, S/390 Edition (5697-TS9) and to all subsequentreleases and modifications until otherwise indicated in new editions.

Order publications through your Tivoli representative or the Tivoli branch office that servesyour locality.

Tivoli welcomes your comments. You can send us comments about this book electronicallyat:[email protected]

Information sent grants Tivoli a nonexclusive right to use or distribute it in any way Tivolibelieves appropriate, without incurring any obligation to you.

© Copyright International Business Machines Corporation 1993, 2001. All rightsreserved.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSAADP Schedule Contract with IBM Corp.

Contents

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii

Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix

Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiii

About This Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvConventions Used in This Book. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxvi

Reading Syntax Diagrams. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxvii

Related Publications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxxi

Summary of Changes for Tivoli Storage Manager xxxiiiTechnical Changes for Version 4.2.1 - September 2001. . . . . . . . . . . . . .xxxiii

Technical Changes for Version 4.2 - June 2001. . . . . . . . . . . . . . . . . . . .xxxiv

Chapter 1. Introducing the Backup-Archive Client . . . . . . . 1Migrating from Earlier Versions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Terminology Changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Changes to Client-Server Communications. . . . . . . . . . . . . . . . . . . . . . . 2

Upgrade Path for Clients and Servers. . . . . . . . . . . . . . . . . . . . . . . . . . 3

Migrating to the Unicode-Enabled Client. . . . . . . . . . . . . . . . . . . . . . . . 3

Tivoli Data Protection for NDMP Version 4.2.1 Requirements. . . . . . . . 8

Additional Migration Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Using Storage Management Policies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Setting Processing Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Backing Up and Restoring Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Archiving and Retrieving Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Using the Web Backup-Archive Client. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

iiiTivoli Storage Manager for Windows Using the Backup-Archive Client

Automating Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Chapter 2. Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Starting Tivoli Storage Manager the First Time. . . . . . . . . . . . . . . . . . . . . . 15

Using Closed Registration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Using Open Registration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Considerations for NT and 2000 Client Services. . . . . . . . . . . . . . . . . . . . . 17

Permissions Required to Restore Files that Use Adaptive Subfile Backup . . . 18

Tivoli Storage Manager Client Authentication. . . . . . . . . . . . . . . . . . . . . . . 19

Starting a GUI Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Password and User ID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Configuration Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Starting a Command Line Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Using Batch Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Using Interactive Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Displaying Euro Characters in Command Line Prompt. . . . . . . . . . . . . 22

Using Options on the DSMC Command. . . . . . . . . . . . . . . . . . . . . . . 22

Starting: Advanced Considerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Starting a Web Client Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Setting User Privileges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Installing and Using the Web Client. . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Starting the Client Scheduler Automatically. . . . . . . . . . . . . . . . . . . . . . . . . 29

Changing Your Password. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Sorting File Lists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Displaying Online Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Ending a Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Online Forum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Other Sources of Online Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

iv Version 4 Release 2

Contacting Customer Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Chapter 3. Backing Up and Restoring . . . . . . . . . . . . . . . . . . . 35Planning Your Backups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Do You Want to Back Up or Archive Files?. . . . . . . . . . . . . . . . . . . . . . . . . 37

Backing Up Files and Directories. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Full Incremental Backup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Journal-Based Backup (Windows NT, 2000 only). . . . . . . . . . . . . . . . . 40

Partial Incremental Backup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Full Incremental versus Partial Incremental Backup . . . . . . . . . . . . . . . 42

Pre-Backup Considerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Estimating Backup Processing Time. . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Performing a GUI Backup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Performing a Command Line Backup. . . . . . . . . . . . . . . . . . . . . . . . . 49

Displaying Backup Processing Status. . . . . . . . . . . . . . . . . . . . . . . . . . 51

LAN-Free Data Movement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Backing Up NAS File Systems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Backup: Additional Considerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Backing Up Open Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Backing Up Removable Media Using Labels. . . . . . . . . . . . . . . . . . . . 56

Backing Up Fixed Drives. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Backing Up NTFS File Spaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Using Universal Naming Convention Names. . . . . . . . . . . . . . . . . . . . 57

Backing Up Microsoft Dfs Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Restoring Files and Directories. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Duplicate File Names. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Restoring Files Using Universal Naming Convention Names. . . . . . . . 62

Do You Want To Restore an Active or Inactive Backup?. . . . . . . . . . . 62

Performing a GUI Restore. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

vTivoli Storage Manager for Windows Using the Backup-Archive Client

Performing a Command Line Restore. . . . . . . . . . . . . . . . . . . . . . . . . 64

Restore: Additional Considerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Authorizing Another User to Restore or Retrieve Your Files. . . . . . . . . 75

Restoring or Retrieving Another User’s Files. . . . . . . . . . . . . . . . . . . . 76

Restoring or Retrieving Your Files to Another Workstation. . . . . . . . . . 76

Restoring or Retrieving Files to Another Type of Workstation. . . . . . . 77

Restoring a Disk in the Event of Disk Loss. . . . . . . . . . . . . . . . . . . . . 78

Deleting File Spaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Chapter 4. Archiving and Retrieving Files . . . . . . . . . . . . . . 81Archiving Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Performing a GUI Archive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Performing a Command Line Archive. . . . . . . . . . . . . . . . . . . . . . . . . 83

Deleting Archive Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Retrieving Archives. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Retrieving Archives Using the GUI. . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Retrieving Archives Using Commands. . . . . . . . . . . . . . . . . . . . . . . . . 86

Chapter 5. Automating Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Specifying Scheduling Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Mobile Dial-Up Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Return Codes from Executables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Starting the Client Scheduler. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Managing the Client Scheduler Using the Client Acceptor Service . . . . . . . . 91

Configuring the CAD to Manage the Scheduler. . . . . . . . . . . . . . . . . . 91

Displaying Information about Scheduled Work. . . . . . . . . . . . . . . . . . . . . . . 91

Displaying Information about Completed Work. . . . . . . . . . . . . . . . . . . . . . 93

Enabling-Disabling Scheduled Commands. . . . . . . . . . . . . . . . . . . . . . . . . . 94

Accessing Windows NT Network Drives. . . . . . . . . . . . . . . . . . . . . . . . . . . 94

vi Version 4 Release 2

Chapter 6. Understanding Storage ManagementPolicies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

Using Policy Domains and Policy Sets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Using Management Classes and Copy Groups. . . . . . . . . . . . . . . . . . . . . . . 98

Displaying Information about Management Classes and Copy Groups. . . . 100

Copy Group Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Copy Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Copy Frequency. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Versions Data Exists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Versions Data Deleted. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Retain Extra Versions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Retain Only Version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

Copy Serialization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

Copy Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Copy Destination. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Retain Versions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Selecting a Management Class for Files. . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Assigning a Management Class to Files. . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Overriding the Management Class for Archived Files. . . . . . . . . . . . . . . . . 107

Selecting a Management Class for Directories. . . . . . . . . . . . . . . . . . . . . . 108

Binding and Rebinding Management Classes to Files. . . . . . . . . . . . . . . . . 108

Rebinding Backup Versions of Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Using a Retention Grace Period. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Chapter 7. Creating an Include-Exclude List . . . . . . . . . . . 111Considerations for Windows NT, 2000 Unicode-Enabled Clients. . . . . . . . . 112

Using Include-Exclude Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Excluding Directories. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Controlling Backup, Archive, Image, and System Object Processing 114

viiTivoli Storage Manager for Windows Using the Backup-Archive Client

Controlling Compression, Encryption, and Subfile Processing. . . . . . . 116

Excluding System Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Excluding Files with UNC Names. . . . . . . . . . . . . . . . . . . . . . . . . . . 118

Including and Excluding Groups of Files. . . . . . . . . . . . . . . . . . . . . . 118

Examples Using Wildcards with Include and Exclude Patterns. . . . . . 120

Processing Include and Exclude Options. . . . . . . . . . . . . . . . . . . . . . . . . . 121

Processing Rules when Using UNC Names. . . . . . . . . . . . . . . . . . . . . . . . 124

Explicit Use of UNC names for Remote Drives. . . . . . . . . . . . . . . . . 124

Conversion of DOS Pathnames for Fixed and Remote Drives. . . . . . . 125

File Space Name Matching. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

Character Class Matching. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

Chapter 8. Setting Common Options . . . . . . . . . . . . . . . . . . 127Creating and Modifying a Client Options File. . . . . . . . . . . . . . . . . . . . . . 127

Communication Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

TCP/IP Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Named Pipes Option. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Node Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Backup and Archive Processing Options. . . . . . . . . . . . . . . . . . . . . . . . . . 132

Restore and Retrieve Processing Options. . . . . . . . . . . . . . . . . . . . . . . . . . 136

Scheduling Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Format and Language Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Command Processing Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Authorization Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

Error Processing Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Transaction Processing Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Web Client Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Setting Options in the Client Options File. . . . . . . . . . . . . . . . . . . . . . . . . 143

viii Version 4 Release 2

Using Options with Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Entering Options with a Command. . . . . . . . . . . . . . . . . . . . . . . . . . 145

Client Options Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Activatekey. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Autofsrename. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Backupregistry. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

Changingretries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

Clusternode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

Commmethod. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Commrestartduration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

Commrestartinterval. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

Compressalways. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

Compression. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

Dateformat. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Dfsbackupmntpnt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Dirmc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Domain. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Domain.nas. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

Enablelanfree. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

Encryptkey. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

Errorlogname. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

Errorlogretention. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

Exclude Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

Guitreeviewafterbackup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Httpport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

Httpsport. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

ixTivoli Storage Manager for Windows Using the Backup-Archive Client

Inclexcl. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

Include Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Incrthreshold. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

Lanfreecommmethod. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

Lanfreetcpport. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

Language. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

Largecommbuffers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

Localbackupset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

Managedservices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

Maxcmdretries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

Memoryefficientbackup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

Namedpipename. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

Nasnodename. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

Nodename. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

Numberformat. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

Optfile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

Password. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

Passwordaccess. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

Postschedulecmd/Postnschedulecmd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

Preschedulecmd/Prenschedulecmd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

Queryschedperiod. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

Quiet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

Replace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

Resourceutilization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

Retryperiod. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

Revokeremoteaccess. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

Runasservice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

x Version 4 Release 2

Schedcmddisabled. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

Schedlogname. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

Schedlogretention. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

Schedmode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

Scrolllines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

Scrollprompt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

Skipntpermissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

Skipntsecuritycrc. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

Subdir. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

Subfilebackup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

Subfilecachepath. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

Subfilecachesize. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

Tapeprompt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

Tcpbuffsize. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

Tcpclientaddress. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

Tcpclientport. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

Tcpnodelay. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

Tcpport. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

Tcpserveraddress. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

Tcpwindowsize. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

Timeformat. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

Txnbytelimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

Usedirectory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

Verbose. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

Virtualnodename. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

Webports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

xiTivoli Storage Manager for Windows Using the Backup-Archive Client

Chapter 9. Using Options with Commands . . . . . . . . . . . . 269Entering Options with a Command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

Command Line Options Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

Archmc. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

Deletefiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

Dirsonly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

Filelist. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

Filesonly. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

Fromdate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

Fromnode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

Fromtime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

Ifnewer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

Inactive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

Incrbydate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

Latest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295

Monitor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

Nojournal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

Noprompt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

Pick . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

Pitdate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

Pittime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

xii Version 4 Release 2

Preservepath. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

Todate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305

Totime. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

V2archive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

Chapter 10. Using Commands . . . . . . . . . . . . . . . . . . . . . . . . . . 311Starting and Ending a Client Command Session. . . . . . . . . . . . . . . . . . . . . 316

Process Commands in Batch Mode. . . . . . . . . . . . . . . . . . . . . . . . . . 316

Process Commands in Interactive Mode. . . . . . . . . . . . . . . . . . . . . . . 317

Entering Client Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

Command Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

File Specification Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319

Maximum File Size for Operations. . . . . . . . . . . . . . . . . . . . . . . . . . 320

Remembering Previous Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

Using Wildcard Characters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

Entering Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

Client Commands Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

Archive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324

Backup Activedirectory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326

Backup Certserverdb. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327

Backup Clusterdb. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

Backup Complusdb. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329

Backup Eventlog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

Backup FRS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

Backup NAS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

xiiiTivoli Storage Manager for Windows Using the Backup-Archive Client

Backup Registry. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336

Backup RSM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340

Backup Sysfiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

Backup Systemobject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343

Backup Sysvol. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345

Cancel Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

Cancel Restore. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

Delete Access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

Delete Archive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

Delete Filespace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

Expire. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

Incremental. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356

Loop. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

Macro. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

Monitor Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367

Query Access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368

Query Activedirectory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369

Query Archive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370

Query Backup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373

Query Backupset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376

Query Certserverdb. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

Query Clusterdb. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

Query Complusdb. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

Query Eventlog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381

Query Filespace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

Query FRS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384

xiv Version 4 Release 2

Query Inclexcl. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385

Query Mgmtclass. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386

Query Node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387

Query Registry. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388

Query Restore. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389

Query RSM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391

Query Schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392

Query Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393

Query Sysfiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394

Query Systemobject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395

Query Sysvol. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

Restart Restore. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397

Restore. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

Restore Activedirectory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

Restore Backupset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407

Restore Certserverdb. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411

Restore Clusterdb. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412

Restore Complusdb. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413

Restore Eventlog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414

Restore FRS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

Restore NAS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

Restore Registry. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420

Restore RSM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425

Restore Sysfiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427

Restore Systemobject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428

Restore Sysvol. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429

Retrieve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430

xvTivoli Storage Manager for Windows Using the Backup-Archive Client

Schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436

Selective. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438

Set Access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441

Set Password. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444

Appendix A. Backing Up NAS File Systems . . . . . . . . . . . 445Performing a Web Client GUI Backup. . . . . . . . . . . . . . . . . . . . . . . . . . . . 446

Performing a Command Line Backup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448

Restoring NAS File Systems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469

xvi Version 4 Release 2

Tables

1. Typographical Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxvi2. Tivoli Storage Manager Client Publications. . . . . . . . . . . . . . . . . . . . . . . .xxxi3. Backing Up and Restoring Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354. Preliminary Steps for Backing Up Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . 365. UNC examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596. Archiving and Retrieving Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827. Default Values in the Standard Management Class. . . . . . . . . . . . . . . . . . . 1008. Option for Excluding Directories. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1149. Options for Controlling Backup, Archive, and System Object Processing 114

10. Options for Controlling Compression, Encryption, and Subfile Processing 11611. Wildcard and Other Special Characters. . . . . . . . . . . . . . . . . . . . . . . . . . . . 11812. Using Wildcard Characters with Include and Exclude Patterns. . . . . . . . . . . 12013. Using UNC Names with Include and Exclude Patterns. . . . . . . . . . . . . . . . 12414. TCP/IP Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12915. Named Pipes Communication Option. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13116. Node Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13117. Backup and Archive Processing Options. . . . . . . . . . . . . . . . . . . . . . . . . . . 13218. Restore and Retrieve Processing Options. . . . . . . . . . . . . . . . . . . . . . . . . . 13619. Scheduling Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13720. Format and Language Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13921. Command Processing Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13922. Authorization Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14023. Error Processing Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14124. Transaction Processing Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14125. Web Client Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14226. Client Command Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27027. Entering Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31128. Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31129. Maximum File Size for Backup, Restore, Archive, and Retrieve. . . . . . . . . 32030. Command Recall and Edit Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32131. Wildcard Characters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32232. NAS Options and Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44833. NAS Options and Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451

xviiTivoli Storage Manager for Windows Using the Backup-Archive Client

xviii Version 4 Release 2

Notices

This information was developed for products and services offered inthe U.S.A. IBM may not offer the products, services, or featuresdiscussed in this document in other countries. Consult your localIBM representative for information on the products and servicescurrently available in your area. Notices References in thispublication to Tivoli Systems or IBM products, programs, or servicesdo not imply that they will be available in all countries in whichTivoli Systems or IBM operates. Any reference to these products,programs, or services is not intended to imply that only TivoliSystems or IBM products, programs, or services can be used.Subject to valid intellectual property or other legally protectable rightof Tivoli Systems or IBM, any functionally equivalent product,program, or service can be used instead of the referenced product,program, or service. The evaluation and verification of operation inconjunction with other products, except those expressly designatedby Tivoli Systems or IBM, are the responsibility of the user. TivoliSystems or IBM may have patents or pending patent applicationscovering subject matter in this document. The furnishing of thisdocument does not give you any license to these patents. You cansend license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

For license inquiries regarding double-byte (DBCS) information,contact the IBM Intellectual Property Department in your country orsend inquiries, in writing, to:

IBM World Trade Asia CorporationLicensing2-31 Roppongi 3-chome, Minato-kuTokyo 106, Japan

The following paragraph does not apply to the United Kingdomor any other country where such provisions are inconsistent with

xixTivoli Storage Manager for Windows Using the Backup-Archive Client

local law: INTERNATIONAL BUSINESS MACHINESCORPORATION PROVIDES THIS PUBLICATION″AS IS″WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS ORIMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITYOR FITNESS FOR A PARTICULAR PURPOSE. Some states do notallow disclaimer of express or implied warranties in certaintransactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies ortypographical errors. Changes are periodically made to theinformation herein; these changes will be incorporated in neweditions of the publication. IBM may make improvements and/orchanges in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM Web sites areprovided for convenience only and do not in any manner serve as anendorsement of those Web sites. The materials at those Web sites arenot part of the materials for this IBM product and use of those Websites is at your own risk.

IBM may use or distribute any of the information you supply in anyway it believes appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it forthe purpose of enabling: (i) the exchange of information betweenindependently created programs and other programs (including thisone) and (ii) the mutual use of the information which has beenexchanged, should contact:

IBM CorporationInformation Enabling RequestsDept. M135600 Cottle RoadSan Jose CA 95193-0001U.S.A.

Such information may be available, subject to appropriate terms andconditions, including in some cases, payment of a fee.

xx Version 4 Release 2

The licensed program described in this document and all licensedmaterial available for it are provided by IBM under terms of theIBM Customer Agreement, IBM International Program LicenseAgreement or any equivalent agreement between us.

Information concerning non-IBM products was obtained from thesuppliers of those products, their published announcements or otherpublicly available sources. IBM has not tested those products andcannot confirm the accuracy of performance, compatibility or anyother claims related to non-IBM products. Questions on thecapabilities of non-IBM products should be addressed to thesuppliers of those products.

If you are viewing this information softcopy, the photographs andcolor illustrations may not appear.

xxiTivoli Storage Manager for Windows Using the Backup-Archive Client

xxii Version 4 Release 2

Trademarks

The following terms are trademarks of the IBM Corporation in theUnited States or other countries or both:

AIXApplication System/400AS/400Client Access/400DYNIX/ptxIBMIBMLinkNUMA-QOperating System/400z/OS

OS/390OS/400PTXRACFRISC System/6000RS/6000Scalable POWERparallelSP2S/390System/390VisualAge

UNIX is a registered trademark of The Open Group in the UnitedStates and other countries.

Microsoft, Windows, Windows NT, Windows 2000, and theWindows logo are trademarks of Microsoft Corporation in theUnited States, other countries, or both.

Jaz and Zip are trademarks or registered trademarks of IomegaCorporation in the United States, other countries, or both.

Java and all Java-based trademarks and logos are trademarks orregistered trademarks of Sun Microsystems, Inc. in the United States,other countries, or both.

Tivoli is a trademark of Tivoli Systems Inc. in the United States, orother countries, or both.

Other company, product, and service names may be trademarks orservice marks of others.

xxiiiTivoli Storage Manager for Windows Using the Backup-Archive Client

xxiv Version 4 Release 2

About This Book

Tivoli Storage Manager is a client-server licensed product thatprovides storage management services in a multi-platform computerenvironment. The backup-archive client program permits users toback up and archive files from their workstations or file servers tostorage, and restore and retrieve backup versions and archived copiesof files to their local file systems.

In addition to the backup-archive client, Tivoli Storage Managerincludes the following programs available on a variety of platforms:

¶ A server programthat permits systems to perform as a backupand archive server for distributed workstations and file servers.

¶ An administrative client programthat you can access from aWeb browser or the command line. The program permits anadministrator to control and monitor server activities, definestorage management policies for backup, archive and spacemanagement services, and set up schedules to perform thoseservices at regular intervals.

¶ An application program interface (API)that permits you toenhance an existing application with storage managementservices. When an application is registered with a server as aclient node, the application can back up, restore, archive, andretrieve objects from storage.

¶ On Windows 98, Windows Me (Millennium Edition), WindowsNT, and Windows 2000 platforms, anODBC driver is availablethat allows you to use a relational database product such asLotus Approach to query the database and display the results.

¶ A Web backup-archive clientthat permits an authorizedadministrator, help desk person, or end user to perform backup,restore, archive, and retrieve services using a Web browser on aremote machine.

Associated with Tivoli Storage Manager, but sold separately, is theTivoli Space Managerclient program which was previously a featureof ADSM known asHierarchical Storage Manager(HSM). Tivoli

xxvTivoli Storage Manager for Windows Using the Backup-Archive Client

Space Manager automatically migrates eligible files to storage tomaintain specific levels of free space on local file systems andautomatically recalls migrated files when they are accessed. It alsopermits users to migrate and recall specific files. This client programruns only on AIX and Solaris operating systems. For specificsoftware requirements, see the README file that is shipped on theproduct installation media.

Unless otherwise specified:¶ References to Windows 98 also include Windows Me

(Millennium Edition)¶ References to Windows NT also include Windows 2000¶ References to Windows refer to all compatible Windows clients.

This book provides information to help you set up and use thebackup-archive client on your workstation. You should be familiarwith your workstation, your operating system, and your basic systemadministration.

Tivoli Storage Manager books are translated into other languages.Contact your Tivoli Storage Manager representative for a list ofavailable translations.

Conventions Used in This BookThis book uses the following typographical conventions:

Table 1. Typographical ConventionsExample Description

autoexec.ncf A series of lowercase letters with an extensionindicates Tivoli Storage Manager program file names.

archive Boldface type indicates a command that you type at aworkstation, such as a command you type on acommand line.

xxvi Version 4 Release 2

Table 1. Typographical Conventions (continued)Example Description

dateformat Boldface italic type indicates a Tivoli StorageManager option. The bold type is used to introducethe option, or used in an example. All other times inthe text it appears as regular type.

Occasionally, file names are entered in boldface italicfor emphasis.

filespec Italicized type indicates either the name of aparameter, a new term, or a placeholder forinformation that you provide.

Italics are also used for emphasis in the text.

maxcmdretries Monospaced type represents fragments of a programor information as it would display on a screen.

plus sign (+) A plus sign between two keys indicates you shouldpress both keys at the same time.

Reading Syntax DiagramsThis section describes how to read the syntax diagrams used in thisbook. To read a syntax diagram, follow the path of the line. Readfrom left to right, and top to bottom.

¶ The ÊÊ─── symbol indicates the beginning of a syntax diagram.

¶ The ───Ê symbol at the end of a line indicates the syntaxdiagram continues on the next line.

¶ The Ê─── symbol at the beginning of a line indicates a syntaxdiagram continues from the previous line.

¶ The ───ÊÍ symbol indicates the end of a syntax diagram.

Syntax items, such as a keyword or variable, can be:¶ On the line (required element)¶ Above the line (default element)¶ Below the line (optional element).

xxviiTivoli Storage Manager for Windows Using the Backup-Archive Client

Syntax Diagram Description Example

Abbreviations:

Uppercase letters denote the shortestacceptable truncation. If an itemappears entirely in uppercase letters,it cannot be truncated.

You can type the item in anycombination of uppercase orlowercase letters.

In this example, you can enterKEYWO, KEYWORD, orKEYWOrd.

ÊÊ KEYWOrd ÊÍ

Symbols:

Enter these symbols exactly as theyappear in the syntax diagram.

* Asterisk{ } Braces: Colon, Comma= Equal Sign- Hyphen() Parentheses. Period

Space

Variables:

Italicized lowercase items(var_name) denote variables.

In this example, you can specify avar_namewhen you enter theKEYWORD command.

ÊÊ KEYWOrd var_name ÊÍ

xxviii Version 4 Release 2


Repetition:

An arrow returning to the left meansyou can repeat the item.

A character or space within thearrow means you must separaterepeated items with that character orspace.

A footnote by the arrow referencesthe number of times you can repeatthe item.

ÊÊ » repeat ÊÍ

ÊÊ »

,

repeat ÊÍ

ÊÊ »(1)

repeat ÊÍ

Notes:

1 Specify repeatas many as 5times.

Required Choices:

When two or more items are in astack and one of them is on the line,you mustspecify one item.

In this example, youmustchoose A,B, or C.

ÊÊ ABC

ÊÍ

xxixTivoli Storage Manager for Windows Using the Backup-Archive Client


Optional Choice:

When an item is below the line, thatitem is optional. In the first example,you can choose A or nothing at all.

When two or more items are in astack below the line, all of them areoptional. In the second example, youcan choose A, B, C, or nothing atall.

ÊÊA

ÊÍ

ÊÊABC

ÊÍ

Defaults:

Defaults are above the line. Thedefault is selected unless youoverride it. You can override thedefault by including an option fromthe stack below the line.

In this example, A is the default. Youcan override A by choosing B or C.You can also specify the defaultexplicitly.

ÊÊA

BC

ÊÍ

Repeatable Choices:

A stack of items followed by anarrow returning to the left means youcan select more than one item or, insome cases, repeat a single item.

In this example, you can choose anycombination of A, B, or C.

ÊÊ » ABC

ÊÍ

xxx Version 4 Release 2


Syntax Fragments:

Some diagrams, because of theirlength, must fragment the syntax.The fragment name appears betweenvertical bars in the diagram. Theexpanded fragment appears betweenvertical bars in the diagram after aheading with the same fragmentname.

ÊÊ The fragment name ÊÍ

The fragment name:

A

BC

Related PublicationsIncluded here is a list of the publications that are referred to in thismanual.

Table 2. Tivoli Storage Manager Client PublicationsPublication Title Order Number

Tivoli Storage Manager Messages GC35-0405

Tivoli Storage Manager Installing the Clients SH26-4119

Tivoli Storage Manager for Windows Using theBackup-Archive Clients

SH26-4117

Tivoli Storage Manager for NetWare Using theBackup-Archive Client

SH26-4116

Tivoli Storage Manager for UNIX Using theBackup-Archive Clients

SH26-4122

Tivoli Space Manager for Unix Using theHierarchical Storage Management Clients

SH26-4115

Tivoli Storage Manager for Windows Managed Systemfor SAN Storage Agent User’s Guide

GC35-0434

Tivoli Storage Manager for AIX Managed System forSAN Storage Agent User’s Guide

GC36-0001

Tivoli Storage Manager for Sun Solaris ManagedSystem for SAN Storage Agent User’s Guide

GC36-0002

xxxiTivoli Storage Manager for Windows Using the Backup-Archive Client

Table 2. Tivoli Storage Manager Client Publications (continued)Publication Title Order Number

Tivoli Storage Manager Using the ApplicationProgramming Interface

SH26-4123

Tivoli Storage Manager Quick Reference for theBackup-Archive Clients

SH26-4118

Tivoli Storage Manager Trace Facility Guide SH26-4121

Tivoli Storage Manager for AIX Quick Start GC35-0402

Tivoli Storage Manager for AS/400 Quick Start GC35-0317

Tivoli Storage Manager for HP-UX Quick Start GC35-0412

Tivoli Storage Manager for OS/390 and z/OS QuickStart

GC35-0415

Tivoli Storage Manager for Sun Solaris Quick Start GC35-0406

Tivoli Storage Manager for Windows Quick Start GC35-0409

The Tivoli Storage Manager publications are available on thefollowing CD-ROM:

Tivoli Storage Manager Publications Version 4.2, SK3T-1417

Tivoli Storage Manager publications are available in softcopy at thefollowing Web page:http://www.tivoli.com/support/public/Prodman/public_manuals/storage_mgr/admanual.htm

The IBM International Technical Support Center redbooks areavailable in softcopy on the IBM Redbooks Web site at thefollowing Web page:http://www.redbooks.ibm.com

You can order hardcopies of all our publications from the IBMDirect Publications Catalog Web site at the following Web page:http://www.elink.ibmlink.ibm.com/pbl/pbl

xxxii Version 4 Release 2

Summary of Changes for Tivoli Storage Manager

This section summarizes changes made to the Tivoli StorageManager product and this publication.

Technical Changes for Version 4.2.1 - September2001

Following is a summary of changes since Tivoli Storage ManagerVersion 4.2:

Support for Processing Network Attached Storage (NAS) FileSystem Images

Tivoli Storage Manager supports backup and restore ofnetwork attached storage (NAS) file system images to tapedrives or libraries that are locally attached to NAS fileservers. Tivoli Data Protection for NDMP enables backupand restore support on the Tivoli Storage Manager WindowsNT and Windows 2000 servers for NAS file servers fromNetwork Appliance.Tivoli Data Protection for NDMP is aseparately priced and licensed product. See “Tivoli DataProtection for NDMP Version 4.2.1 Requirements” on page 8for Tivoli Data Protection for NDMP requirements. See“Backing Up NAS File Systems” on page 445 forinformation on how to back up and restore NAS file systemimages using the Web client and command line client.

Support for LAN-Free Data MovementTivoli Storage Manager supports LAN-Free data movementin a storage area network (SAN) environment. LAN-Freedata movement allows client data to move directly from theclient to a SAN-attached storage device. Shifting the clientdata movement from the communications network to a SANdecreases the load on the server. This allows the server tosupport a greater number of simultaneous client connections.See “LAN-Free Data Movement” on page 54 for moreinformation.

xxxiiiTivoli Storage Manager for Windows Using the Backup-Archive Client

Technical Changes for Version 4.2 - June 2001Following is a summary of changes since Tivoli Storage ManagerVersion 4.1:

Enhancement for Archiving FilesYou can use thev2archiveoption with thearchive commandto archive only files to the server. Directories that exist inthe path of the source file specification will not process. See“V2archive” on page 308 for more information.

Windows NT and Windows 2000 Unicode-Enabled ClientsUnicode is a universal character encoding standard thatsupports the interchange, processing, and display of text thatis written in any modern world language. Unicode filespaces provide support for multi-lingual workstations withoutregard for the current locale. Beginning with Tivoli StorageManager Version 4.2, the Windows NT and Windows 2000clients are Unicode-enabled. Windows NT and Windows2000 clients support the Unicode code page for file,directory, and file space names. See “Migrating to theUnicode-Enabled Client” on page 3 for more information.

Firewall SupportIn most cases, the Tivoli Storage Manager server and clientscan operate across a firewall. The firewall administrator mustopen the firewall ports needed for client and servercommunication. See “Tivoli Storage Manager FirewallSupport” on page 27 for more information.

Support for Journal-Based BackupTivoli Storage Manager supports journal-based backup.Journal-based backup can increase backup performance. Withthis process, the client does not scan the local file system orobtain information from the server to determine which filesto process. Journal-based backup also reduces network trafficbetween the client and server. See “Journal-Based Backup(Windows NT, 2000 only)” on page 40 for more information.

Mobile Dial-Up SupportTivoli Storage Manager supports remote network connectionsto a server. With a remote network connection, mobile users

xxxiv Version 4 Release 2

no longer need to dial-in to their company network for ascheduled backup. Tivoli Storage Manager automaticallyestablishes a connection prior to the scheduled backup. If theconnection fails, Tivoli Storage Manager reestablishes theconnection before attempting the backup. See “MobileDial-Up Support” on page 88 for more information.

Using Communication Method Specified in Active DirectoryWhen you specify theusedirectory, the Tivoli StorageManager client ignorescommmethodparameters in the clientoptions file and queries the Active Directory for thecommunication method and server with which to connect.This option is valid for Windows 2000only. See“Usedirectory” on page 261 for more information.

Restore of Inactive System ObjectsTivoli Storage Manager supports query and restore ofinactive system objects through the command line interface.You can restore system objects via point in time restore.Valid with Windows 2000only.

Support for Inactivating Backup ObjectsTivoli Storage Manager allows you to inactivate backupobjects. Use theexpire command to inactivate the backupobjects listed in a file specification or designated by thefilelist option. See “Expire” on page 353 for moreinformation.

Filelist Support for Command ProcessingTivoli Storage Manager supports use of a file that contains alist of files to be processed for a command. Use thefilelistoption to process a specific list of files. The client opens thespecified filelist and processes each file according to thespecific command. See “Filelist” on page 281 for moreinformation.

Enhancements for the Client Acceptor Service (CAD)The Tivoli Storage Manager Client Acceptor Service cannow manage the Scheduler and the Web client, reducing thenumber of background processes on your workstation. Thisalso resolves memory retention problems that may occur

xxxvTivoli Storage Manager for Windows Using the Backup-Archive Client

when using traditional methods of running the scheduler. See“Managing the Client Scheduler Using the Client AcceptorService” on page 91 for more information.

Enhancements for Compression ProcessingYou can include or exclude a file or groups of files fromcompression processing during a backup or archiveoperation. See “Creating an Include-Exclude List” onpage 111 for more information.

Enhancements for Adaptive Subfile Backup ProcessingYou can include or exclude a file or groups of files forAdaptive Subfile Backup Processing during a backup orrestore operation. See “Creating an Include-Exclude List” onpage 111 for more information.

Enhancements for Restore of Local Backup SetsThe Tivoli Storage Manager GUI can restore a backup set onan attached device on a Windows NT standalone workstationwithout requiring a server connection. See “Restoring Datafrom a Backup Set” on page 69 for more information.

xxxvi Version 4 Release 2

Introducing the Backup-ArchiveClient

The Tivoli Storage Manager backup-archive client helps you protectinformation on your workstation. Using Tivoli Storage Manager, youcan maintain backup versions of your workstation files that you canrestore if the original files are damaged or lost. You can also archiveworkstation files that you do not currently need, or preserve them intheir current state, and retrieve them when necessary.

You can use the graphical user interface, commands, or the Webclient to perform tasks. The command line client is also useful if yourun client commands in batch mode.

As a quick reference, the following could be considered primarytasks:

Primary Tivoli Storage Manager tasks Page

Migrating from Earlier Versions 2

Migrating to the Unicode-Enabled Client 3

Starting a GUI Session 20

Starting a Command Line Session 21

Starting a Web Client Session 24

Ending a Session 31

Performing a GUI Backup 47

Restoring Files and Directories 61

1

1Tivoli Storage Manager for Windows Using the Backup-Archive Client

1.Introducing

theB

ackup-Archive

Client

Primary Tivoli Storage Manager tasks Page

Archiving Files 82

Retrieving Archives 85

Creating an Include-Exclude List 111

Setting Options in the Client Options File 143

Migrating from Earlier Versions

Terminology ChangesPrevious versions of this product were known as ADSTARDistributed Storage Manager (ADSM).ADSM is now known asTivoli Storage Manager. Other terminology changes within thisbook are as follows:

Previously Known As Now Known As

ADSM backup-archive client Tivoli Storage Manager client,backup-archive client, or client

ADSM backup-archive Web client orWeb client

Tivoli Storage Manager Web clientor Web client

ADSM HSM Tivoli Space Manager or HSM client

ADSM server Tivoli Storage Manager server orserver

Changes to Client-Server CommunicationsTivoli Storage Manager no longer supports the NETBIOScommunication method. Therefore, the Windows NT and Windows2000 clients no longer support the following options:¶ lanadapter¶ netbiosbuffersize¶ netbiosname¶ netbiosservername¶ netbiostimeout

2 Version 4 Release 2

Tivoli Storage Manager no longer supports the SNA LU6.2 (APPC)communication method for the Windows clients. Therefore, theseclients no longer support the following options:¶ cpipbuffersize¶ cpicmodename¶ partnerluname¶ symbolicdestination¶ tpname

We recommend TCP/IP as the replacement communication methodfor former NETBIOS and SNA LU6.2 (APPC) users of the Windowsclients.

For more information about the communication methods supportedfor your Tivoli Storage Manager client, see “CommunicationOptions” on page 129.

Upgrade Path for Clients and ServersAs part of a migration plan from Tivoli Storage Manager Version 4.1to Tivoli Storage Manager Version 4.2, clients and servers may beupgraded at different times. To ensure that you can continue yourbackup and archive activities during the migration, please note thefollowing:

¶ A Version 4.1 client can perform backup, restore, archive,retrieve, and query functions to a Version 4.2 server.

¶ A Version 4.2 client can perform backup, restore, archive,retrieve, and query functions to a Version 4.1 server.

¶ Data that is backed up from a Version 4.2 client to any servercannot be restored with a Version 4.1 client.

¶ All command line administrative clients can administer Version4.1 servers and Version 4.2 servers.

Migrating to the Unicode-Enabled ClientUnicode is a universal character encoding standard that supports theinterchange, processing, and display of text that is written in any ofthe languages of the modern world. Unicode-enabled file spacesprovide support for multi-lingual workstations without regard for the


1.Introducing

theB

ackup-Archive

Client

current locale. Beginning with Tivoli Storage Manager Version 4.2,the Windows NT and Windows 2000 clients are Unicode enabled.Windows NT and Windows 2000 clients support the Unicode codepage for file, directory, and file space names. SeeTivoli StorageManager Installing the Clients, SH26-4119 for a list of supportedlanguage environments. Unicode is not supported on Windows 98and Windows Me clients because their respective operating systemsdo not support Unicode.

Benefits of Using the Unicode-Enabled Client¶ If you back up or archive objects with a Unicode-enabled client,

you can restore or retrieve these objects with a Unicode-enabledclient in any other supported language environment. Forexample, a Japanese Unicode-enabled client can restore filesbacked up by German Unicode-enabled client.

¶ The Unicode-enabled client is cross language, meaning that itworks with files using different code pages. TheUnicode-enabled client can handle a mixture of files fromdifferent code pages or locales in the same file space.

¶ Without the support for storing Unicode-enabled file spaces,some earlier Windows NT and Windows 2000 clients haveexperienced backup failures. This occurs when file spacescontain names of directories or files in multiple languages orhave names that cannot be converted to the client’s current codepage.

How to Migrate to the Unicode-Enabled ClientTo migrate to the Windows NT, 2000 V.4.2 client, the server must bea Version 4.2.0 level server. New clients storing data on the serverfor the first time require no special set up. In this case, the serverautomatically stores data in Unicode-enabled file spaces. However, ifyour client already stores data on the server, you need to plan for themigration of your file spaces to Unicode-enabled file spaces. Thisinvolves renaming your file spaces on the server and creating newUnicode-enabled file spaces on the server using theautofsrenameoption. For detailed information about this option, see“Autofsrename” on page 148.


The administrator can specify three possible values using the serverautofsrenameoption: yes, no, or client. Note that the serversetting for this option overrides the setting on the client.

¶ If the server specifiesno, the existing file spaces for your nodeare not renamed or Unicode enabled, even though the WindowsNT, 2000 client is installed.

¶ If the server specifiesyes, and the client performs anincremental backup withdomain=all-local, all file spacesspecified in the current operation that are not Unicode enabledare renamed. The Windows NT, 2000 client then creates newUnicode-enabled file spaces.

If the client performs a selective backup, only the file spacesyou specify in the current operation are renamed and Unicodeenabled.

¶ If the server specifiesclient, the client can set theautofsrenameoption in the client options file (dsm.opt) toprompt, yes, or no. If the client sets the option tono, the filespaces that are not Unicode enabled are not renamed and are notUnicode enabled. If the client specifiesprompt, the clientprompts you whether to rename file spaces. The client promptsyou only once to rename a particular file space.

Optionally, your administrator can rename the file spaces on theserver that are not Unicode enabled.

For options and results when using theautofsrenameoption, see thetable below.

Server Option Client Option Result

Yes Prompt, Yes, No Renamed

No Prompt, Yes, No Not Renamed

Client No Not Renamed

Client Yes Renamed

Client Prompt Based on UserResponse


1.Introducing

theB

ackup-Archive

Client

For detailed information about theautofsrenameoption, see“Autofsrename” on page 148. For additional migration information,seeTivoli Storage Manager for Windows Administrator’s Guide. Foradditional information about working with the Windows NT, 2000client, see:¶ “Considerations for Windows NT, 2000 Unicode-Enabled

Clients” on page 112¶ “Archive” on page 324¶ “Detail” on page 279¶ “Incremental” on page 356¶ “Query Filespace” on page 382¶ “Restore” on page 398¶ “Retrieve” on page 430¶ “Selective” on page 438

Considerations for Migrating to the Unicode-Enabled ClientWhen migrating to the Tivoli Storage Manager Windows NT, 2000client, please consider the following:

1. To support Unicode functionality, Windows NT, 2000 clientsmust connect to a Version 4.2 server. SeeTivoli StorageManager Installing the Clients, SH26-4119, for furtherenvironment and installation information.

2. Ensure that you install the fonts for the languages you want todisplay. If you do not have the necessary fonts installed, the filenames and archive descriptions may not display properly.However, the Windows NT, 2000 client can still back up,restore, archive, and retrieve the files and directories.

3. The Unicode-enabled version of a renamed file space name maybe unreadable if the server cannot display the Unicode name. Inthis case, use the file space identifier (fsID) of the file space toidentify these file spaces on the server. Use thequery filespacecommand with thedetail option to display the fsID of a filespace. The file information dialog in the native and Web clientGUIs also displays the fsID.

4. After installing the V.4.2 Windows NT, 2000 client, werecommend that you perform a full incremental backup to


rename all existing file spaces that are not Unicode enabled andback up the files and directories within them under the newUnicode-enabled file spaces.

5. Renamed file spaces remain on the server and managed asstabilized file spaces.These file spaces contain all the originaldata, which can still be restored until the file spaces aredeleted.You can find additional information in theTivoliStorage Manager for Windows Administrator’s Guide.

6. The server stores information about each node, and once a nodelogs onto the server using a Windows NT, 2000 client, it cannotlog on with a client that does not support Unicode. The serverallows only a Windows NT, 2000 client to restore files from aUnicode-enabled file space.

7. When backing up files to a file space that is not Unicodeenabled, the Windows NT, 2000 client skips the files anddirectories with names containing characters from a code pageother than the current locale.

8. If files and directories with names containing characters from acode page other than the current locale were previouslybackedup with a client that was not Unicode enabled, Tivoli StorageManager willexpire them in the file space that is not Unicodeenabled. However, the Windows NT, 2000 client can back up orarchive these files to a Unicode-enabled file space.

9. When migrating from a client that is not Unicode enabled to aUnicode Client, filenames with double-byte characters mixedwith single-byte characters may be restored in mixed single-bytecharacter set (SBCS) format. This is only a display issue.

10. When a client performs a selective backup of an object and theoriginal file space is renamed, the new Unicode-enabled filespace contains only that object. Tivoli Storage Manager willback up all other directories and file spaces during the next fullincremental backup.


1.Introducing

theB

ackup-Archive

Client

Tivoli Data Protection for NDMP Version 4.2.1Requirements

Tivoli Storage Manager supports backup and restore of networkattached storage (NAS) file system images to tape drives or librariesthat are locally attached to NAS file servers. Tivoli Data Protectionfor NDMP enables backup and restore support on the Tivoli StorageManager Windows NT and Windows 2000 servers for NAS fileservers from Network Appliance.Tivoli Data Protection for NDMPis a separately priced and licensed product.

Tivoli Data Protection for NDMP requires the following hardwareand software:¶ Tivoli Storage Manager Version 4.2.1 server on Windows NT or

Windows 2000¶ Tivoli Storage Manager Version 4.2.1 client on Windows NT,

Windows 2000, Sun Solaris (32-bit), AIX, and AIX 5L.¶ Network Appliance NAS file server. For supported models and

operating systems, refer to:www.tivoli.com/storage

¶ Tape drive and tape library. For supported combinations, refer to:www.tivoli.com/storage

See “Backing Up NAS File Systems” on page 445 for furtherinformation, including how to back up and restore NAS file systemimages using the Web client and command line client.

Additional Migration InformationWhen you install the Web client, you must install the client for thelanguage you want to use.

A command line administrative client is available on clientplatforms. The primary intended interface to the server is the Webadministrative interface and requires a Web browser. The Webadministrative interface is packaged and installed with the server.


Using Storage Management PoliciesStorage management policiesgovern how and when your data isbacked up and archived. Your administrator defines these policies,and you associate them with your data.

Your administrator can coordinate scheduled services with thestorage management policies you use for your files. For example, ifyour storage management policy for a group of files requires thatthey are backed up once a week, your administrator can scheduleautomatic backup services for those files on a particular day eachweek.

For more information about storage management policies, see“Understanding Storage Management Policies” on page 97.

Setting Processing OptionsTivoli Storage Manager includes options that control processing foruser sessions. For example, you can use options to specify whatcommunications methods to use, or to restrict or permit access toyour data. These options reside in the client options file (dsm.opt)and are in effect for an entire session.

Setting Options in a Client Options File – During initialinstallation and setup, Tivoli Storage Manager provides a sampleclient options file. If you want to use different options, copy thesample client options file and modify the new copy. You can performthese same tasks using the Preferences Editor or Setup Wizard on theGUI. See “Creating and Modifying a Client Options File” on page127 for more information.

In addition, you can override an option in the client options file byentering a different value for the option with an appropriatecommand. See “Entering Options with a Command” on page 145 formore information.

Creating an Include-Exclude List – You can create aninclude-exclude list in your client options file to include or exclude


1.Introducing

theB

ackup-Archive

Client

specific files, directories (or both) from backup or encryptionservices. See “Creating an Include-Exclude List” on page 111 formore information.

For detailed information about individual options, see “ClientOptions Reference” on page 146.

Backing Up and Restoring Files

Note: Unless otherwise specified, references in this manual toWindows 98 also include Windows Me (Millennium Edition).References to Windows NT also include Windows 2000.

You requestbackupservices when you want to save copies of filesthat you can restore if the original files are lost or damaged. Thesecopies are calledbackup versionsor backups.

You can perform the following types of backups:

¶ Incremental backup- Initially backs up all specified drives,directories and files, and thereafter, all new or changed files.Running incremental backups on a regular basis ensures currentserver storage of your workstation files. See “Full IncrementalBackup” on page 38 for more information.

¶ Journal-based backup- For Windows NT, 2000only: By default,Tivoli Storage Manager performs a journal-based incrementalbackup on any journaled file systems. Journal-based backup canincrease backup performance because the client does not scanthe local file system or obtain information from the server todetermine which files to process. Journal-based backup alsoreduces network traffic between the client and server. See“Journal-Based Backup (Windows NT, 2000 only)” on page 40for more information.

¶ Incremental by date- Backs up only files with a modificationdate later than the last incremental backup. Anincremental-by-date can maintain current server storage of newand changed workstation files between incremental backups. See“Partial Incremental Backup” on page 41 for more information.


¶ Selective backup- Backs up a single file, a group of files, ordirectories that you specify. Use a selective backup when youwant to back up only a specific subset of files. See “PartialIncremental Backup” on page 41 for more information.

¶ Portable media backup sets- Your administrator can generate abackup set of backup data and copy the backup set onto portablemedia, such as CD-ROM or removable disk drives attached tothe server. You can restore the backup set using a server or fromthe portable media to your local workstation without the use of aserver.

¶ LAN-Free Data Movement- Tivoli Storage Manager Version 4.2Windows NT and Windows 2000 clients support LAN-free datamovement, which shifts the movement of client data from thecommunications network to a storage area network (SAN).Shifting the client data movement from the communicationsnetwork to a SAN decreases the load on the server. This allowsthe server to support a greater number of simultaneous clientconnections. See “LAN-Free Data Movement” on page 54 formore information.

Tivoli Storage Manager provides backup and archive services for allfiles on the following systems:¶ File Allocation Table (FAT).¶ NT File System (NTFS) for Windows NT and Windows 2000.¶ FAT 32 for Windows 98, Me, and Windows 2000.

You can restore a single file, a group of files, or all files in adirectory. You can restore files to the same directory from which youbacked them up or to a different directory. You can restore any filesyou back up and any other files to which another user grants youaccess.

Note: For Windows 2000: Tivoli Storage Manager will back up asparse file as a regular file if thecompressionoption is turnedoff. To minimize network transaction time and maximizeserver storage space, enable file compression when backing


1.Introducing

theB

ackup-Archive

Client

up sparse files. For more information about backing up andrestoring sparse files, see “Backing Up and Restoring” onpage 35.

Archiving and Retrieving FilesYou requestarchiveservices when you want to save files at aspecific point, or place copies in long-term storage and erase themfrom your workstation. These copies are calledarchive copiesorarchives. Archives are never replaced with more current versions, butare preserved exactly as you store them.

You can archive a single file or a group of files, or all files in adirectory.

When you archive a file, enter a description of the file that you canuse later toretrieve it from storage to your workstation. You canreturn an archived file to the same directory from which youarchived it, or to a different directory. You can retrieve any files youarchive and any other files to which another user grants you access.

For more information about archiving and retrieving, see “Archivingand Retrieving Files” on page 81.

Using the Web Backup-Archive ClientThe Web backup-archive client (Web client) permits an authorizedadministrator, help desk person, or end user to perform backup,restore, archive, and retrieve services on any workstation or platformthat supports a Java 1.1.6-capable browser. This includes browserssuch as Netscape Navigator 4.06 or higher or Microsoft InternetExplorer 4.01 or higher. You can perform multiple Web clientsessions simultaneously. For example, you can perform a backup,archive, restore, and query on separate Web browsers. The Webclient is available on the Windows 98, Me, 2000, and NT 4.0 clientplatforms.

Only a server that is Version 3 or higher supports the Web client.


The Web client does not support the following functions:¶ Estimate¶ View Policy Information¶ Access Another User¶ Searching and Filtering¶ User Access List¶ Preferences Editor¶ Setup Wizard

See “Starting a Web Client Session” on page 24 for informationabout starting and using the Web client.

Automating TasksTivoli Storage Manager providescentral schedulingto automaticallyperform tasks. Your administrator defines schedules. For example,you might have files that you want backed up daily, weekly, ormonthly. After defining your schedules, your administrator associatesyour client node with those schedules. Then, when you run theclientscheduler, it tells the server to include your node when running theappropriate schedule. You can also define schedules remotely fornetworked nodes. For more information about scheduling, see“Automating Tasks” on page 87.


1.Introducing

theB

ackup-Archive

Client

Getting Started

This chapter includes instructions for the following tasks:

Task Page

Starting Tivoli Storage Manager the First Time 15

Starting a GUI Session 20

Starting a Command Line Session 21

Using Batch Mode 21

Using Interactive Mode 21

Starting a Web Client Session 24

Tivoli Storage Manager Firewall Support 27

Starting the Client Scheduler Automatically 29

Changing Your Password 30

Sorting File Lists 30

Displaying Online Help 31

Ending a Session 31

Starting Tivoli Storage Manager the First TimeThe following information assumes that you have installed TivoliStorage Manager. If you have not installed Tivoli Storage Manager,seeTivoli Storage Manager Installing the Clients,SH26-4119, forinstallation information.

2


2.G

ettingS

tarted

If you plan to use a Web client, you must have an administrativeuser ID with system privilege, policy privilege, client accessauthority, or client owner authority.

Before you can use Tivoli Storage Manager, you must register yourclient with the server. The process of setting up a node name andpassword is calledregistrationand is performed by youradministrator.

There are two types of registration:openandclosed. Youradministrator chooses the type of registration for your site.

Using Closed RegistrationWith closed registration, an administrator must register yourworkstation as a client node with the server. If your enterprise usesclosed registration, you need to provide the following information toyour administrator:¶ Your node name (the value returned by thehostnamecommand

or the node name you specified with thenodenameoption).¶ The initial password you want to use, if required.¶ Contact information, such as your name, user ID, and phone

number.

In addition to possibly defining certain options in your options file,your administrator defines the following for you:¶ The policy domain to which your client node belongs. A policy

domain contains policy sets and management classes, defined byyour administrator, that control how Tivoli Storage Managermanages the files you back up and archive.

¶ Whether you can compress files before sending them to theserver.

¶ Whether you can delete backup and archive data from serverstorage.

Using Open RegistrationWith open registration, you can register your workstation as a clientnode with the server.


The first time you start a session, Tivoli Storage Manager promptsyou for information necessary to register your workstation with theserver identified in your client options file. You need to supply yournode name, a password, and contact information.

When you use open registration:¶ Your client node is assigned to a policy domain named

standard.¶ You can define whether compress files before sending them to

the server. See “Compression” on page 159 for more informationabout thecompressionoption.

¶ You can delete archived copies of files from server storage, butnot backup versions of files.

If necessary, your administrator can change these defaults later.

For more information about Tivoli Storage Manager client services,seeTivoli Storage Manager Installing the Clients,SH26-4119.

Considerations for NT and 2000 Client ServicesTo install and configure Tivoli Storage Manager services on theentire system, including the system registry, you must belong to alocal administrator account or a domain administrator account. Toback up files, you must have access rights on the local drive ordirectory containing those files.

By default, Tivoli Storage Manager client services run under thelocal system account. Because the services use logon properties suchas persistent drive mappings, and local search path and environmentvariables of the account into which they are logged, consider havingthe services account run under a domain account instead of the localsystem account.

Domain resources, such as network drives, can only be accessed byservices configured to run under a domain authorized account usingdsmcutilor the Service Control Panel Application. Any non-systemaccount (local or domain) must have the following rights:¶ Back up files and directories


2.G

ettingS

tarted

¶ Restore files and directories¶ Manage auditing and security logs

Note: Some Windows 2000 system objects such as active directoryrequire Administrator privileges to perform backups.

Users without these rights can only back up files they own andcannot back up the system registry or files owned by other users.These are local user rights and must be set using the local UserManager application, and domain accounts may not automatically beenabled for them. Domain accounts may be granted local rights bythe local User Manager.

The account must also have the following permissions to theHKEY_LOCAL_MACHINE, HKEY_KEY_USERS, andHKEY_CURRENT_USER registry hives:¶ Query Value¶ Set Value¶ Create Subkey¶ Enumerate Subkeys

The local system account and local administrator group posess thesepermissions by default. Other accounts/groups (including domainAdministrators) must be granted these permissions either explicitlythrough the registry editor security dialog (regedt32), or implicitly byadding the account/group to the local Administrators group throughthe local User Manager (recommended).

Permissions Required to Restore Files that UseAdaptive Subfile Backup

Note: This section refers to Windows NT and Windows 2000only.

To restore files that were processed using adaptive subfile backup,you must either be the owner of the file or have read access. Thesepermissions are in addition to those required to perform a normalrestore. For more information about adaptive subfile backups, see“Performing a Backup with Limited Bandwidth” on page 44.


Tivoli Storage Manager Client AuthenticationWhen using the native backup-archive client or the Web client, youcan logon using a nodename and passwordor administrative user IDand password. Tivoli Storage Manager prompts for your user ID andcompares it to the configured nodename. If they match, TivoliStorage Manager attempts to authenticate the user ID as a nodename.If the authentication fails or if the user ID does not match theconfigured nodename, the client attempts to authenticate the user IDas an administrative user ID.

To use an administrative user ID with any of the backup-archiveclients, the user ID must have one of the following authorities:¶ System privilege- Authority over the entire system.¶ Policy privilege- Authority over the node’s domain.¶ Client owner- Authority over the configured nodename. With

client owner authority, you own the data and have physicalaccess to it.

The Tivoli Storage Manager Web GUI allows access if theadministrative user ID has client access over the configurednodename. This permits you to back up and restore files on a remotemachine but you cannot restore files to your own machine. Withclient access authority you do not have physical access to the data. Ifyou want to use the Web GUI but wish to prevent administratorswith client access authority from accessing your machine remotely,specify therevokeremoteaccessoption in your options file. See“Revokeremoteaccess” on page 229 for more information

Client access authority is not sufficient to access the backup-archiveclient, command line client, and native GUI. You must possess atleast client owner authority.

You can use thevirtualnodenameoption to temporarily access yournode’s data from another machine. This option differs from thenodenameoption in that, ifpasswordaccess=generateis specifiedalong with thevirtualnodenameoption, the password is not storedon the local machine. If you specify thenodenameoption, the


2.G

ettingS

tarted

password is stored on the local machine. See “Virtualnodename” onpage 264 for more information about thevirtualnodenameoption.

Starting a GUI SessionStart a GUI session using one of the following methods:

¶ SelectStart→ Programs→ Tivoli Storage Manager folder, clickthe Backup Archive GUI icon.

¶ SelectRun from the Start menu, then enter the full path to theBackup Client (dsm.exe).

¶ On the command line, change directory to the Tivoli StorageManager installation directory and enterdsm.

Tivoli Storage Manager locates theclient optionsfile (dsm.opt) andstarts with the options you specify in that file. See “Creating andModifying a Client Options File” on page 127 for more informationabout the options file.

Password and User IDYour administrator can require you to use a password to connect tothe server. Tivoli Storage Manager prompts you for the password ifone is required. Contact your administrator if you do not know yourpassword. For information about changing your password, see“Changing Your Password” on page 30.

Note: For Windows NT and Windows 2000, in order to back up theentire system, including the system registry, your user IDmust belong to the administrator group or domainadministrator group which has the following rights. See“Considerations for NT and 2000 Client Services” on page 17for more information.

Configuration WizardWhen the GUI client starts initially and does not find an options file,a setup wizard displays to guide you through the configurationprocess. You can also display the setup wizard by selectingUtilities→Setup Wizard from the main window. To perform configurationtasks, follow instructions on the screen.


Note: The Setup Wizard is not available through the Web client.

Starting a Command Line SessionAn alternate way to start the client is from the command line. Start acommand line session using one of the following methods:

¶ SelectStart→ Programs→ Tivoli Storage Manager folder→Backup Client Command Line.

¶ On the command line, change directory to the Tivoli StorageManager installation directory and enterdsmc followed by thecommand, if you want to run a single command (batch mode).

¶ On the command line, change directory to the Tivoli StorageManager installation directory and enter eitherdsmc loopordsmc. This places you ininteractive mode, permitting you to runseveral commands without preceding each withdsmc.

Using Batch ModeUsebatchmode when you want to enter a single client command.You must precede each command withdsmc.

Using Interactive ModeUse interactivemode when you want to issue a series of commands.Because Tivoli Storage Manager establishes the connection to theserver only once for interactive mode, you can process a series ofcommands more quickly in interactive mode than in batch mode.

When you are in interactive mode, do not precede commands withdsmc. For example, instead of typingdsmc archive to archive a file,type onlyarchive.

After you start an interactive session, some options are valid ininteractive mode andremain in effectthroughout the session unlessyou reenter them with a different setting. However, most options arevalid only on the initial command line. To identify which optionsmust be entered in this way, see “Using Options with Commands”on page 269. If Tivoli Storage Manager does not find an options file,


2.G

ettingS

tarted

it displays an error message and stops processing. In this case, seeyour administrator to determine the name of the options file TivoliStorage Manager should use.

Note: For Windows NT and Windows 2000, in order to back up theentire system, including the system registry, your user IDmust belong to the administrator group or domainadministrator group which has the following rights. See“Considerations for NT and 2000 Client Services” on page 17for more information.

For more information about using the command line client, see“Starting and Ending a Client Command Session” on page 316.

For more information about client services, seeTivoli StorageManager Installing the Clients,SH26-4119.

Displaying Euro Characters in Command Line PromptTo display the Euro character in the Windows command line prompt(console window):

1. Contact your Microsoft Representative for the 858 Codepage (thefilename isc_858.nls). Copy the file into your Windowssystem32 directory (for example,C:\WINNT\system32).

2. Edit the registry key:HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Nls\CodePage\850

and set it to valuec_858.nls.

3. In your Regional Settings, select a Western European country(Germany, France, Italy, etc.) as your locale setting.

4. Exit and reboot the machine.

Ensure that the console window font you use supports the Eurosymbol (such as Lucida Console).

Using Options on the DSMC CommandYou can include options on thedsmc command. For example, yourorganization might have two workstations that back up to the serverunder separate node names. To recover a file from one workstation


(galaxy1) while at the other workstation (galaxy2), you will needaccess togalaxy1. We recommend that you use theset accesscommand to gain access.

For example, assume the file to be recovered ongalaxy1 isc:\universe\saturn. The owner ofgalaxy1 enters the followingcommand:

dsmc set ac archive c:\universe\saturn galaxy2

When access is granted, you would gain access by entering:dsmc retrieve fromnode=galaxy1 c:\universe\saturn

Access to another user’s files may also be granted and gained usingthe GUI.

For more information about theset accesscommand, see “SetAccess” on page 441. For more information about thefromnodeoption, see “Fromnode” on page 286.

Starting: Advanced ConsiderationsYou can include options with thedsm command. For example, youcan use options to modify the format that displays dates, times, andnumbers, or to include your password so that Tivoli StorageManager does not prompt for it.

For example, you might have two workstations that back up to theserver under separate node names. If you wanted to recover a filefrom one workstation (brant1) while at the other workstation(derek2), you could start Tivoli Storage Manager using thenodenameoption specifying brant1:

dsm -nodename=brant1

Be careful if you use Tivoli Storage Manager in this way. Do notattempt to perform an incremental backup from thederek2workstation while connected to Tivoli Storage Manager asbrant1. Ifthe drive labels are the same on thebrant1 andderek2workstations, the incremental backup will expire any files that are


2.G

ettingS

tarted

not on thederek2 workstation, even if they still exist onbrant1.You could lose some valuable backup generations.

Expiring a file means that the active version of the file on the serveris made inactive and any older versions that exist on the server aremanaged under the policy for inactive objects.

Starting a Web Client SessionYou can use the Web client to perform backup, archive, restore, andretrieve operations from workstations or platforms that support atleast a Java 1.1.6-capable browser, such as Netscape Navigator 4.06or higher or Microsoft Internet Explorer 4.01 or higher. You canback up and restore your own data, or an administrator cancentralize the backup or restore operations of many clients. To usethe Web client, specify the URL of the client workstation runningthe Web client in your Web browser. You also need to specify thelocalhost port number; the default is 1581. The Web client issupported on a server that is Version 3 or higher.

Note: Entering a different URL or pressing the browserBack buttonduring an operation disconnects the Web client and causes thecurrent operation to end. However, network attached storage (NAS)operations will continue after disconnect.

Setting User PrivilegesIf you plan to use the Web client, ensure that you were assigned anadministrative user ID with system privilege, policy privilege, clientaccess authority, or client owner authority. See “Tivoli StorageManager Client Authentication” on page 19 for more informationabout these authorities.

Note: Use therevokeremoteaccessoption to restrict an administratorwith client access privilege from accessing your workstation throughthe Web client. Administrators with client owner privilege, systemprivilege, or policy privilege can access the Web client. See“Revokeremoteaccess” on page 229 for more information about the


revokeremoteaccessoption. See “Tivoli Storage Manager ClientAuthentication” on page 19 for more information about accessauthorities.

Installing and Using the Web ClientIf you did not install the Web client during the installation process,you can use the command line or the setup wizard to install andconfigure it.

To use the setup wizard, perform the following steps:1. SelectUtilities→ Setup Wizard From the client GUI.2. Select theHelp me configure the TSM Web Client checkbox.3. Follow the instructions on the screen.

To install and configure the Web client from the command line,perform the following steps:

1. Ensure that you specifypasswordaccessgeneratein the clientoptions file (dsm.opt). For more information onpasswordaccess,see “Passwordaccess” on page 216.

2. To generate the Tivoli Storage Manager password, start thenative backup-archive client by entering:dsmc query session

when prompted, enter your user ID and password.

On Windows NT, you can also use the client services utility(dsmcutil) to generate passwords and validate them with theserver.

3. Start the client acceptor service

¶ For Windows 98: Enter thedsmcadcommand.

Note that unless the Tivoli Storage Manager installationdirectory is included in the current path, thedsmcadcommand will not work.

¶ For Windows NT:a. On the taskbar, clickStart→ Settings→ Control Panel→

Services.


2.G

ettingS

tarted

b. In the Services window, selectTSM Client Acceptor andclick the Start button.

¶ For Windows 2000:a. On the taskbar, clickStart→ Programs→ Administrative

Tools→ Services.b. SelectTSM Client Acceptor.c. Click the right mouse button.d. SelectProperties.e. Click theStart button.

The Web client agent is automatically started by the ClientAcceptor Service (CAD) when needed.

The only options applicable to thedsmcadprogram areoptfile,httpport, httpsport, andwebports. You can specify these optionsin the dsm.opt file.

All Web client messages are written to the Web client log file,dsmwebcl.log. Error messages are written to the error log filedsmerror.log, or the file you specify with theerrorlognameoption. Thedsmwebcl.log anddsmerror.log files reside in thedirectory you specify with the DSM_LOG environment variableor in the current working directory. See “Setting CommonOptions” on page 127 for more information.

For more information about Tivoli Storage Manager clientservices, seeTivoli Storage Manager Installing the Clients,SH26-4119.

4. To access the Web client, enter the following URL from anysupported browser:http://your_machine_name:1581

where your_machine_name is the hostname of the machinerunning the Web client.

Port 1581 is the default port number. Your administrator can set adifferent port number using thehttpport option. See “Httpport” onpage 184 for more information.


You can also access the Web client workstation through the Webadministrative GUI.To use the Web client with secure socket layer(SSL) communications, or for more information about Tivoli StorageManager client services, seeTivoli Storage Manager Installing theClients,SH26-4119.

Tivoli Storage Manager Firewall SupportIn most cases, the Tivoli Storage Manager server and clients canwork across a firewall. The ports that the client and server need tocommunicate must be opened in the firewall by the firewalladministrator. Because every firewall is different, the firewalladministrator may need to consult the instructions for the firewallsoftware or hardware in use.

The ports that the firewall needs to define are those ports that areneeded for the client to connect to the Tivoli Storage Managerserver. If the server is listening on port 1500 then the firewallsoftware needs to forward the port to the Tivoli Storage Managerserver machine.

To allow clients to communicate with a server across a firewall, youmust open the TCP/IP port for the server using thetcpport option inthe server options file. The default TCP/IP port is 1500.

To allow the Web client to communicate with remote workstationsacross a firewall, you must open the HTTP port for the remoteworkstation using thehttpport option in the remote workstation’sclient option file. The default HTTP port is 1581.

You must open the two TCP/IP ports for the remote workstationclient using thewebportsoption in the remote workstation’s optionfile. Values for thewebportsare required. If you do not specify thevalues for thewebportsoption, the default zero (0) causes TCP/IP torandomly assign two free port numbers. See “Webports” on page 266for more information about thewebportsoption.


2.G

ettingS

tarted

To use the administrative Web interface for a server across afirewall, you must open the port that is the HTTP port for the serverusing thehttpport option in the server options file. The defaultHTTP port is 1580.

In an enterprise environment, we strongly recommend that you usethe Tivoli Storage Manager Secure Web Administrator Proxy forWeb administration of the Tivoli Storage Manager server. Install theproxy on a Web server that sits on the firewall so that the Webserver can access resources on both sides of the firewall (this issometimes called thedemilitarized zone). When you set up theproxy, you can use it to administer any Tivoli Storage Managerserver at Version 3.7 or higher. For more information on how toinstall and use the proxy, see the appendix about the Web proxy inthe Tivoli Storage Manager Quick Start manual. You can alsoincrease security in this environment by enabling HTTPS services(also called secure socket layer or SSL) on the Web server whereyou install the proxy. Check your Web server documentation forinformation on how to set this up.

When using Tivoli Storage Manager across a firewall, pleaseconsider the following:

¶ To use the Web client to connect to a client across a firewall, theWeb client and the backup-archive client must be Version 4.1.2or later.

¶ To enable the backup-archive client, command line admin client,and the scheduler (running in polling mode) to run outside afirewall, the port specified by the server optiontcpport (default1500) must be opened by the firewall administrator.

Note: Tivoli Storage Manager does not support the schedulerrunning inpromptedmode outside a firewall. Inpromptedmodethe Tivoli Storage Manager server needs to contact the client. Inorder to do this, some software must be installed on the TivoliStorage Manager server to route the request through the firewall.This software routes the server request through a sock port onthe firewall. This is typically calledsockifinga system. Proxiesare not supported, since they only route a few types ofcommunication protocols (HTTP, FTP, GOPHER) and Tivoli


Storage Manager is not one of these communication protocolsthat are routed. It is important to note that the client creates anew connection to the Tivoli Storage Manager server whenprompted. This mean that the firewall configuration discussedabove must be in place.

¶ The server cannot log events to a Tivoli Enterprise Console(T/EC) server across a firewall.

Starting the Client Scheduler Automatically

Note: Install the command line client if you want to use the clientscheduler. This client permits you to request Tivoli StorageManager services with commands rather than with the GUI.

You can start the client scheduler automatically when you start yourworkstation. If the administrator has defined schedules for yournode, starting the client scheduler permits you to automatically backup your workstation (or perform other scheduled actions). See“Automating Tasks” on page 87 for more information about theclient scheduler.

You can also use the Tivoli Storage Manager Client Acceptor serviceto manage the scheduler. See “Managing the Client Scheduler Usingthe Client Acceptor Service” on page 91 for more information.

Tivoli Storage Manager supports remote network connections to theserver. With a remote network connection, mobile users no longerneed to dial-in to their company network when a backup isscheduled to run. Tivoli Storage Manager automatically establishes aconnection before the scheduled backup occurs. If the connectionfails, Tivoli Storage Manager reestablishes the connection beforeattempting the backup. See “Mobile Dial-Up Support” on page 88 formore information.


2.G

ettingS

tarted

Changing Your PasswordYour administrator can require you to use a password to connect tothe server. Tivoli Storage Manager prompts you for the password ifone is required. Contact your administrator if you do not know yourpassword.

If you are using passwords, you should change them regularly torestrict access to your data.

To change your password from the GUI:1. SelectUtilities→ Change password.2. Enter your current and new passwords, and enter your new

password in theVerify password field.3. Click Change.

A Tivoli Storage Manager password can be up to 64 characters.Valid characters are:

Character DescriptionA–Z Any letter; A through Z, upper or lower case0–9 Any number; 0 through 9+ Plus. Period_ Underscore- Hyphen& Ampersand

A password is not case sensitive. See “Password” on page 214 foradditional password information.

Sorting File ListsYou can sort a list of files by various attributes, such as name,directory, size, or modification date. Sorting files by the last backupdate can be useful in determining what date and time to use for thepoint-in-time function (see “Performing Point-in-Time Restores” onpage 72).


To sort a file list, select one of theSort by items from theViewmenu bar. You can also click the appropriate column heading in theFile List box.

The Show active/inactive filesmenu option controls whether todisplay both active and inactive backup versions of files. Anactivefile is the most recent backup version of a file that existed on yourworkstation when you ran your last backup. All other backupversions of that file are calledinactive. Only active backup versionsof files display during a session, unless you select theShowactive/inactive filesmenu option. If you delete the file from yourworkstation, the active version becomes inactive the next time yourun an incremental backup.

Displaying Online HelpYou can display online help in any one of the following ways:¶ Place the cursor on an option or field of interest and press F1.¶ Select theHelp menu;How do I? item.¶ Click the Help button in current window.¶ On the Command Line, enter thedsmc helpcommand.

Ending a SessionYou can end a Tivoli Storage Manager client session in any one ofthe following ways:¶ SelectFile menu→ Exit .¶ Double-click theSystemmenu (the button in the upper left

corner on the title bar).

Click the X icon in the upper right corner.¶ SelectSystemmenu→ Close.¶ PressAlt+F4 .¶ On the Command Line, enterquit (when working in interactive

mode).

To end a Web client session, open a different URL, or close thebrowser.


2.G

ettingS

tarted

Online ForumTo participate in online user discussions of Tivoli Storage Manager,you can subscribe to an Internet Listserv forum. This is not officiallysupported by Tivoli Storage Manager, but support people doparticipate in the discussions, along with other users.

You can subscribe by sending a note [email protected] contains:subscribe adsm-l yourfirstname yourlastname

Posts can then be sent [email protected].

Other Sources of Online HelpAn anonymous FTP server is available where you can find PTFmaintenance and other Tivoli Storage Manager-related materials.This site is unofficially maintained by non-IBM volunteers.sunsite.unc.edu/pub/packages (mirror - North Carolina)

If you have the required username and password, you can getmaintenance information from the Tivoli Storage Manager supportpage at:http://www.tivoli.com/support/storage_mgr/tivolimain.html

Contacting Customer SupportFor support for this or any Tivoli product, you can contact TivoliCustomer Support in one of the following ways:

¶ Visit the Tivoli Storage Manager technical support Web site at:http://www.tivoli.com/support/storage_mgr/tivolimain.html

¶ Submit a problem management record (PMR) electronically atIBMSERV/IBMLINK . You can access the IBMLINK from theIBM Web site athttp://www2.ibmlink.ibm.com.

¶ Submit a problem management record (PMR) electronically fromthe Tivoli Web site athttp://www.tivoli.com/support.

¶ Send e-mail [email protected].


Customers in the United States can also call 1-800-TIVOLI8(1-800-848-6548). For product numbers 5697-TS9, 5697-DRS or5697-DPM call 1-800-237-5511.

International customers should consult the Tivoli Web site forcustomer support telephone numbers.

If you have a problem with any Tivoli product, you can contactTivoli Customer Support. See the Tivoli Customer SupportHandbook at the following Web site:

http://www.tivoli.com/support/handbook/

The handbook provides information about how to contact TivoliCustomer Support, depending on the severity of your problem, andthe following information:¶ Registration and eligibility¶ Telephone numbers and e-mail addresses, depending on the

country you are in¶ What information you should gather before contacting support

When you contact Tivoli Customer Support, be prepared to provideidentification information for your company so that supportpersonnel can readily assist you. Company identification informationmay also be needed to access various online services available onthe Web site.

The Tivoli Customer Support Web site(http://www.tivoli.com/support/) offers a guide to supportservices (the Customer Support Handbook); frequently askedquestions (FAQs); and technical information, including release notes,user’s guides, redbooks, and white papers. You can access Tivolipublications online athttp://www.tivoli.com/support/documents/. The documentationfor some products is available in PDF and HTML formats.Translated documents are also available for some products.

To access most of the documentation, you need an ID and apassword. To obtain an ID for use on the support Web site, go tohttp://www.tivoli.com/support/getting/ .


2.G

ettingS

tarted

You can order documentation by e-mail [email protected] provide the publication number, part number, or order numberof the desired document. Alternatively, you can provide thedocument title, version number, and date of publication.

We are very interested in hearing about your experience with Tivoliproducts and documentation. We also welcome your suggestions forimprovements. If you have comments or suggestions about ourdocumentation, please contact us in one of the following ways:¶ Send e-mail [email protected].¶ Complete our customer feedback survey at

http://www.tivoli.com/support/survey/.


Backing Up and Restoring

Use the backup-archive client to store backup versions of yourworkstation files to a Tivoli Storage Manager server. You can restorethese backup versions to your workstation if the original workstationfiles are lost or damaged. This chapter discusses various ways youcan back up your files and how to restore these files when you needthem.

All client backup and restore procedures in this chapter also apply tothe Web client, except those listed in “Using the WebBackup-Archive Client” on page 12. See “Starting a Web ClientSession” on page 24 for information on starting the Web client.

Unless otherwise specified, references in this manual to Windows 98also include Windows Me. References to Windows NT also includeWindows 2000.

See Table 3 for a list of primary tasks.

Table 3. Backing Up and Restoring FilesTask Page

Planning Your Backups 36

Using an Include-Exclude List to Control Processing 45

Performing a GUI Backup 47

Performing a Command Line Backup 49

LAN-Free Data Movement 54

Backing Up NAS File Systems 55

3


3.B

ackingU

pand

Restoring

Table 3. Backing Up and Restoring Files (continued)Task Page

Performing a GUI Restore 63

Performing a Command Line Restore 64

Restoring Data from a Backup Set 69

Performing Point-in-Time Restores 72

Authorizing Another User to Restore or Retrieve Your Files 75

Restoring or Retrieving Another User’s Files 76

Restoring or Retrieving Your Files to Another Workstation 76

Restoring or Retrieving Files to Another Type of Workstation 77

Restoring a Disk in the Event of Disk Loss 78

Deleting File Spaces 79

Planning Your BackupsIf you are a first-time user, or if you only back up files occasionally,you can use the checklist in Table 4 for preliminary planning.

Table 4. Preliminary Steps for Backing Up Files

___ Decide whether you want to back up or archive files. See “Do YouWant to Back Up or Archive Files?” on page 37 for moreinformation.

___ See “Pre-Backup Considerations” on page 43 for importantmigration information concerning the Windows NT and Windows2000 clients, and how you may increase performance prior tobacking up files and directories.

___ Create an include-exclude list to specify files and directories youwant to exclude from backup services. See “Using anInclude-Exclude List to Control Processing” on page 45 for moreinformation.

___ Decide what type of backup you want according to your needs.See the following sections for more information: “Full IncrementalBackup” on page 38, “Partial Incremental Backup” on page 41, and“Full Incremental versus Partial Incremental Backup” on page 42


Table 4. Preliminary Steps for Backing Up Files (continued)

___ For additional backup considerations, see “Backup: AdditionalConsiderations” on page 55.

Do You Want to Back Up or Archive Files?When the backup-archive client backs up or archives a file, it sendsa copy of the file and its associated attributes to the server; however,backups and archives have different goals.

Backups protect against file damage. A sequence of backup versionsis kept for each file on your workstation and older versions aredeleted as newer versions are made. The number of backup versionsis set by your administrator.

Archive copies are more permanent. They maintain a file in aparticular state indefinitely (although your administrator can limithow long archives are kept). Archives are useful if you need to goback to a particular version of your files, or you want to delete a filefrom your workstation and retrieve it if necessary. For example, youmight need to save spreadsheets for tax purposes, but because youare not using them, you do not want to leave them on yourworkstation. See “Archiving and Retrieving Files” on page 81 formore information about archiving and retrieving files.

Use backups to protect against unforeseen damage to your files, anduse archives for maintaining more permanent versions of your files.

Backing Up Files and DirectoriesYour administrator might set up schedules to automatically performback ups. See “Automating Tasks” on page 87 for information aboutchecking and running schedules that are available to you. Thefollowing sections discuss how to back up files without a schedule.

There are two types of incremental backup:full incremental andpartial incremental.


3.B

ackingU

pand

Restoring

Full Incremental BackupA full incremental backup (also called an incremental backup)initially backs up all specified drives, directories and files, andthereafter, all new and changed files. Thus Tivoli Storage Managermaintains current server storage of your workstation files accordingto your storage management policies. Files that you delete from yourworkstation will not have active backup versions on the server. See“Understanding Storage Management Policies” on page 97 for moreinformation about storage management polices.

To perform a full incremental backup using the client GUI, select theIncremental (complete)option from the type of backup pull-downmenu on the backup window or use theincremental command ondsmc prompt. Specify file systems, directory trees, or individual filesto include in the backup.

During a full incremental, the client queries the server or the journaldatabase (Windows NT, 2000) to determine the exact state of yourstorage as of your last incremental. Tivoli Storage Manager uses thisinformation to:¶ Back up new files¶ Back up files whose contents change since the last backup.

Changes includeany of the following:

v File size.

v Date or time of last modification.

v File attributes, except for the archive (A) attribute. TivoliStorage Manager does not use the archive attribute becauseother programs change the attribute during file copying, evenif the file does not change. When you restore a file, TivoliStorage Manager restores the attributes to what they werewhen you backed up the file.

v NTFS file security descriptors. These are the Owner SecurityIdentifier (SID), Group SID, Discretionary Access ControlList (ACL), and System ACL.


v The file is not excluded from backup in your include-excludelist. If you do not have an include-exclude list, all files willprocess.

v The selected management class contains a backup copygroup. See “Automating Tasks” on page 87 for moreinformation on management classes and backup copy groups.

v The file meets the serialization requirements defined in thebackup copy group. If serialization isstatic or shared static,and the file is in use during back up, the backup does notoccur.

v The file meets the mode requirements defined in the backupcopy group. If the mode ismodified, the file must havechanged since the last backup. If the mode isabsolute, thefile can be backed up even if it does not change. See “UsingManagement Classes and Copy Groups” on page 98 for moreinformation.

v The file meets the frequency requirements defined in thebackup copy group. The specified minimum number of dayssince the last backup must elapse before a file is backed up.Frequency is ignored for partial incremental backups. See“Using Management Classes and Copy Groups” on page 98for more information.

¶ Expire backup versions of files on the server that do not havecorresponding files on the workstation. The result is that fileswhich no longer exist on your workstation will not have activebackup versions on the server.

¶ Rebind backup versions to management classes if you changemanagement class assignments, even if you do not back up thefile.

Attention: An incremental backup backs up all directoryinformation. When you back up a file, the directories in the path thatcontain the file are also backed up. To exclude directories frombackup, use theexclude.diroption. For more aboutexclude.dir, see“Exclude Options” on page 177. Directories count in the number ofobjects backed up.


3.B

ackingU

pand

Restoring

Perform a selective backup if you want to back up empty directoriesand their attributes. See “Backing Up and Restoring” on page 35 formore information.

Journal-Based Backup (Windows NT, 2000 only)If you install thejournal engine serviceand it is running, then bydefault theincremental command performs a journal-basedincremental backup on any journaled file systems. Tivoli StorageManager does not use the journaling facility inherent in WindowsNTFS 5 file systems or any other journaled file system.

The journal engine servicerecords changes to an object or itsattributes in a journal database. During a journal-based backup, theclient obtains a list of files that are eligible for backup from thejournal database. Journal-based backup can increase backupperformance because the client does not scan the local file system orcontact the server to determine which files to process. Journal-basedbackup also reduces network traffic between the client and server.

Tivoli Storage Manager filters the list based on the currentinclude-exclude list and processes, expires, and updates the resultingfiles according to policy constraints, such as serialization. You canuse the copy frequency attribute during a traditional full incrementalbackup. However, Tivoli Storage Manager ignores this managementclass attribute during a journal-based backup.

The journal engine service does not record changes in specificsystem files, such as pagefile, registry, etc., in the journal. Therefore,journal-based backup will not back up these files. See the journalservice configuration filetsmjbbd.ini in the Tivoli StorageManager installation directory for excluded system files. See theAppendix inTivoli Storage Manager Installing the Clients,SH26-4119, for more information about the journal serviceconfiguration filetsmjbbd.ini.

To support journal-based backup, you must install the journalingengine service background process as a service on Windows NT and2000 using thedsmcutil command or the client GUI setup wizard.


SeeTivoli Storage Manager Installing the Clients, SH26-4119, formore information about using thedsmcutil command to install thejournal engine service.

To install and configure this service using the client GUI setupwizard, perform the following steps:1. Select theUtilities menu→ Setup Wizard item.2. Select theHelp me configure the TSM Journal Engine

checkbox.3. Follow the instructions on the screen to configure and use the

journal engine.

See “Incremental” on page 356 for more information aboutjournal-based backup.

Notes:

1. The Journal Service is not supported in a Microsoft ClusterServer environment. Only one Journal Service may be installedon a machine and the Journal Service cannot dynamically start orstop monitoring shared disks.

2. When using anti-virus software, there are limitations tojournal-based backup. Refer to theREADME file that is shipped onthe product installation media for more information.

3. Journal-based backup may not fall back to the traditionalincremental backup if the policy domain of your node is changedon the server, depending on when the policy set within thedomain was last updated and the date of the last incremental. Inthis case, you must force a full traditional incremental backup torebind the files to the new domain. Use thenojournal optionwith the incremental command to specify that you want toperform a traditional full incremental backup, instead of thedefault journal-based backup.

Partial Incremental BackupA partial incremental backs up new and changed files but does notexpire or rebind files on the server. The frequency attribute of thecopy group is also ignored. There are two types of partialincremental backup:


3.B

ackingU

pand

Restoring

¶ Incremental-by-date– On the backup window, select theIncremental (date only)option from thetype of backuppull-down menu, or use theincrbydateoption with theincremental command. Tivoli Storage Manager backs up onlynew and changed files with a modification date later than thedate of the last incremental backup stored at the server, unlessyou exclude the file from backup services.

Files added at the client after the last incremental backup, butwith a modification date earlier than the last incremental, are notbacked up. Tivoli Storage Manager does not back up changes toNTFS security information on Windows NT clients because thechanges do not alter the last changed date and time.

Incremental-by-date updates the date and time of the lastincremental at the server. If you perform an incremental-by-dateon only part of a file system, the date of the last full incrementalis not updated. The next incremental-by-date will back up thesefiles again.

¶ Incremental backup of selected files and directories– Backs up asingle file, a group of files, or directories that you specify. Use aselective backup when you want to back up only a specificsubset of files.

To perform a selective backup using the client GUI, see“Performing a GUI Backup” on page 47 for more information.

Use theselectivecommand to perform a selective backup fromthe client command line. See “Selective” on page 438 for moreinformation.

Tivoli Storage Manager backs up files if their size, permissions,modification date, or other attributes change. The server does notupdate the date and time of the last incremental.

Full Incremental versus Partial Incremental BackupBoth full and partial incrementals back up new and changed files.An incremental-by-date takes less time to process than a fullincremental and requires less memory. A full incremental withjournaling active takes less time to process than an


incremental-by-date. Unlike a full incremental, anincremental-by-date does not maintain current server storage ofallyour workstation files because:¶ It does not expire backup versions of files that you delete from

the workstation.¶ It does not rebind backup versions to a new management class if

you change the management class.¶ It does not back up files with attributes that change, unless the

modification dates and times also change.¶ It ignores the copy group frequency attribute of management

classes.

You can maintain current server storage of your workstation files byperforming a partial incremental backup on weekdays and a fullincremental backup on weekends.

Pre-Backup ConsiderationsBeginning with Tivoli Storage Manager Version 4.2, the WindowsNT and Windows 2000 clients are Unicode enabled. New clientsstoring data on the server for the first time require no special set up.The server automatically stores files and directories as Unicodeenabled. However, if your client already stores data on the serverand you upgrade to the Windows NT, 2000 Version 4.2 client, youneed to plan for the migration of files spaces to Unicode. Formigration information, see “Migrating to the Unicode-EnabledClient” on page 3.

This involves renaming your file spaces on the server and creatingnew Unicode-enabled file spaces on the server using theautofsrenameoption. For detailed information about this option, see“Autofsrename” on page 148.

For additional information about working with Unicode-enabled filespaces, see the following references:¶ “Considerations for Windows NT, 2000 Unicode-Enabled

Clients” on page 112¶ “Detail” on page 279¶ “Query Filespace” on page 382¶ “Restore” on page 398


3.B

ackingU

pand

Restoring

¶ “Retrieve” on page 430

Configure Memory-Constrained Workstations to RunIncremental Backups

Incremental backup performance suffers if the workstation has a lowamount of memory available prior to starting the backup. If yourworkstation isnot memory constrained, specify thememoryefficientbackupNo option in your client options filedsm.opt to provide the best performance.

If your workstationis memory constrained, specify thememoryefficientbackupYesoption in your options file. SpecifyingYesreduces memory consumption but increases backup time. Whenyou specifyYes, Tivoli Storage Manager backs up only one directoryat a time. If performance remains poor, check your communicationbuffer settings and the communication link between your workstationand the server.

Performing a Backup with Limited BandwidthIf you plan to perform a backup over a network device that haslimited bandwidth, such as a modem, you can help reduce networktraffic by usingadaptive subfile backup. Adaptive subfile backuprequires a version 4 server. Reducing traffic can also increase thespeed of your backup. An adaptive subfile backup sends onlychanged portions of a file to the server during successive backupoperations.

Perform the following steps to use adaptive subfile backup.

1. Ensure that the server allows this type of backup. Check withyour system administrator.

2. Set thesubfilebackup, subfilecachepathandsubfilecachesizeoptions in your client options filedsm.opt. For more informationon adaptive subfile backup options, see:¶ “Subfilebackup” on page 245¶ “Subfilecachepath” on page 246¶ “Subfilecachesize” on page 247


3. Add anexclude.diroption to your client options file, whichexcludes the directory containing the subfile cache information.See “Exclude Options” on page 177 for more information.

When you are ready to back up changes, adaptive subfile backupwill occur as part of incremental and selective backups.

Adaptive subfile backups can significantly reduce the amount of dataexchanged between client and server. For example, suppose while atyour work location you back up a two megabyte report. Then, whiletraveling, you change the report and want to send only the changesback to the server at your work location. To accomplish this, youwould simply connect to a modem and use adaptive subfile backup.

Remember that you must perform the original backup with subfilebackup enabled so that the base file will be stored in the cache.

You can restore an adaptive subfile backup using therestorecommand. The server restores the base file and the changed (delta)subfile.

Using an Include-Exclude List to Control ProcessingUsually, there are files on your disk that you do not want to back up.These files might be operating system or application files that youcan easily recover by reinstalling the program, or any other file thatyou can easily rebuild.

Use theinclude andexcludeoptions in the client options filedsm.opt to define which files to exclude from backup processing.Tivoli Storage Manager uses the include-exclude list duringincremental and selective backups. Tivoli Storage Manager backs upany file that is not explicitly excluded. It is not necessary to use aninclude option to include specific files, unless those files are in adirectory that you are trying to exclude.

The include-exclude list may contain items specified by the server.To view the contents of your include-exclude list, use thequeryinclexcl command.


3.B

ackingU

pand

Restoring

For more information about setting up an include-exclude list, see“Creating an Include-Exclude List” on page 111.

You can encrypt the data that is sent to the server during a backupor archive operation using standard DES 56-bit encryption. Files areselected for encryption usinginclude.encryptandexclude.encryptprocessing. By default, files are not encrypted unless they areexplicitly included using theinclude.encryptoption. For moreinformation about theinclude.encryptoption, see “Include Options”on page 189. For more information about theexclude.encryptoption, see “Exclude Options” on page 177.

To encrypt file data, you must select an encryption key password,which Tivoli Storage Manager uses to generate the encryption keyfor encrypting and decrypting the file data. Store the encryption keypassword for later use. You can specify whether to save theencryption key password in the Registry by using theencryptkeyoption.

While restoring an encrypted file, Tivoli Storage Manager willprompt you for the key password to decrypt the file in the followingcases:¶ If the encryptkeyoption is set toPrompt.¶ If the key supplied by the user in the above case does not match.¶ If the encryptkeyoption is set toSave and the local key

available does not match.

For more information about this option, see “Encryptkey” onpage 173.

See “Backup: Additional Considerations” on page 55 for additionalinformation to consider when performing a backup. You do not needto understand this information to perform basic backups.

Estimating Backup Processing TimeThe Tivoli Storage ManagerBackup andRestorewindows providean estimatefunction that estimates the amount of time required toprocess your files and directories. The estimated transfer is a roughcalculation of the time it takes to transfer your data. This estimate isbased on previous transfers of data between your workstation and the


current Tivoli Storage Manager server. The actual transfer time couldbe longer or shorter than the estimate due to factors like networktraffic, system load on your workstation, or system load on theserver.

The Estimated Transfer Time is based on previous backup transferrate, so you must run at least one backup operation first. TheEstimated Transfer Time field reads N/A if no files are sent to orfrom the current Tivoli Storage Manager server. The estimatefunction also does not take into account whether or not files areexcluded from backup. The assumption made by the estimationalgorithm is that all the files selected will be sent to the server.

Note: During installation, Tivoli Storage Manager creates thedsm.ini file to record statistics from the backup-archive clientestimate function. This file resides in the client directory.

Performing a GUI BackupYou can use Tivoli Storage Manager to back up specific files, agroup of files with similar names, or entire directories. You canlocate the files you want to back up by searching or filtering.Filtering displays only the files that match the filter criteria for yourbackup. Files that do not match the filter criteria do not display.

To perform a GUI backup, use the following steps:

1. Click Backup from the GUI main window. The Backup windowappears.

2. Expand the directory tree by clicking the plus sign+ or thefolder icon next to an object in the tree. To search or filter files,click the Search icon from the tool bar.To search:a. Enter your search criteria in the Find Files (Backup) window.b. Click Search. The Matching Files (Backup) window appears.c. Click the selection boxes next to the files you want to restore

and close the Matching Files (Backup) window.To filter:1) Enter your filter criteria in the Find Files (Backup) window.2) Click Filter . The Backup window displays the filtered files.


3.B

ackingU

pand

Restoring

3) Click the selection boxes next to the filtered files ordirectories you want to restore.

3. Click the selection box for the object(s) you want to back up.SelectFile details on theView menu to view file attributes forany highlighted file.

4. Select the type of backup from the pull down menu:a. To run an incremental backup, clickIncremental (complete).b. To run an incremental backup by date, clickIncremental

(date only).c. To run a selective backup, clickAlways backup.

5. To modify specific backup options, click theOverride BackupOptions button located to the right of theEstimate button. Anyoptions you change are effective during the current sessiononly.To estimate the transfer time for your backup selections click theEstimate button.

6. Click Backup. The Backup Task List window displays thebackup processing status. When processing completes, theBackup Report window displays processing details.

To perform subsequent incremental backups, you can selectActions→Backup Domain from the Tivoli Storage Manager main window.

Specifying Drives in Your DomainWhen you start Tivoli Storage Manager, it sets your default domainto the drives you specify with thedomain option in thedsm.opt file(see “Domain” on page 166). If you do not set thedomain option,the default domain is all local fixed drives (the drives in yourworkstation).

Tivoli Storage Manager automatically selects your default domain asthe drive or drives that you want to process. You can specifyadditional drives. For example, if your default domain containsdrivesc: andd:, and you want to back up those drives as well as thediskette in drivea:, enter:

dsmc incremental -domain="a:"


You can also use theBackup Domain function in the GUI toperform these backup functions.

Backing Up System ObjectsCertain Windows NT and Windows 2000 system objects must bebacked up together in order to create a consistent system state. Youmust be using a server that is Version 3.7.3 or higher. Servers at thislevel support the file grouping required to back up system objects.Objects can be backed up in any order.

System objects which must be backed up together include thefollowing:¶ Active Directory (domain controller only)¶ Certificate server database¶ Cluster Database (cluster node only)¶ COM+ database¶ Registry¶ System and boot files¶ System volume

Other system objects can be backed up individually. These includethe following:¶ Event logs (system, security and application)¶ Removable Storage Management Database (RSM)¶ Replicated file systems (FRS)

To back up system objects using the GUI, select the desired entriesunder the system objects tree view of the backup window.


Performing a Command Line BackupYou can use theincremental or selectivecommands to performbackups. For information on the commands to use for backing upsystem objects, see “Using Commands” on page 311.


3.B

ackingU

pand

Restoring

Performing Incremental BackupsSee “Full Incremental Backup” on page 38 for detailed informationabout incremental backups.

To back up the c: drive, for example, enter:dsmc incremental c:

Use theincrbydateoption with theincremental command to run anincremental backup by date, by entering:

dsmc incremental -incrbydate

Note: If you perform an incremental backup on a domain containingthe system drive or on the system drive itself, the Windowsregistry will also be backed up.

Performing Selective BackupsYou can back up specific files, a group of files with similar names,or empty directories and their attributes. This is called aselectivebackup. You can use wildcards to back up more than one file at atime.

You can select the files you want to back up by specifying the path,name, and extension of the file.

If you back up a directory, use thesubdir=yesoption to include allthe subdirectories under that directory in the backup. For example, toback up thed:\proj directory and its subdirectories, enter:dsmc selective d:\proj\ -subdir=yes

To back up files under theproj directory, enter:dsmc selective d:\proj\

You can enter up to 20 file names on theselectivecommand byentering a space between each file name. For example, to back upthe d:\h1.doc andd:\test.doc files, enter:

dsmc selective d:\h1.doc d:\test.doc


If you want to specify more than 20 file names, you can use thefilelist option. See “Filelist” on page 281 for more information aboutthis option.

When you run a selective backup, Tivoli Storage Manager also backsup the file attributes, directory information, and last changed date.This information is restored when you restore the file. You canexclude the files within a directory, and you can exclude an emptydirectory from backup. Directories are counted in the number of filesbacked up.

When you request a selective backup, Tivoli Storage Manager backsup a file if all of the following requirements are met:

¶ The file is not excluded in your include-exclude list. If you donot have an include-exclude list, all files will process.

¶ The selected management class contains a backup copy group.

¶ The file meets the serialization requirements defined in thebackup copy group. If serialization isstatic or shared static, andthe file is in use during backup, the backup does not occur.

See “Selective” on page 438 for more information about theselectivecommand.


Displaying Backup Processing StatusDuring an incremental backup, Tivoli Storage Manager displays thestatus of each file it attempts to back up. Tivoli Storage Managerreports the file’s size, volume, path, file name, and whether thebackup attempt was successful. Similar statistics are produced by theselectiveandarchive commands. These also display in the schedulelog for scheduled commands.

When Tivoli Storage Manager backs up a volume or other set offiles, it attempts to improve performance and load balancing by


3.B

ackingU

pand

Restoring

using multiple sessions. This can result in as many as five sessionsrunning at one time to read files and send them to a server.

The Web client and backup-archive client GUI provide aTask Listwindow that displays information about files during processing.When a task completes, aBackup Report window displaysprocessing details. Click theHelp button in the Backup Reportwindow for context help.

The command line displays similar information. On thebackup-archive command line the name of each file displays after itis sent to the server. The progress indicator shows overall progress.Informational messages may display as follows:

¶ Directory-->. Indicates the directory that you back up.

¶ Updating-->. Indicates that only the file meta data is sent, iffile attributes change and not the data itself.

¶ Expiring-->. Indicates an object (file or directory) on the serverthat no longer exists on the client is expired, or made inactive.

¶ Total number of objects inspected. When usingjournal-based backup, the number of objects inspected may beless than the number of objects backed up.

¶ Total number of objects backed up.

¶ Total number of objects updated. These are files whoseattributes, such as file owner or file permissions, have changed.

¶ Total number of objects rebound. See “Binding andRebinding Management Classes to Files” on page 108 for moreinformation.

¶ Total number of objects deleted. This is a count of theobjects deleted from the client workstation after beingsuccessfully archived to the server. The count is zero for allcommands, except when using thearchive command with thedeletefilesoption.

¶ Total number of objects expired. See “Full IncrementalBackup” on page 38 for more information.


¶ Total number of objects failed. Objects can fail forseveral reasons. Check thedsmerror.log for details.

¶ Data transfer time. The total time to transfer data across thenetwork. Transfer statistics may not match the file statistics ifthe operation was retried due to a communications failure orsession loss. The transfer statistics display the bytes attempted tobe transferred across all command attempts.

¶ Network data transfer rate. The average rate at which thenetwork transfers data between the client and the server. This iscalculated by dividing the total number of bytes transferred bythe time to transfer the data over the network. The time it takesto process objects is not included in the network transfer rate.Therefore, the network transfer rate is higher than the aggregatetransfer rate.

¶ Aggregate data transfer rate. The average rate at whichTivoli Storage Manager and the network transfer data betweenthe client and the server. This is calculated by dividing the totalnumber of bytes transferred by the time that elapses from thebeginning to the end of the process. Both Tivoli StorageManager processing and network time are included in theaggregate transfer rate. Therefore, the aggregate transfer rate islower than the network transfer rate.

Note: On occasion, the aggregate data transfer rate may behigher than the network data transfer rate. This is becausethe backup-archive client has multithreading capabilities.When multiple threads run during backup, the datatransfer time represents the sum time from all threadsrunning. In this case, aggregate data transfer time ismistakenly reported as higher. However, when running asingle thread, the aggregate data transfer rate shouldalways be reported as lower than the network datatransfer rate.

¶ Objects compressed by. Specifies the number of file-databytes sent over the net divided by the original size of the file on


3.B

ackingU

pand

Restoring

disk. For example, if the net data-bytes are 10K and the file is100K, then Objects compressed by: == (1 - (10000/100000)) x100 == 90%

¶ Elapsed processing time. The active processing time tocomplete a command. This is calculated by subtracting thestarting time of a command process from the ending time of thecompleted command process.

LAN-Free Data MovementTivoli Storage Manager Version 4.2 Windows NT and Windows2000 clients support LAN-free data movement, which shifts themovement of client data from the communications network to astorage area network (SAN). Shifting the client data movement fromthe communications network to a SAN decreases the load on theTivoli Storage Manager server. This allows the server to support agreater number of simultaneous client connections.

The SAN provides a path that allows you to backup, restore, archive,and retrieve data to and from a SAN-attached storage device. Clientdata moves over the SAN to the storage device via the TivoliStorage Manager Storage Agent. The Tivoli Storage ManagerStorage Agent must be installed on the same system as the client.

LAN-Free PrerequisitesTo enable LAN-Free support, you must install and configure theTivoli Storage Manager Managed System for SAN feature on theclient workstation. For more information, see theTivoli StorageManager for Windows Managed System for SAN Storage AgentUser’s Guidelisted in “Related Publications” on page xxxi.

LAN-Free OptionsAfter installing and configuring the Tivoli Storage ManagerManaged System for SAN feature on the client workstation, you canuse the following options to enable LAN-Free data movement:

enablelanfreeSpecifies whether to enable an available LAN-free path toSAN-attached storage device. See “Enablelanfree” onpage 171 for more information.


lanfreecommmethodSpecifies a communication protocol between the client andthe Storage Agent. See “Lanfreecommmethod” on page 197for more information.

lanfreetcpportSpecifies the TCP/IP port number where the Storage Agent islistening. See “Lanfreetcpport” on page 198 for moreinformation.

Backing Up NAS File SystemsTivoli Storage Manager supports backup and restore of networkattached storage (NAS) file system images to tape drives or librariesthat are locally attached to NAS file servers. Tivoli Data Protectionfor NDMP enables backup and restore support on the Tivoli StorageManager Windows NT and Windows 2000 servers for NAS fileservers from Network Appliance.Tivoli Data Protection for NDMPis a separately priced and licensed product.See “Backing Up NASFile Systems” on page 445 for more information.

Backup: Additional ConsiderationsThis section discusses additional information to consider whenperforming a backup. You do not need to understand this informationto perform basic backups.

Backing Up Open FilesSome files on your system might be in use when you try to backthem up. These are calledopen filesbecause they are opened by anapplication for its use. Because an open file can change, any backupof that file will not correctly reflect its contents at a given time.

If certain files are not backed up because they are open and theychange when you try to back them up or when the backup schedulestarts, consider the following points:

¶ If the file is unimportant or can be easily rebuilt (a temporaryfile for example), you might not care that the file is not backedup.

¶ If the file is important:


3.B

ackingU

pand

Restoring

v Ensure the file is closed before backing it up. If backups arerun according to a schedule, use thepreschedulecmdoptionto enter a command that closes the file. For example, if theopen file is a database, issue a command to close thedatabase, such as thequiescecommand. You can use thepostschedulecmdoption to restart the application that usesthe file after the backup completes. If you are not using aschedule for the backup, close the application that uses thefile before you start the backup.

v Tivoli Storage Manager can back up the file even if it is openand changes during the backup. This is only useful if the filewill be usable even if it changes during backup. To back upthese files, assign a management class withdynamic orshared dynamicserialization. See “Selecting a ManagementClass for Files” on page 105 for information about assigningmanagement classes, and see “Displaying Information aboutManagement Classes and Copy Groups” on page 100 forinformation to determine which management classes areavailable to you.

Backing Up Removable Media Using LabelsTivoli Storage Manager backs up your removable media (such astapes, cartridges or diskettes) based on the drive label, not the driveletter. If a drive has no label, the backup does not occur. This use ofdrive labels permits you to perform such tasks as backing updifferent diskettes from thea: drive.

For a restore or retrieve, Tivoli Storage Manager maintains aseparate file space for each drive label. These labels become the filespace names on the server. If you change the label of a drive youalready backed up, Tivoli Storage Manager views it as a new driveand does not relate it to your previous drive.

Because Tivoli Storage Manager uses the labels to manage backupsand archives of your removable media, you occasionally need to usethose labels to locate data when using commands. For example, ifyou try to restore a file on diskette or CD–ROM usingd:\projx\file.exe as a file name, Tivoli Storage Managersubstitutes the current label of yourd: drive for thed:. If the d:


drive label is d-disk,d:\projx\file.exe becomes{d–disk}\projx\file.exe, and the label is enclosed in braces.

If the label of thed: drive does not match a file space name on theserver, Tivoli Storage Manager cannot find your files. A mismatchbetween a label and a file space name might occur if you label yourdrives again, or if you access Tivoli Storage Manager from adifferent workstation than the one from which you backed up thefiles. If you have not relabeled the drive, and you are at the sameworkstation where the file was backed up, then you can use thedrive letter as a shorthand version of the file space name (drivelabel).

Backing Up Fixed DrivesTivoli Storage Manager can back up your fixed drives even if theydo not have a label, including drive aliases created with the DOSsubst command. This applies to both the drive alias and theunderlying physical drive, because the alias name and the physicaldrive label are the same.

Backing Up NTFS File SpacesWhen you back up Windows NT files on NTFS partitions, TivoliStorage Manager also backs up file security information and thesefile descriptors:¶ Owner security information (SID)¶ Primary group SID¶ Discretionary access control list (permissions)¶ System access control list (auditing information)

You must specify a mixed or lowercase NTFS file space nameenclosed in quotes and braces. For example,{"NTFSDrive"}. Singlequotes or double quotes are valid in loop mode. For example:{"NTFSDrive"} and{'NTFSDrive'} are both valid. In batch mode,only single quotes are valid. The single quotes requirement is arestriction of the operating system.

Using Universal Naming Convention NamesA Universal Naming Convention (UNC) name is a network resourcename for a share point on a workstation. The resource name includes


3.B

ackingU

pand

Restoring

the workstation name assigned to the workstation and a name youassign to a drive or directory so that it can be shared. The name youassign is also called ashare point name.

Using UNC Names in Domain ListsThe following rules apply when using UNC names to specify adomain list. You must specify:¶ A drive letter for removable media¶ Drive letters or UNC name for local fixed drives¶ Drive letters or UNC names for remote mapped drives¶ UNC names for remote unmapped drives

Example 1: To specify drivea: containing removable media, enterdomain a: \\local\c$

Example 2: To specify fixed drivec:, enterdomain c: \\remote\share1 \\remote\c$

Backing Up Specific Files Using the Universal NamingConvention

You can back up shared files in a network through the use of a UNCname. A UNC name is a network resource name for a share point ona workstation. The resource name includes the workstation nameassigned to the workstation and a name you assign to a drive ordirectory so that it can be shared. The name you assign is also calleda share point name.

Using a UNC name permits you to back up specific shareddirectories to a separate file space. This is useful if, for example,you or an administrator want to back up a small portion of data thatyou would otherwise be unable to access. Drives are not backed upto a separate file space.

On Windows NT and Windows 2000, every local drive is accessiblevia a UNC name except for drives containing removable media (suchas tapes, cartridges or diskettes). Access these drives by using apredefined administrative share name consisting of the workstationname and the local drive letter, followed by $. For example, tospecify a UNC name on drivec: for workstationocean, enter:


\\ocean\c$

The $ signmustbe included with the drive letter.

To enter a UNC name for workstationocean and share pointwave,enter:\\ocean\wave

When accessing files, you do not need to enter the letter of the driveexcept for drives containing removable media.

See Table 5 for examples showing selective backup of files usingUNC names. In these examples, assume that:¶ The workstation runningdsmc is major.¶ Share namesbetarc andtestdir from workstationalpha1 are

mapped to drivesr and t, respectively.

Table 5. UNC examplesExample Comment

dsmc sel \\alpha1\c$\ name of remote file space is\\alpha1\c$

dsmc sel \\major\c$\ name of local, fixed file space is\\major\c$

dsmc sel a:\ name of local, removable file spaceis volume label ofa:

dsmc sel \\alpha1\betarc\ name of remote file space is\\alpha1\betarc

dsmc sel \\alpha1\testdir\ name of remote file space is\\alpha1\testdir

dsmc sel d:\ name of local, fixed file space is\\major\d$

dsmc sel c:\ file space name is \\major\c$

dsmc sel r:\ file space name is \\alpha1\betarc

You can also specify UNC names for files in your include-excludeand domain lists; see “Creating an Include-Exclude List” on page 111and “Domain” on page 166 for more information.


3.B

ackingU

pand

Restoring

Backing Up Microsoft Dfs FilesNote: This feature applies to Windows 2000 with NTFS file systemsonly.

If your organization uses the Microsoft Distributed File System (Dfs)server component for Windows 2000, you can back up and archiveall your Microsoft Dfs files as a single file system, even if the filesare on different servers and share points. Files contained on a Dfsserver component are accessed using a standard UNC name, forexample:\\servername\dfsroot\

whereservernameis the name of the host computer anddfsroot isthe name of the root file system.

If your organization uses the Microsoft directory services feature ofDfs, you can access a file system through either its fault tolerantdomain name or its server name, for example:\\default tolerant name\dfsroot\

wheredefault tolerant nameis a name your administrator hasdesignated to specify a Microsoft Dfs server component stored indirectory services, anddfsroot is the name of the root file system.

By default, an incremental backup of a DFS root does not traversethe Dfs junctions. Only the junction metadata is backed up.

You can use thedfsbackupmntpntoption to specify whether TivoliStorage Manager sees a Dfs mount point as a Microsoft Dfs junctionor as a directory. For more information on using this option, see“Dfsbackupmntpnt” on page 163.

To restore Dfs junctions and the data for each junction, restore theDfs junction metadata first and then restore each junction separately.If the junction metadata is not restored, Tivoli Storage Managercreates a directory under the Dfs root using the same name as that ofthe junction point and restores the data in that directory.


Restoring Files and DirectoriesTivoli Storage Manager uses the methods described in this section torestore backup versions of specific files, a group of files with similarnames, or entire directories.

If parent directories exist above the subdirectory branch and theparent directories do not exist at the target of the restore, then theparent directories are created but their permissions are not restored.This only applies to directories; attributes/permissions for files arealways restored. For example, if you have a backup of the followingdirectory structure:

aa\ba\b\ca\b\d

and, if you want to restore subdirectory branchb, anda does notexist, thena is created with default permissions restored. TivoliStorage Manager will restore permissions for subdirectoriesb, c, andd.

Duplicate File NamesIf you attempt to restore or retrieve a file whose name is the same asan existing file’s short name, a file name collision will occur(existence of duplicate file names). An example is when the fileabcdefghijk.dochas a short name ofabcdef1̃.doc, and you attemptto restore or retrieve a file explicitly namedabcdef1̃.doc into thesame directory. In this case, a collision will occur because the nameof the file you are restoring conflicts with the short name forabcdefghijk.doc. Tivoli Storage Manager handles this situation basedon the value of thereplaceoption.

A collision can occur even if the files are restored or retrieved to anempty directory. For example, filesabcdef1̃.docandabcdefghijk.docmay originally have existed in the directory asabcdefghijk.docandabcdef2̃.doc. During the restore, ifabcdefghijk.doc is restored first,it is assigned a short name ofabcdef1̃.docby the Windowsoperating system. When you restoreabcdef1̃.doc, the duplicate filename situation occurs.


3.B

ackingU

pand

Restoring

If a file name collision occurs, you can do any of the following:¶ Restore or retrieve the file with the short file name to a different

location.¶ Stop the restore or retrieve and change the name of the existing

file.¶ Disable short file name support on Windows.¶ Do not use file names, such asabcdef1̃.doc, that would conflict

with the short file naming convention.

Restoring Files Using Universal Naming ConventionNames

Using a UNC name permits you to restore specific shared files to aseparate file space. This is useful if, for example, you or anadministrator want to restore a portion of data that you wouldotherwise be unable to access.

Except for drives with removable media, every local drive letter isaccessible using a local UNC name that includes the workstationname and a designation for the drive letter. For example, to enter aUNC name on drivec: for workstationocean, enter:\\ocean\c$

The $ signmustbe included with the drive letter.

To enter a UNC name for workstationocean and share pointwave,enter:\\ocean\wave

When accessing files, you do not need to enter the letter of the driveexceptfor drives with removable media.

Do You Want To Restore an Active or InactiveBackup?

Your administrator determines how many backup versions TivoliStorage Manager maintains for each file on your workstation.Having multiple versions of a file permits you to restore olderversions if the most recent backup is damaged. The most recentbackup version is theactiveversion. Any other backup version is aninactiveversion. To restore a backup version that is inactive, you


must display both active and inactive versions by clicking on theView menu→ Display active/inactive filesitem. To display only theactive versions (the default), click on theView menu→ Displayactive/inactive files item again. If you try to restore both an activeand inactive version of a file at the same time, only the activeversion is restored.

Performing a GUI RestoreYou can restore specific files, a group of files with similar names, ordirectories. You can locate the files you want to restore by searchingand filtering. Filtering displays only the files that match the filtercriteria for your restore operation. Files that do not match the filtercriteria do not display. The filter process searches files in thespecified directory but does not include subdirectories.

To restore files or directories, perform the following steps:

1. Click Restoreon the main window. The Restore windowappears.

2. Expand the directory tree by clicking the plus (+) sign or thefolder icon next to an object in the tree. Select the object thatyou want to restore. To search or filter files, click theSearchicon from the tool bar.To search:a. Enter your search criteria in the Find Files (Restore) window.b. Click Search. The Matching Files (Restore) window appears.c. Click the selection boxes next to the files you want to restore

and close the Matching Files (Restore) window.To filter:1) Enter your filter criteria in the Find Files (Restore) window.2) Click Filter . The Restore window displays the filtered files.3) Click the selection boxes next to the filtered files or

directories you want to restore.

3. To modify specific restore options, click theRestore Optionsbutton located to the right of theEstimate button. Any optionsyou change are effective during the current sessiononly. Toestimate the transfer time for your backup selections click theEstimate button.


3.B

ackingU

pand

Restoring

4. Click Restore. The Restore Destination window appears. Enterthe appropriate information.

5. Click Restore. The Restore Task List window displays theprocessing status.

Restoring System ObjectsCertain Windows NT and Windows 2000 system objects must berestored together in order to create a consistent system state. It isrecommended that you restore boot files first and commit the systemhive of the registry last.

The following system objects should be restored together:¶ Active Directory (domain controller only)¶ Certificate server database¶ Cluster database (cluster node only)¶ COM+ database¶ Registry¶ System and boot files¶ System volume

Other system objects can be restored individually. These include thefollowing:¶ Event logs (system, security and application)¶ Removable Storage Management Database (RSM)¶ Replicated file systems

To restore system objects using the GUI, selectSystem Objects→system object namefrom the Restore menu and follow the prompts.

Performing a Command Line RestoreYou can use therestore command to restore files. For informationon the commands for restoring system objects, see “UsingCommands” on page 311.

You must specify the files you want to restore and where you wantto restore them. If you do not specify a destination, the files arerestored to their original location. For example, to restore thec:\doc\h2.doc file to its original directory, enter:

dsmc restore c:\doc\h2.doc


To restore it under a new name, enter:dsmc restore c:\doc\h2.doc c:\doc\h3.doc

For the purposes of this manual, the workstation name is part of thefile name. Therefore, if you back up files on one workstation andyou want to restore them to another workstation, you must specify adestination. This is true even if you are restoring to the samephysical workstation, but the workstation has a new name. Forexample, to restore thec:\doc\h2.doc file to its original directoryon the workstation, namedstar, enter:

dsmc restore c:\doc\h2.doc \\star\c$\

To restore the file tostar which has now been renamedmeteor,enter:

dsmc restore \\star\c$\doc\h2.doc \\meteor\c$\

You could also enter:dsmc restore c:\doc\h2.doc \\meteor\c$\

This example is valid because if the workstation name is notincluded in the specification, the local workstation is assumed(meteor, in this case).

If the file you are restoring no longer resides on your workstation,and you have run an incremental backup since deleting the file, thereis no active backup of the file on the server. In this case, use thelatestoption to restore the most recent backup version. If you do notwant the most recent version, use thepick and inactive options toobtain a list of backups from which you can pick. For example, ifyou want to restore the latest version of the deleted filec:\doc\h2.doc, enter:

dsmc restore c:\doc\h2.doc -latest

If you are restoring a file to a disk with a different label than thedisk from which the file was backed up, you must use the file spacename (label) of the backup disk instead of the drive letter. Forexample, if you backed up a file from thea: drive from the disketteworkathome, and you are restoring it to a diskette in thea: drivelabeledextra, enter:


3.B

ackingU

pand

Restoring

dsmc restore {workathome}\doc\h2.doc a:\doc\h2.doc

Add the -subdir=yes option to the command if you need to restorethe files in a directory and all of its subdirectories. For example, ifyou are recovering an entire disk (thee: disk in this example) andrestoring all the files, enter:

restore e:\ -subdir=yes

Note: You must use this option to restore directoryattributes/permissions.

See “Restore” on page 398 for more information.

Performing Large Restore OperationsWith Windows NT, if you need to restore a large number of files,you will get faster performance using the command line interfacerather than the GUI interface. In addition, you will improveperformance if you enter multiplerestore commands at one time.For example, to restore all the files in yourc: file space, enter:

dsmc restore c:\* -subdir=yes -replace=all -tapeprompt=no

However, if you enter multiple commands for the root directories inyour c: file space, you can restore the files faster. For example, enterthese commands:

dsmc restore c:\users\ -subdir=yes -replace=all -tapeprompt=nodsmc restore c:\data1\ -subdir=yes -replace=all -tapeprompt=nodsmc restore c:\data2\ -subdir=yes -replace=all -tapeprompt=no

Or, if you need to restore files for multiple drives, enter thesecommands:

dsmc restore c:\* -subdir=yes -replace=all -tapeprompt=nodsmc restore d:\* -subdir=yes -replace=all -tapeprompt=nodsmc restore e:\* -subdir=yes -replace=all -tapeprompt=no

You can also use thequiet option with therestore command to saveprocessing time. However, you will not receive informationalmessages for individual files.


Note: If you already have the appropriate values set for thesubdir,replace, tapeprompt, andquiet options in your client optionsfile, it is not necessary to include these options in thecommands.

When you enter multiple commands to restore your files, you mustspecify a unique part of the file space in eachrestore command. Donot use any overlapping file specifications in the commands.

To display a list of the root directories in a file space, use thequerybackup command. For example:

dsmc query backup -dirsonly -subdir=no c:\

As a general rule, you can enter two to fourrestore commands atone time. The maximum number you can run at one time withoutdegrading performance depends on factors such as networkutilization and how much memory you have. For example, if\usersand \data1 are on the same tape, the restore for\data1 must waituntil the restore for\users is complete. However, if\data2 is on adifferent tape, and there are at least two tape drives available, therestore for\data2 can begin at the same time as the restore for\users.

The speed at which you can restore the files also depends upon howmany tape drives are available and whether your administrator isusing collocation to keep file spaces assigned to as few volumes aspossible. If your administrator is using collocation, the number ofsequential access media mounts required for restore operations isalso reduced.

No Query RestoreWhen you enter an unrestricted wildcard source file specification onthe restore command and do not specify any options:inactive,latest, pick, fromdate, or todate, the client uses a slightly differentmethod for retrieving files and directories from the server. Thismethod is calledno query restorebecause instead of querying theserver for each object to be restored, a single restore request is sentto the server. This request results in files and directories beingreturned directly from the server without further action by the client.


3.B

ackingU

pand

Restoring

The client merely accepts the data coming from the server andrestores it to the destination named on therestore command.

An example of an unrestricted wildcard command would be:c:\mydocs\1999\*

An example of a restricted wildcard command would be:c:\mydocs\1999\sales.*

When the client uses this method, the restore session is treated a bitdifferently. If the restore process is interrupted for any reason, suchas a power outage or network failure, the server records the point atwhich the restore was interrupted. This record is known to the clientas arestartable restore. It is possible to create more than onerestartable restore session. Use thequery restore command to findout if your client has any restartable restore sessions in the serverdatabase.

The existence of a restartable restore inhibits further backups of thatfile system until the restartable restore is completed. If you attemptto repeat the restore that was interrupted or try to back up thedestination file space, the attempt will fail because the originalrestore was not completed. You can restart the restore at the point ofinterruption by entering therestart restore command, or you candelete the restartable restore using thecancel restorecommand. Ifyou restart the interrupted restore, it will restart with the first objectnot completely restored when the interruption occurred.

The differences between the standard restore process and the noquery restore process are outlined below.

Standard Restore Process

1. The client queries the server for a list of files backed up for theclient file space being restored.

2. The server sends a list of backed up files that match the restorecriteria. If both active and inactive files are to be restored,information about all backed up files is sent to the client.


3. The list of files returned from the server is sorted in clientmemory to determine the file restore order and to minimize tapemounts required to perform the restore.

4. The client tells the server to restore file data and directoryobjects.

5. The directories and files to be restored are sent from the serverto the client.

No Query Restore Process

1. The client tells the server that a no query restore is going to beperformed and provides the server with details about file spaces,directories, and files.

2. The server sorts the data using an internal sort table whichminimizes tape mounts.

3. The data to be restored is sent to the client. File and directoryobjects stored on disk are sent immediately since sorting for suchdata is not required before restoring it.

For more information on using the command line to begin restartablerestores, see “Restore” on page 398. For help with performingrestartable restores using a GUI, follow these steps:1. Click Help from the Restore window.2. Click Restoring Backup Versions3. Click Work with restartable restore sessions.

Restoring Data from a Backup SetYour Tivoli Storage Manager administrator can generate a backup set(a collection of your active files that reside on the server) ontoportable media created on a device using a format that is compatiblewith the client device.

Portable media can be used on devices such as a tape, CD-ROM,DVD, and Iomega JAZ or ZIP drives. Current device supportinformation is available at the following Web site:http://www.tivoli.com/support/storage_mgr/tivolimain.html

You can restore backup sets from the following locations:


3.B

ackingU

pand

Restoring

¶ From portable media on a device attached to your clientworkstation

¶ Directly from the server

Backup sets can provide you with instant archive and rapid recoverycapability as described below:

Instant ArchiveThis capability allows you to retain long-term storage ofperiodic backups without requiring that the data be sentagain over the network from client nodes.

Rapid RecoveryWhen you are away from your office without a networkconnection and you lose data, you can restore the data fromthe backup set.

Notes:

1. If you cannot restore a backup set from portable media, checkwith your Tivoli Storage Manager administrator to ensure thatthe portable media was created on a device using a format that iscompatible with your device.

2. There is no support in the Tivoli Storage Manager API for thebackup set format. Therefore, backup set data that was backed upvia the API cannot be restored or used.

3. To enable the GUI client to restore a backup set on an attacheddevice on a Windows NT standalone workstation, withoutrequiring a server connection, use thelocalbackupsetoption. See“Localbackupset” on page 202 for more information.

4. Note that therestore backupsetcommand supports restore oflocal backup sets from local media without using thelocalbackupsetoption.

Restoring an Entire or Partial Backup SetTivoli Storage Manager considers a backup set as one objectcontaining the whole file structure. Files are copied down to the filespace level, and you can perform partial restores. After a backup setis generated, it is not tracked by the Tivoli Storage Manager


database. The media is self-describing and contains all theinformation required to perform a successful restore.

Use the GUI to restore an entire backup setonly. The command linecan be used to restore an entire backup set or individual files withina backup set. See “Restore Backupset” on page 407 for informationon how to use therestore backupsetcommand.

Restoring Backup Sets Using a GUIAttention: Before you begin a restore, be aware that backup setscan contain data for multiple file spaces. If you specify a destinationother than the original location, data fromall file spaces is restoredto the location you specify.

To restore a backup set, perform the following steps:

¶ Click Restore from the main window. The Restore windowappears.

¶ Expand the directory tree by clicking the plus sign (+) or foldericon next to the object you want to restore.

¶ Locate theBackup Setsdirectory tree object and expand it.

v To restore the backup set from a local device, expand theLocal object and specify the local device. (You may need toenter the location of the files.)

v To restore an entire backup set from the server, expand theServer object and select the checkbox next to the desiredbackupset name.

¶ Click Restore. The Restore Destination window appears. Enterthe appropriate information.

Note: If the object you want to restore is part of a backup setgenerated on a node, and the node name is changed on theserver, any backup set objects that were generated prior to thename change will not match the new node name. Ensure that thenode name is the same as the node for which the backup set wasgenerated.


3.B

ackingU

pand

Restoring

¶ Click on Restore. The Task List window displays the restoreprocessing status.

Note: To enable the GUI client to restore a backup set on anattached device on a Windows NT standalone workstation, withoutrequiring a server connection, use thelocalbackupsetoption. See“Localbackupset” on page 202 for more information. Therestorebackupsetcommand supports restore of local backup sets from localmedia without using thelocalbackupsetoption.

Performing Point-in-Time RestoresUse apoint-in-timerestore to restore files to the state that existed ata specific date and time. A point-in-time restore can eliminate theeffect of data corruption, or recover a basic configuration to a priorcondition.

You can perform a point-in-time restore of a file space, directory, orfile.

Perform incremental backups to support a point-in-time restore.During an incremental backup, the client notifies the server whenfiles are deleted from a client file space or directory. Selective andincremental-by-date backups do not notify the server about deletedfiles. Run incremental backups at a frequency consistent withpossible restore requirements.

If you request a point-in-time restore with a date and time that isprior to the oldest version maintained by the Tivoli Storage Managerserver, the object is not restored to your system. Only an active copyof the object that exists prior to but not after the point-in-time date isrestored to the system.

Notes:

1. Your administrator must define copy group settings that maintainenough inactive versions of a file to guarantee that you canrestore that file to a specific date and time. If enough versionsare not maintained, Tivoli Storage Manager may not be able torestore all objects to the point-in-time you specify.


2. If you erase the file or directory, the next time you run anincremental backup, the active backup version becomes inactiveand the oldest versions are erased that exceed the numberspecified by theversions data deletedattribute of themanagement class. See “Understanding Storage ManagementPolicies” on page 97 for more information about theversionsdata deletedattribute.

When performing a point-in-time restore, consider the following:

¶ Tivoli Storage Manager restores file versions from the mostrecent backup before the specified point-in-time date. Ensure thepoint- in-time that you specify is not the same as the date andtime this backup was performed.

¶ If the date and time you specify for the object you are trying torestore is earlier than the oldest version that exists on the server,Tivoli Storage Manager cannot to restore that object.

¶ Point-in-time restore will restore files deleted from the clientworkstation after the point-in-time date but not files deletedbefore this date.

¶ Tivoli Storage Manager cannot restore a file created after thepoint-in-time date and time. When a point-in-time restore runs,files that were created on the client after the point-in-time dateare not deleted.

To perform a point-in-time restore from the GUI client, use thefollowing steps:

1. Click theRestorebutton in the main window. The Restorewindow displays.

2. Click thePoint-in-Time button from the Restore window. ThePoint in Time Restore window displays.

3. Select theUse a Point-in-Time date during restoreselectionbox. Select the date and time and clickOK . The point in timethat you specified appears in the Point in Time display field inthe Restore window.


3.B

ackingU

pand

Restoring

4. Display the objects you want to restore. You can search for anobject by name, filter the directory tree, or work with thedirectories in the directory tree.

5. Click the selection boxes next to the objects you want to restore.

6. Click theRestorebutton. The Restore Destination windowdisplays. Enter the appropriate information.

7. Click theRestorebutton to start the restore. The Restore TaskList window displays the restore processing status.

Note: If there are no backup versions of a directory for thepoint-in-time you specify, files within that directory that exist forthat point-in-time are not restoreable from the GUI. However, youcan restore these files from the command line. To ensure that youcan view and restore all existing files from the GUI during apoint-in-time restore, you must maintain the same number of backupversions for directories as days you are restoring back to.

You can start point-in-time restore from the command-line clientusing thepitdateandpittime options. You can use these options withthe query and restore commands. For example, when you use thepitdateandpittime options with thequery backup command, thedate and time values specified in the pitdate and pittime parametersestablish the point-in-time for which file information is returned.When you usepitdateandpittime with the restore command, thedate and time values you specify establish the point-in-time forwhich files are returned. If you specify pitdate without a pittimevalue, pittime defaults to 23:59:59. If you specify pittime without apitdate value, it is ignored.

Restore: Additional ConsiderationsThis section discusses additional considerations for restoring data.You do not need to understand this information to use Tivoli StorageManager for basic work.


Authorizing Another User to Restore or Retrieve YourFiles

You can authorize a user on another node to restore your backupversions or retrieve your archive copies. This lets you share fileswith other people or with other workstations that you use with adifferent node name. To authorize another node to restore or retrieveyour files:

1. Click Utilities from the main window.

2. Click User access list. The User Access List window appears.

3. Enter the name of the node, directory, and file specification inthe User Access List window for which you want the user tohave access, along with either the drive letter or drive label onwhich the files reside. You must provide a file specification thatmatches data that has already been stored on the server. You cangive the node access to either backups or archives. You must addseparate authorizations for backup and archive access, even ifyou want to give the same node access to the same files for both.Use an asterisk (*) for the node name to authorize all users.

4. Click Add to add the user.

5. Click OK from the User Access List window to add the node tothe authorization list. The node is not added until you do this.While you are in the User Access List window, you can addseveral nodes at once, delete nodes, or change your existingauthorizations. All additions, deletions, and changes areprocessed when you clickOK . If you make a mistake, clickCancel to leave the User Access List and start again.

The node you are authorizing must be registered with your TivoliStorage Manager server.

You can also use theset accesscommand to work with your useraccess list. Use thequery accesscommand to display your currentlist anddelete accessto delete users from the list. For moreinformation on these commands, see:¶ “Set Access” on page 441¶ “Query Access” on page 368


3.B

ackingU

pand

Restoring

¶ “Delete Access” on page 348.

Restoring or Retrieving Another User’s FilesAfter users give you access to their files on the server, you canrestore or retrieve those backup versions to your local drives (if theother user has authorized you to do so). To do this:1. Click Utilities from the main window.2. Click Access Another User. The Access Another User window

appears.3. Type the node name of the user’s host machine in the Node

name field. Type the user name in the User name field.4. Click theSet button.

If you are using commands, use thefromnodeoption to indicate thenode. You must also use the file space name, rather than the driveletter, to select the restore-retrieve drive you want to access. Includethe file space name in braces and use it like a drive letter. Forexample, to restore cougar’s files from theprojx directory on thed–disk file space to your ownprojx directory, enter:dsmc restore -fromnode=cougar {d-disk}\projx\* d:\projx\

Use thequery filespacecommand to obtain a list of file spaces. Forexample, to obtain a list of cougar’s file spaces, enter:

dsmc query filespace -fromnode=cougar

For more information about using thefromnodeoption with therestore command, see “Restore” on page 398. See “Retrieve” onpage 430 for theretrieve command. For more information about thefromnodeoption, see “Fromnode” on page 286.

Restoring or Retrieving Your Files to AnotherWorkstation

When you are using a different workstation, you can restore orretrieve files you backed up from your own workstation. Yourbackup versions and archive copies are stored according to yournode, not your specific workstation. Your Tivoli Storage Managerpassword protects your data.


To restore or retrieve files to another workstation, use thenodenameoption to specify the node name of the workstation from which youbacked up the files. You can use thenodenameoption when startingTivoli Storage Manager or place the option in your client options filedsm.opt on the workstation. If you are using a workstation otherthan your own, use thenodenameoption with thedsm command.For example, if your node name is cougar, enter:

start dsm -nodename=cougar

You can then restore or retrieve files as if you were working on youroriginal workstation.

You can usenodenameon commands also. For example, if youwant to restore yourprojx files, enter:

dsmc restore -nodename=cougar {d-disk}\projx\*.*

If you do not want to restore or retrieve the files to the samedirectory name on the alternate workstation, enter a differentdestination.

Restoring or Retrieving Files to Another Type ofWorkstation

Because the file formats used on Windows NT, 98, and Me arecompatible, you can restore or retrieve files from one system type toanother. This is calledcross-client restore. For example, if youarchive a file from a Windows NT workstation, you can retrieve thatfile to a Windows 98 workstation.

Attention: You must have the appropriate permissions to accessthe file spaces of the other workstation, as explained in “AuthorizingAnother User to Restore or Retrieve Your Files” on page 75 and“Restoring or Retrieving Another User’s Files” on page 76.

Restoring or retrieving from non-native file systemsThe following clients support the associated file systems forrestore purposes:¶ Windows 98 and Me: FAT¶ Windows NT and Windows 2000: FAT, NTFS


3.B

ackingU

pand

Restoring

Although each client can recover data from each of these filesystems, some restrictions apply when recovering files thatwere backed up or archived from a drive that the client doesnot support. For example:

NTFS drivesWindows 98 and Me clients can recover the files,but special NT attributes such as security and ACLattributes are not recovered.

Windows NT clients have no restrictions whenrecovering files from Windows 98 clients; however,unique Windows 2000 attributes may be lost duringrecovery.

Windows 2000 clients have no restrictions whenrecovering files.

FAT drivesWindows NT clients can recover the files withoutany restrictions.

Recovering long file namesNTFS drives permit file and directory names that are longerthan those permitted on FAT drives. If you are recoveringfiles to a FAT drive with long file names, you should alwaysspecify a destination file specification for each file. Thisensures that you get the name you want.

When you use the Windows NT, 98, or Me client to recoverfiles with long names to an NTFS disk, the long names arepreserved, even if you are recovering the file to a differenttype of drive than the source drive.

The considerations for retrieving files are the same as for restoringthem.

Restoring a Disk in the Event of Disk LossTivoli Storage Manager only recovers your files if you run the client.If the disk that contains the client is lost, you must reinstall theclient before you can recover your files.


If your administrator has created a backup set of your files onportable media, you can use that set to recover the files without theuse of a server. See “Restoring Data from a Backup Set” on page 69for information on backup sets.

If you lose the disk containing the operating system, you mustrecover the operating system before you can connect to the server.

To protect yourself against these kinds of losses, you should haveavailable the operating system installation media or a softwareinstallation mechanism that you used to build the workstationoriginally. Alternatively, you may be able to assemble a set ofdiskettes to repair or boot your system to a condition that permitsyou to contact the server and begin recovering data. Depending onyour environment, these diskettes may need to contain some or all ofthe following items:

¶ An operating system that permits you to perform basic functions.You might also want to be able to boot DOS on your NTcomputer in the event NT will not start.

Windows 98, Me, and 2000 provide a″safe mode″ start-up thatallows you to boot to a command line prompt.

¶ A client with an appropriately customized options file. Thecommand line client is sufficient for this.

The exact files you need differ depending on the communicationpackage you use. Consult your operating system and communicationsoftware manuals for help in setting up these diskettes.

If you have large volumes of data that may need to be recovered,your administrator may want to create a backup set of those files onportable media. You can then use that set to recover the files withoutusing a server. See “Restoring Data from a Backup Set” on page 69for information on backup sets.

Deleting File SpacesIf your Tivoli Storage Manager administrator grants you authority,you can delete entire file spaces from the server. You cannot deleteindividual backup versions that are kept on the server. When you


3.B

ackingU

pand

Restoring

delete a file space, you delete all the files, both backup versions andarchive copies, that are contained within the file space. For example,if you delete the file space for yourc: drive, you are deleting everybackup for every file on that disk and every file you archived fromthat disk. Carefully consider what you are doing before you attemptto delete a file space.

You can delete file spaces using the GUI or command line clients.To delete NAS file spaces, use the Web client or command lineclient.

To delete a file space using the GUI client, perform the followingsteps:1. SelectUtilities→ Delete Filespacesfrom the main window.2. Selection the file spaces you want to delete.3. Click theDeletebutton. Tivoli Storage Manager prompts you for

confirmation before deleting the file space.

You can also delete a file space using thedelete filespacecommand.See “Delete Filespace” on page 351 for more information. Use theclassoption with thedelete filespacecommand to delete NAS filespaces. See “Class” on page 276 for more information.


Archiving and Retrieving Files

Archiving and retrieving files is similar to backing up and restoringfiles. Many of the windows and concepts are similar. This chapterdiscusses the primary archive and retrieve tasks. See “Do You Wantto Back Up or Archive Files?” on page 37 for a discussion of thedifference between backups and archives.

An Estimate function is provided on the Archive and Retrievewindows, which are accessible from the main Tivoli StorageManager window. Use this function if you want to estimate theamount of time it takes to process your files and directories. Theestimated transfer is a rough calculation of the time it takes TivoliStorage Manager to transfer your data. It is based on previoustransfers of data between your workstation and the current server.The actual transfer time could be longer or shorter than the estimatedue to factors such as network traffic, system load on yourworkstation, or system load on the server.

Unless otherwise specified, references to Windows 98 also includeWindows Me. References to Windows NT also include Windows2000.

All client archive and retrieve procedures in this chapter also applyto the Web client, except those procedures listed in “Using the WebBackup-Archive Client” on page 12.

See “Starting a Web Client Session” on page 24 for information onstarting the Web client.

4


4.A

rchivingand

Retrieving

Files

See Table 6 for a list of tasks.

Table 6. Archiving and Retrieving FilesTask Page

Performing a GUI Archive 83

Performing a Command Line Archive 83

Deleting Archive Data 84

Retrieving Archives Using the GUI 85

Retrieving Archives Using Commands 86

Archiving FilesTo archive files, select the files you want to archive. You can selectthe files by name or description, or select them from a directory tree.Your administrator might have set up schedules to automaticallyarchive certain files on your workstation. See “Automating Tasks” onpage 87 for information about checking and running the schedulesavailable to you. The following sections discuss how to archive fileswithout using a schedule.

Tivoli Storage Manager requires that you assign an archivedescription for all archived files. An archive description identifiesdata through a meaningful description that you can use later toidentify files and directories. You can enter as many as 255characters to describe your archived data. If you do not enter adescription, Tivoli Storage Manager assigns the following defaultarchive description:

Archive Date: mm/dd/yyyy

where mm/dd/yyyy is the current date.

When you select the archive function from the backup-archive GUI,Tivoli Storage Manager displays a list of all previously used archivedescriptions. You can assign these archive descriptions to futurearchives.


Performing a GUI ArchiveYou can archive specific files or entire directories from a directorytree. You can also assign a unique description for each group of filesyou archive (archive package). To archive your files:

1. Click theArchive button in the GUI main window. The Archivewindow appears.

2. Expand the directory tree by clicking the plus sign(+) or thefolder icon next to an object in the tree. To search or filter files,click the Search icon from the tool bar.To search:a. Enter your search criteria in the Find Files (Archive) window.b. Click theSearchbutton. The Matching Files (Archive)

window appears.c. Click the selection boxes next to the files you want to archive

and close the Matching Files (Archive) window.To filter:1) Enter your filter criteria in the Find Files (Archive) window.2) Click theFilter button. The Archive window displays the

filtered files.3) Click the selection boxes next to the filtered files or

directories you want to archive.

3. Enter a description, accept the default description, or select anexisting description for your archive package in theDescriptionpull down box.

4. To modify specific archive options, click theOverride ArchiveOptions button located to the right of theEstimate button. Anyoptions you change are effective during the current sessiononly.To estimate the transfer time for your archive selections click theEstimate button.

5. Click theArchive button. The Archive Status window displaysthe progress of the archive.

Performing a Command Line ArchiveUse thearchive command to archive files. Use wildcards to archivemore than one file at a time. If you archive a directory of files, usethe subdir=yesoption to include all the subdirectories under that


4.A

rchivingand

Retrieving

Files

directory in the archive. For example, to archive the files in thed:\proj directory and the files in its subdirectories, you wouldenter:

dsmc archive d:\proj\ -subdir=yes

You can enter up to 20 file names on thearchive command. Forexample, to archive thea:\h2.doc anda:\test.doc files, youwould enter:

dsmc archive a:\h2.doc a:\test.doc

If you want to specify more than 20 file names, you can use thefilelist option to specify a file containing a list of files forprocessing. See “Filelist” on page 281 for more information.

Use thedescriptionoption to assign a description to the archive:dsmc archive a:\h2.doc -description="Chapter 2, first version"

For more information about thearchive command, see “Archive” onpage 324.

Deleting Archive DataYou can delete archive data if your administrator has given youauthority to do so. See theDelete Archive Filesfield in theConnection Information window.

To delete archive copies:

1. SelectDelete Archive Data from theUtilities menu. TheArchive Delete window appears.

2. Expand the Directory tree by clicking the plus sign(+) or foldericon next to the object you want to expand. Objects on the treeare grouped by archive package description.

3. Click the selection boxes next to objects that you want to delete.If you want to estimate the amount of time it takes to processyour files and directories, click theEstimate button.

4. Click theDeletebutton. Tivoli Storage Manager prompts you forconfirmation before deleting achive selections.The ArchiveDelete Task List window displays the progress of the delete.


Retrieving ArchivesSelect theretrieve function to recover an archive copy of a file or adirectory. You can also retrieve archive copies from the directorytree, filter the directory tree, and retrieve archive copies of filesowned by someone else. To do any of these, click theRetrievebutton on the Tivoli Storage Manager main window and follow thedirections provided in the task help of the GUI.

For information about how to resolve conflicts between duplicate filenames, see “Duplicate File Names” on page 61.

Retrieving Archives Using the GUITo retrieve archives using the Tivoli Storage Manager GUI, performthe following steps:

1. Click theRetrieve button on the GUI main window. TheRetrieve window appears.

2. Expand the directory tree by clicking the plus sign(+) or thefolder icon next to an object you want to expand. To search orfilter files, click theSearch icon from the tool bar.To search:a. Enter your search criteria in the Find Files (Retrieve)

window.b. Click theSearchbutton. The Matching Files (Retrieve)

window appears.c. Click the selection boxes next to the files you want to

retrieve and close the Matching Files (Retrieve) window.To filter:1) Enter your filter criteria in the Find Files (Retrieve) window.2) Click theFilter button. The Retrieve window displays the

filtered files.3) Click the selection boxes next to the filtered files or

directories you want to retrieve.

3. Click Retrieve. The Retrieve Destination window appears. Enterthe appropriate information in the Retrieve Destination window.

4. Click Retrieve. The Retrieve Status window displays theprocessing status.


4.A

rchivingand

Retrieving

Files

Retrieving Archives Using CommandsUse theretrieve command to retrieve files. Specify the file youwant retrieve along with a destination. If you do not indicate adestination, the files are retrieved to their original location. Forexample, to retrieve thec:\doc\h2.doc file to its original directory,you would enter:

dsmc retrieve c:\doc\h2.doc

To retrieve the file under a new name, you would enter:dsmc retrieve c:\doc\h2.doc c:\doc\h3.doc

You can use thepick option to obtain a list of archive copies fromwhich you can pick files. See “Pick” on page 299.

If you are retrieving a file to a disk that has a different label otherthan the disk from which the file was archived, use the file spacename (label) of the archive disk rather than the drive letter. Forexample, if you archived a file from the diskette,workathome onthe a: drive, and you are retrieving it to a diskette in thea: drivelabeledextra, you would enter:

dsmc retrieve {workathome}\doc\h2.doc a:\doc\h2.doc

For information about how to retrieve files when the machine nameis part of the file name, see “Performing a Command Line Restore”on page 64. The information is presented in the context of therestore command but applies equally to theretrieve command.


Automating Tasks

Your administrator can schedule Tivoli Storage Manager to performtasks automatically on a regular basis. For example, you canautomatically back up files at the end of each day or archive someof your files every Friday. This procedure, known ascentralscheduling, is a cooperative effort between the server and your clientnode. Your administrator associates clients with one or moreschedules that are part of the policy domain maintained in the serverdatabase. The administrator defines central scheduling on the serverand you start the client scheduler on your workstation. Once youstart the client scheduler, further intervention is not necessary.

With client scheduling, you can also:¶ Display information about available schedules.¶ Display information about work that the schedule has completed.¶ Modify scheduling options in the client options file.

Notes:

1. The schedule start time is based on the server clock, not on theworkstation clock.

2. Install the command line client and ensure the communicationsoftware is running before you start the client scheduler.

5


5.A

utomating

Tasks

Specifying Scheduling OptionsYou can modify scheduling options in the client options filedsm.optor in the graphical user interface. However, if your administratorspecifies a value for these options, that value overrides the value inyour client.

For more information about scheduling options, changing thescheduling mode, specifying the TCP/IP address or port number, orrunning commands before or after a schedule, see “SchedulingOptions” on page 137.

Mobile Dial-Up SupportTivoli Storage Manager supports remote network connections to aserver. With a remote network connection, mobile users no longerneed to dial-in to their company network when a backup isscheduled to run. Tivoli Storage Manager automatically establishes aconnection before the scheduled backup occurs. If the connectionfails, Tivoli Storage Manager reestablishes the connection beforeattempting the backup.

To establish a remote network connection you need MicrosoftInternet Explorer 3.0 or higher on your Windows NT, 2000, 98, orMe workstation. Consult your operating system or Microsoft InternetExplorer help menus for current instructions to do the following:

Configure a network or dial-up connectionOptions are available for the type of connection you want toestablish.

Configure autodial featureThe schedule client connects to the internet and displays adialup box if the autodial feature is not enabled.

Add and configure a phone bookAvailable phone numbers are placed in the operating systemphone book. Consult your operating system or MicrosoftInternet Explorer help menus for instructions on how towork with phone book entries.


Return Codes from ExecutablesIf you use Tivoli Storage Manager commands in executables, beaware that the return code from a Tivoli Storage Manager executabledoesnot indicate a successful backup, archive, or restore of specificobjects. The return code only indicates whether the Tivoli StorageManager executable (e.g.,dsmc or dsmserv) ran successfully duringexecution. The return code does not indicate whether a specificTivoli Storage Manager command executed successfully inside of theTivoli Storage Manager shell. The client returns a codegreater than0 (zero) only if Tivoli Storage Manager was unable to attempt theoperation or if you cancel the operation.

For example, assume that your executable includes the TivoliStorage Manager command:dsmc sel myfile.txt

If Tivoli Storage Manager attempts to back upmyfile.txt, and thedsmc command successfully starts and finishes, Tivoli StorageManager sends a return code of0. Tivoli Storage Manager returns0even if the file is not successfully processed for the followingreasons:¶ The client could not establish a session with the server.¶ The file does not exist.

Note: Only those return codes output to the Tivoli Storage Managerscreen, activity log, schedule log, and error report indicate thesuccess or failure of specific commands.

Starting the Client SchedulerStart the Tivoli Storage Manager Client Scheduler by using one ofthe following methods:¶ On the command line, change to the Tivoli Storage Manager

installation directory and enterdsmc schedule

¶ For Windows 98 and Me: Select theStart button→ Programs→Tivoli Storage Manager folder→ TSM scheduler.


5.A

utomating

Tasks

¶ Windows NT and 2000: Use the Services Control Panel or thenet start command to start the Scheduler service.

1. From the Tivoli Storage Manager GUI, select theSetupWizard from theUtilities menu.

2. Select theHelp me configure the TSM Client Schedulercheckbox. Follow the instructions on the screen to install andconfigure the client scheduler.

3. Use the Client Acceptor service to manage the clientscheduler. See “Managing the Client Scheduler Using theClient Acceptor Service” on page 91 for more information.

For Windows NT, 2000 clients, you can also use theSchedulerService Configuration utility. The Scheduler ServiceConfiguration utility must be run from an account that belongs tothe Administrator/Domain Administrator group. You can startmultiple client scheduler services on your system. For additionalinformation, see″Using the Scheduler Service Configuration Utilityfor Windows NT, 2000″ in Tivoli Storage Manager Installing theClients, SH26-4119.

Note: Running the Client Scheduler on the command line is notpreferred for Windows NT, 2000 since it does not run thescheduler as a background service.

When you start the client scheduler, it runs continuously until youclose the window, shut down your system, or log out of your system.If you are running the Scheduler Service on Windows NT orWindows 2000, the scheduler runs until the system is shutdown oryou explicitly stop it via the services control panel. For informationon scheduling options, see “Setting Common Options” on page 127.


Managing the Client Scheduler Using the ClientAcceptor Service

The Tivoli Storage Manager Client Acceptor service can manage thescheduler, reducing the number of background processes on yourworkstation. This also resolves memory retention problems that mayoccur when using traditional methods of running the scheduler.

Use themanagedservicesoption in your client options file to specifywhether the Client Acceptor service manages the scheduler. See“Managedservices” on page 204 for more information.

Note: You cannot use themanagedservicesoption in a MicrosoftCluster Server (MSCS) environment.

Configuring the CAD to Manage the SchedulerPerform the following steps to configure the CAD to manage theclient scheduler:

1. SelectUtilities → Setup Wizard → Help me configure the TSMClient Scheduler from the Tivoli Storage Manager mainwindow. The Scheduler name and location window displays.

2. Specify the name of the Scheduler. Select theLocal MachineandUse the Client Acceptor Daemon (CAD) to Manage theScheduleroptions. Click theNext button. TheSelect the namesof the Web serviceswindow displays.

3. Specify the name of the client acceptor service that you want tomanage the scheduler. Click theNext button.

4. Follow the instructions on the screen to complete theconfiguration.

Displaying Information about Scheduled WorkTo view schedules that are defined for your client node, enter:

dsmc query schedule


5.A

utomating

Tasks

Tivoli Storage Manager displays detailed information about allscheduled work for your client node. The figure below displayssamplequery scheduleoutput.

The schedule name,DAILY_INC , starts a daily incremental backup.The next incremental backup will start in 30 minutes. Because noobjects are listed, Tivoli Storage Manager runs the incrementalbackup on your default domain. The schedule has no expiration date.

The schedule name,WEEKLY_INC , starts a weekly incrementalbackup on thee: andf: drives.

Schedule Name: DAILY_INCDescription: Daily System-wide backup

Action: IncrementalOptions: QUIETObjects:

Priority: 1Next Execution: 30 minutes

Duration: 4 HoursPeriod: 1 Day

Day of Week: AnyExpire: Never

Schedule Name: WEEKLY_INCDescription: Weekly backup for project files

Action: IncrementalOptions: QUIETObjects: e: f:

Priority: 1Next Execution: 60 minutes

Duration: 8 HoursPeriod: 7 Days

Day of Week: FridayExpire: Never

Figure 1. Sample Query Schedule Output


Displaying Information about Completed WorkWindows 98, Me:When you run theschedulecommand in theforeground, output from scheduled commands displays on yourscreen. Output is also directed to thedsmsched.log file in thecurrent directory unless you change the path and file name using theschedlognameoption.

Windows NT, 2000:When you run theschedulecommand as aservice, output from scheduled commands displays in the WindowsNT application event log. Output is also directed to thedsmsched.log file in the current directory unless you change thepath and file name using theschedlognameoption. The amount ofdetail is determined by whetherverboseor quiet is set in thedsm.opt file. The scheduler service also posts messages to the NTevent log.

After scheduled work is performed, check the schedule log to verifythat all work completed successfully.

When a scheduled command is processed the schedule log maycontain the following entry:

Scheduled event eventname completed successfully

The client indicates whether Tivoli Storage Manager successfullyissued the scheduled command associated with theeventname. Noattempt is made to determine the success or failure of the command.You can assess the status of the command by evaluating the returncode from the scheduled command in the schedule log. The schedulelog entry for the command’s return code is prefaced with thefollowing text:

Finished command. Return code is:

The scheduler service also logs information into the WindowsNT/2000 application event log and provides an event identification(event ID) number for each event in the log. Event ID 4101 displaysbackup and archive statistics, which you may find useful indetermining the success or failure of a command.


5.A

utomating

Tasks

The schedule log continues to grow unless you prune it using theschedlogretentionoption. See “Specifying Scheduling Options” onpage 88 for more information.

Enabling-Disabling Scheduled CommandsYou can query the schedules defined by your Tivoli StorageManager administrator by entering the following command:

query schedule

You can use theschedcmddisabledoption to disable the schedulingof commands by the server. Commands are scheduled by using theaction=command option on thedefine scheduleserver command.

The schedcmddisabledoption does not disable thepreschedulecmdandpostschedulecmdcommands. However, you can specifypreschedulecmdor postschedulecmdwith a blank or a null string todisable the scheduling of these commands. See “Schedcmddisabled”on page 231 for more information.

Accessing Windows NT Network DrivesTo access network drives during a scheduled backup, you mustspecify a Windows NT domain user ID with authority to access thenetwork drives you want to back up. Perform the following steps toestablish this access.1. Click theStart menu.2. SelectControl Panel.3. SelectServices.4. SelectTSM Services. The Services window is displayed.5. SelectCentral Scheduler.6. Click theStartup radio button.7. Ensure the radio button next toThis Accountis enabled in the

Login As section.8. Enter the domain name and password.

a. To specify a user’s particular domain, click the dropdownlist next to the domain name. A list of users appears.

b. Select the user.c. Click Add.


9. Click OK .10. Click Start.

The scheduled backup will run using the security credentials of theWindows NT domain user you specified.


5.A

utomating

Tasks

Understanding StorageManagement Policies

Storage management policies are rules your administrator defines inorder to manage your backups and archives on the server. You canassociate (orbind) your data to these policies; then when the data isbacked up or archived, it is managed according to policy criteria.Policy criteria include a policy domain, a policy set, a copy group,and a management class.

Policies determine:¶ Whether a file is eligible for backup or archive services.¶ How many backup versions to keep.¶ How long to keep backup versions and archive copies.¶ Where to place the copies in storage.

This chapter explains:

¶ Policy criteria (policy domains, policy sets, copy groups, andmanagement classes).

¶ How to display policies.

¶ How Tivoli Storage Manager associates your data with policies.

6


6.U

nderstandingS

torageM

anagement

Policies

Using Policy Domains and Policy SetsA policy domainis a group of clients with similar requirements forbacking up and archiving data. Policy domains contain one or morepolicy sets. An administrator uses policy domains to manage a groupof client nodes in a logical way. For example, a policy domain mightinclude:¶ A department, such as Accounting.¶ A physical location, such as a particular building or floor.¶ A local area network, such as all clients associated with a

particular file server.

Tivoli Storage Manager includes a default policy domain namedStandard. At first, your client node might be associated with thedefault policy domain. However, your administrator can defineadditional policy domains if there are groups of users with uniquebackup and archive requirements.

A policy setis a group of one or more management classes. Eachpolicy domain can hold many policy sets. The administrator uses apolicy set to implement different management classes based onbusiness and user needs. Only one of these policy sets can be activeat a time. This is called theactive policy set. Each policy setcontains adefault management classand any number of additionalmanagement classes.

Using Management Classes and Copy GroupsA management classis a collection of backup and archive copygroups that establishes and contains specific storage managementrequirements for backing up and archiving data. An administratorcan establish separate management classes to meet the backup andarchive requirements for different kinds of data, such as:¶ System data that is critical for the business.¶ Application data that changes frequently.¶ Report data that Management reviews monthly.¶ Legal information that must be retained indefinitely, requiring a

large amount of disk space.


Most of the work you do with storage management policies is withmanagement classes. You must associate (orbind) each file anddirectory that you back up and each file that you archive with amanagement class. If you do not associate a file with a managementclass, Tivoli Storage Manager uses the default management class inthe active policy set. If you do not specify a management class fordirectories, Tivoli Storage Manager uses the management class in theactive policy set specifying the longest retention period.

Use an include-exclude list to associate files with managementclasses. See “Selecting a Management Class for Files” on page 105for more information. To associate directories with a managementclass, use thedirmc option. See “Selecting a Management Class forDirectories” on page 108 for more information.

Within a management class, the specific backup and archiverequirements are incopy groups. Copy groups define the specificstorage management attributes that describe how the server managesbacked up or archived data. Copy groups include bothbackup copygroupsandarchive copy groups. A management class can have onebackup copy group, one archive copy group, both, or neither.

A backup copy groupcontains attributes that are used during thebackup process to determine:¶ Whether a file that has changed since the last backup is backed

up again.¶ How many days must elapse before a file is backed up again.¶ How a file is processed during a backup if it is in use.

It also contains attributes to manage the backup versions of yourfiles on the server. These attributes control:¶ Where the server stores backup versions of your files and

directories¶ How many backup versions the server keeps of your files and

directories¶ How long the server keeps backup versions of your files and

directories.


6.U

nderstandingS

torageM

anagement

Policies

An archive copy groupcontains attributes that control:¶ Whether a file is archived if it is in use¶ Where the server stores archived copies of your files¶ How long the server keeps archived copies of your files

When the server is unable to rebind a file to an appropriatemanagement class, the server uses one of two values to determinethe number of days to retain the file. If it is a backup version, theserver usesbackup grace period retention. If it is an archive copy,the server usesarchive grace period retention. For more informationabout grace periods, see “Using a Retention Grace Period” onpage 110.

Displaying Information about Management Classesand Copy Groups

Before you select the management classes you want to use, clickDisplay policy information from the Utilities menu to determinewhich ones are available. You can also use thedetail option on thequery mgmtclasscommand to view the available managementclasses.

The Display policy information window provides the followinginformation:¶ The name of the default management class.¶ The name of the policy domain to which the management class

belongs.¶ The policy set that is currently active.¶ The date and time that this policy set became active.¶ The number of days to retain an backed up version or archived

copy.¶ The management class name and a description.

Table 7 on page 101 shows the default values for the backup andarchive copy groups in the standard management class. Eachattribute is discussed in more detail immediately following the table.


Table 7. Default Values in the Standard Management ClassAttribute Backup Default Archive Default

Copy group name Standard Standard

Copy type Backup Archive

Copy frequency 0 days CMD (Command)

Versions data exists Two versions Does not apply

Versions data deleted One version Does not apply

Retain extra versions 30 days Does not apply

Retain only version 60 days Does not apply

Copy serialization Shared static Shared static

Copy mode Modified Absolute

Copy destination Backuppool Archivepool

Retain versions Does not apply 365 days

Copy Group NameThe name of the copy group. The default value for both backup andarchive isStandard.

Copy TypeThe type of copy group. The value for backup is alwaysBackup, andthe value for archive is alwaysArchive.

Copy FrequencyCopy frequencyis the minimum number of days that must elapsebetween successive incremental backups. Use this attribute during afull incremental backup. For Windows NT, 2000: This managementclass attribute is ignored during a journal-based backup.

Copy frequency works with themodeparameter. For example, iffrequency iszero (0)and mode ismodified, a file or directory isbacked uponly if it changed since the last incremental backup. Iffrequency iszero (0)and mode isabsolute, a file is backed up everytime you run an incremental backup against it. This attribute is notchecked for selective backups. Journal-based incremental backup


6.U

nderstandingS

torageM

anagement

Policies

differs from the traditional full incremental backup in that TivoliStorage Manager does not enforce non-default copy frequencies(other than 0).

For archive copy groups, copy frequency is always CMD(command). There is no restriction on how often you archive a file.

Versions Data ExistsThe Versions Data Existsattribute specifies the maximum number ofdifferent backup versions retained for files and directories currentlyon your drive. If you select a management class that permits morethan one backup version, the most recent version is called theactiveversion. All other versions are calledinactiveversions. If themaximum number of versions permitted is five, and you run abackup that creates a sixth version, the oldest version is deleted fromserver storage.

Versions Data DeletedThe Versions Data Deletedattribute specifies the maximum numberof different backup versions retained for files and directories thatyou erased from your drive. This parameter is ignored as long as thefile or directory remains on your drive.

If you erase the file or directory, the next time you run anincremental backup, the active backup version is changed to inactiveand the oldest versions are erased that exceed the number specifiedby this parameter.

The expiration date for the remaining versions is based on theretainextra versionsand retain only versionparameters.

Retain Extra VersionsThe Retain Extra Versionsattribute specifies how many days all butthe most recent backup version is retained. The most recent versionis the active version, and active versions are never erased. IfNolimitis specified, extra backup versions are deleted based on theversionsdata existsor theversions data deletedparameter settings.


Retain Only VersionThe Retain Only Versionattribute specifies the number of days thelast remaining inactive version of a file or directory is retained. IfNolimit is specified, the last version is retained indefinitely.

This parameter goes into effect during the next incremental backupafter a file is deleted from the client machine. Any subsequentupdates to this parameter will not affect files that are alreadyinactive. For example: If this parameter is set to 10 days when a fileis inactivated during an incremental backup, the file will be expiredin 10 days even if the value is later updated to another value.

Copy SerializationThe Copy Serializationattribute determines whether a file can be inuse during a backup or archive, and what to do if it is. The value forthis attribute can be one of the following:

¶ Static. A file or directory must not be modified during a backupor archive. If the object is changed during a backup or archiveattempt, it is not backed up or archived.

¶ Shared static. A file or directory must not be modified duringbackup or archive. Tivoli Storage Manager attempts to perform abackup or archive as many as four additional times, dependingon the value specified on thechangingretriesoption in yourclient options file. If the object is changed during every backupor archive attempt, it is not backed up or archived.

¶ Dynamic. A file or directory is backed up or archived on thefirst attempt regardless of whether it changes during a backup orarchive.

¶ Shared dynamic. A file or directory is backed up or archivedregardless of whether it changes during a backup or archive.Tivoli Storage Manager attempts to perform a back up or archiveas many as four additional times, depending on the valuespecified on thechangingretriesoption in your client optionsfile without the file changing during the attempt. The file isbacked up or archived on the last try even if it has changed.


6.U

nderstandingS

torageM

anagement

Policies

Note: Be careful when you select a management classcontaining a copy group that specifies shared dynamic ordynamic for serialization backup. If you select amanagement class that permits a file to be backed up orarchived while it is in use, the backup version or archivedcopy stored on the server might be a fuzzy copy. Afuzzycopy is a backup version or archived copy that does notaccurately reflect what is currently in the file. It mightcontain some, but not all, of the changes. If that is notacceptable, select a management class that creates abackup version or archive copy only if the file does notchange during a backup or archive.

If you restore or retrieve a file that contains a fuzzy copy,the file might not be usable.

Copy ModeThe Copy Modeattribute determines whether a file or directory isconsidered for incremental backup regardless of whether it changedor not since the last backup. Tivoli Storage Manager does not checkthe mode for selective backups. The value for this parameter can beone of the following:

¶ Modified.The file is considered for incremental backuponly if ithas changed since the last backup. A file is considered changedif any of the following are true:

The date or time of the last modification is different.The file size is different.The file attributes, with the exception of archive, aredifferent. However, if only the file meta-data changes (suchas access permissions), but the file data does not change,Tivoli Storage Manager may back up only the meta-data.

¶ Absolute. The file is considered for incremental backupregardless of whether it changed since the last backup. Forarchive copy groups, the mode is alwaysabsolute, indicatingthat a file is archived regardless of whether it changed since thelast archive request.


Copy DestinationNames the destination where backups or archives are stored. Thedestination can be either a storage pool of disk devices or a storagepool of devices that support removable media, such as tape.

Retain VersionsSpecifies the number of days an archived file remains in storage.When the specified number of days elapse for an archived copy of afile, it is deleted from server storage.

Selecting a Management Class for FilesIf the default management class meets the backup and archiverequirements for all the files on your workstation, it is not necessaryto take any action to associate your files with that management class.This is done automatically when you back up or archive your files.

When selecting a different management class for your files, considerthese questions:

¶ Does the management class contain a backup copy group?

If you attempt to back up a file associated with a managementclass that does not contain a backup copy group, the file is notbacked up.

¶ Does the management class contain an archive copy group?

If you attempt to archive a file associated with a managementclass that does not contain an archive copy group, the file is notarchived.

¶ Does the backup copy group contain attributes that back up yourfiles often enough?

Mode and frequency work together to control how often a file isbacked up when you use incremental backup. Tivoli StorageManager does not check those attributes for selective backup.

¶ Do the copy groups specify either static or shared static forserialization?

If serialization is shared dynamic or dynamic, you might getfuzzy backups or archive copies. Verify that this is acceptable.


6.U

nderstandingS

torageM

anagement

Policies

For example, you might want to use shared dynamic or dynamicserialization for a file to which log records are continuouslyadded. If you used static or shared static serialization, the filemight never back up because it is constantly in use. With shareddynamic or dynamic serialization, the file is backed up, but thebackup version of the file might contain a truncated message. Donot use shared dynamic or dynamic serialization for a file if it isvery important that the backup version or archive copy containall changes.

¶ Does the backup copy group specify an adequate number ofbackup versions to keep, along with an adequate length of timeto keep them?

¶ Does the archive copy group specify an adequate length of timeto keep archived copies of files?

Assigning a Management Class to FilesA management class defines when your files are included in abackup, how long they are kept on the server, and how manyversions of the file the server should keep. The server administratorselects a default management class. You can specify your ownmanagement class to override the default management class.

You can assign a management class for a file or file group by usingan include statement in your client options file. Management classnames are not case-sensitive. For example, to associate all the filesin the costs directory with a management class namedbudget, youwould enter:

include c:\adsm\proj2\costs\* budget

To specify a management class namedmanagall to use for all filesto which you do not explicitly assign a management class, youwould enter:

include * managall


The example below demonstrates how to use a management class:exclude ?:\...\*.snoinclude c:\winter\...\*.ice mcweeklyinclude c:\winter\december\*.ice mcdailyinclude c:\winter\january\*.ice mcmonthlyinclude c:\winter\winter\white.sno

Processing follows these steps:

1. The file namedwhite.sno is backed up following bottom-upprocessing rules. Because you did not specify a managementclass, the file is assigned to the default management class.

2. Any file with an extension ofice in the c:\winter\januarydirectory is assigned to the management class,mcmonthly.

3. Any file with an extension ofice in the c:\winter\decemberdirectory is assigned to the management class,mcdaily.

4. Any other files with an extension ofice in any directory under\winter are assigned to the management class,mcweekly.

5. Any file with an extension ofsno (exceptc:\winter\winter\white.sno) in any directory is excludedfrom backup.

To specify your own default management class for files that are notexplicitly included, specify:

include ?:* mgmt_class_name

as the first include or exclude option defined.

Overriding the Management Class for Archived FilesWhen you archive a file, you can override the assigned managementclass using the graphical user interface (GUI), or by using thearchmc option on thearchive command. To use the GUI, press theArchive Options button on the archive tree to override themanagement class and select a different management class. Forexample, to associate the file,budget.jan, with the managementclassret2yrs, you would enter:

dsmc archive –archmc=ret2yrs c:\plan\proj1\budget.jan


6.U

nderstandingS

torageM

anagement

Policies

Selecting a Management Class for DirectoriesIf the management class in your active policy set containing thelongest retention period meets your backup requirements fordirectories, it is not necessary to take any action to associatedirectories with that management class. Tivoli Storage Manager doesit automatically when it backs up your directories.

If the default management class does not meet your requirements,select a management class with an adequate retention periodspecified on theretain only versionparameter. You should keepdirectories at least as long as you keep the files associated with thosedirectories.

To assign a management class other than the default to directories,use thedirmc option in your client options file . For example, toassign a management class nameddirect1 to your directories, youwould enter:

dirmc direct1

Note: For archive operations, directories are assigned to amanagement class whose retention period meets or exceedsthat of the files contained in those directories. Themanagement class is rebound as needed to ensure thatdirectories with files do not expire.

Binding and Rebinding Management Classes to FilesBinding associates a file with a management class. When you backup a file for the first time, Tivoli Storage Manager binds it to eitherthe default management class or the management class specified inyour include-exclude list. In later backups of the same file, if youchange the management class, both active and inactive versions arebound again to the new management class.

If the backup copy group for the management class specifies keepingmultiple backup versions of the file, and you request multiplebackups, the server always has one active backup version (thecurrent version) and one or more inactive backup versions of the


file. All backup versions of a file are bound to the same managementclass and are managed based on the attributes in the backup copygroup.

When you archive a file for the first time, Tivoli Storage Managerbinds it to the default management class, to the management classspecified in your include-exclude list, or to a management class youspecify when modifying your archive options during an archive.

Archived files are never rebound to a different management class. Ifyou change the management class for a file, any previous copies ofthe file that you archived remain bound to the management classspecified when you archived them.

Rebinding Backup Versions of FilesBackups of files are bound again to a different management class inthe following conditions. In each condition, the files (active andinactive) are not bound again until the next backup.

¶ You specify a different management class in an Includestatement to change the management class for the file. Thebackups are managed based on the old management class untilyou run another backup.

¶ Your administrator deletes the management class from youractive policy set. The default management class is used tomanage the backup versions when you back up the file again.

¶ Your administrator assigns your client node to a different policydomain and the active policy set in that domain does not have amanagement class with the same name. The default managementclass for the new policy domain is used to manage the backupversions.


6.U

nderstandingS

torageM

anagement

Policies

Using a Retention Grace PeriodTivoli Storage Manager also provides abackup retention graceperiod and anarchive retention grace periodto help protect yourbackup and archive data when it is unable to rebind a file to anappropriate management class. The backup retention grace period isused when:

¶ You change the management class for a file, but neither thedefault management class nor the new management class containa backup copy group.

¶ The management class to which a file is bound no longer exists,and the default management class does not contain a backupcopy group.

The backup retention grace period, defined in your policy domain,starts when you run an incremental backup. The default is 30 days.However, your administrator can lengthen or shorten this period.

When Tivoli Storage Manager manages a file using the backupretention grace period, it does not create any new backup versions ofthe file. All existing backup versions of the file expire 30 days (orthe number of days specified in your policy domain) from the daythey are marked inactive.

For archived files, if the management class to which a file is boundno longer exists, and the default management class does not containan archive copy group, the archive retention grace period defined inyour policy domain is used. The default retention period is 60 days.However, your administrator can lengthen or shorten this period.


Creating an Include-Exclude List

You can create an include-exclude list to exclude a specific file orgroups of files from backup services, and to assign specificmanagement classes to files. Tivoli Storage Manager backs up anyfile that is not explicitly excluded. You should exclude TivoliStorage Manager client directories from backup services.

Specify your include-exclude list in your client options file . This listcan also contain include-exclude statements obtained frominclude-exclude files which you specify with theinclexcl option. Theinclude-exclude statements are not case sensitive.

For Windows NT or 2000 clients: The include-exclude file can be inUnicode or non-Unicode format. If you specify a non-Unicodeinclude-exclude file, the file must be in the same code page that theclient is running.

When processing occurs, the include-exclude statements within theinclude-exclude file are placed at the position occupied by theinclexcl option in dsm.opt and processed accordingly.

See “Inclexcl” on page 187 for detailed information about specifyingan include-exclude file using theinclexcl option.

You can use one of the following methods to create aninclude-exclude list or specify an include-exclude file:1. From the client GUI, clickEdit → Preferences→

Include/Exclude tab.

7


7.C

reatingan

Include-Exclude

List

2. From the client GUI, clickUtilities and then clickSetupWizard .

Note: For Windows NT or 2000 clients: You can specify a Unicodefile as an include-exclude file using the preferences editor.However, you cannot create the Unicode file using thepreferences editor. See “Considerations for Windows NT,2000 Unicode-Enabled Clients” for instructions on creating aUnicode include-exclude file.

You can also create an include-exclude list by performing thefollowing steps:1. Determine your include and exclude requirements2. Locate the include-exclude section in your client options file3. Enter yourinclude andexcludestatements using the appropriate

include-exclude options in Table 8 on page 114, Table 10 onpage 116, and Table 9 on page 115. Because Tivoli StorageManager processes your include-exclude list from the bottom ofthe list up, it is important to enter all your include-excludestatements in the proper order.

4. If you wish, you can specify an include-exclude file using theinclexcl option. The file can be located in any directory to whichall users on your workstation have read access. See “Inclexcl” onpage 187 for more information about theinclexcl option.

5. Save the file and close it. Save the file asdsm.opt or as the filespecified in the DSM_CONFIG environment variable.

6. Restart Tivoli Storage Manager with your new client optionsfile.

Considerations for Windows NT, 2000Unicode-Enabled Clients

For Windows NT and Windows 2000 Unicode-enabled clients, theinclude-exclude file can be in Unicode or non-Unicode format. Ifyou specify a non-Unicode include-exclude file, that file must be inthe same code page the client is running.


A Unicode include-exclude file provides the following benefits:¶ Names with characters from another code page no longer have

to be wildcarded.¶ File names and directories from any code page can befully

specifiedfor the Unicode-enabled client to process.

To create an include-exclude file in Unicode format, perform thefollowing steps:1. Open Notepad.2. List your include andexcludestatements using the appropriate

include-exclude options in Table 8 on page 114, Table 9 onpage 115, and Table 10 on page 116. You may need to copy filenames with characters from other code pages using MicrosoftWindows Explorer.

3. Click File and then clickSave As. The Save As windowdisplays.

4. Select theSave as Unicodecheckbox, specify the file and targetdirectory, and save the file.

5. Place aninclexcl option specifying the include-exclude file youjust created in your client options file (dsm.opt).

Using Include-Exclude OptionsThis section provides the following:¶ Brief descriptions of theinclude andexcludeoptions that you

can specify in your client options file. See table references formore information about each option.

¶ A minimum include-exclude list that excludes system files.¶ Information on how to exclude remotely accessed files.¶ A list of supported wildcard characters that you can use to

include or exclude groups of files for processing.¶ Examples of how you might use wildcard characters with

include andexcludepatterns.

Excluding DirectoriesUseexclude.dirstatements to exclude directories from processing.Tivoli Storage Manager evaluates allexclude.dirstatementsfirst, andremoves the excluded directories and files from the list of objectsavailable for processing. Theexclude.dirstatements override all


7.C

reatingan

Include-Exclude

List

include statements that match the pattern.

Table 8. Option for Excluding DirectoriesOption Description Page

exclude.fs.nasExcludes file systems on the NAS filer from animage backup when used with thebackup nascommand. If you do not specify a NAS node name,the file system identified applies to all NAS filers.The backup nascommand ignores all otherexclude statements includingexclude.dirstatements. This option is for Windows NT andWindows 2000 clientsonly.

177

exclude.dir Excludes a directory, its files, and all itssubdirectories and their files from backup services.The exclude.diroption works only if the excludeddirectory is a subdirectory. Use this option toexclude a portion of your data in which nounderlying files need to be backed up.

When you exclude a directory, you can still backup specific files within that directory using aselective backup. However, the next time youperform an incremental backup, these backupversions are expired. If you exclude a directory thatwas previously included, Tivoli Storage Managermarks existing backup versions inactive during thenext incremental backup.

177

Controlling Backup, Archive, Image, and SystemObject Processing

After Tivoli Storage Manager evaluates allexclude.dirstatements,the following options are evaluated against the remaining list ofobjects available for processing.

If you exclude an object that was previously included, Tivoli StorageManager marks existing backup versions inactive during the nextincremental backup.


Table 9. Options for Controlling Backup, Archive, and SystemObject ProcessingOption Description Page

Backup Processing

excludeexclude.backupexclude.fileexclude.file.backup

These options are equivalent. Use theseoptions to exclude a file or group of filesfrom backup services.

177

includeinclude.backupinclude.file

These options are equivalent. Use theseoptions to include files or assignmanagement classes for backup processing.

189

Archive Processing

exclude.archive Excludes a file or group of files from archiveservices.

177

includeinclude.archive

These options are equivalent. Use theseoptions to include files or assignmanagement classes for archive processing.

189

Image Processing

exclude.fs.nas Excludes file systems on the NAS filer froman image backup when used with thebackup nascommand. If you do not specifya NAS node name, the file system identifiedapplies to all NAS filers. Thebackup nascommand ignores all other excludestatements includingexclude.dirstatements.This option is for Windows NT andWindows 2000 clientsonly.

177

include.fs.nas Assigns a management class when used withthe backup nascommand. If you do notspecify a NAS node name, the file systemidentified applies to all NAS filers. Thebackup nascommand ignores all otherinclude statements. This option is forWindows NT and Windows 2000 clientsonly.

189

System Object Processing


7.C

reatingan

Include-Exclude

List

Table 9. Options for Controlling Backup, Archive, and SystemObject Processing (continued)Option Description Page

include.systemobjectAssigns management classes for backup ofWindows 2000 system objects. By default,Tivoli Storage Manager binds all systemobjects to the default management class. Youcannot use this option to bind individualsystemobject components to a differentmanagement class. You cannot use thisoption to include or exclude a system objectfrom processing. This option is valid forWindows 2000only.Note: Other include-exclude statements donot affect system object processing. It isunnecessary to explicitly include the registrystaging directoryincludec:\adsm.sys\...\* for back up, to ensurethat the registry is backed up properly. If youaccidently exclude a directory that is criticalto a system object backup, the system objectbackup is not affected.

189

Controlling Compression, Encryption, and SubfileProcessing

After Tivoli Storage Manager evaluatesexclude.dirand all otherinclude-exclude statements, the following options are evaluatedagainst the remaining list of objects available for processing.

Table 10. Options for Controlling Compression, Encryption, andSubfile ProcessingOption Description Page

Compression Processing

exclude.compressionExcludes files from compressionprocessing ifcompression=yesis specified.

177

include.compression Includes files for compression processingif compression=yesis specified.

189

Encryption Processing


Table 10. Options for Controlling Compression, Encryption, andSubfile Processing (continued)Option Description Page

exclude.encrypt Excludes files from encryption processing. 177

include.encrypt Includes files for encryption processing. 189

Adaptive Subfile Backup Processing

exclude.subfile Excludes files from adaptive subfilebackup processing. This option is valid forall Windows clients.

177

include.subfile Includes files for adaptive subfile backupprocessing. This option is valid for allWindows clients.

189

Excluding System FilesWe recommend that you have the following minimuminclude-exclude list in your client options file:

exclude "*:\microsoft uam volume\*"exclude "*:\microsoft uam volume\...\*"exclude "*:\...\ea data. sf"exclude "*:\...\pagefile.sys"exclude "*:\...\ibmbio.com"exclude "*:\ibmdos.com"exclude "*:\msdos.sys"exclude "*:io.sys"exclude.dir *:\recycledexclude.dir *:\recyclerexclude.dir *:\...\system32\winsexclude.dir *:\...\system32\LServerexclude.dir *:\...\system32\dhcpexclude.dir *:\...\system32\configexclude.dir "*:\system volume information"exclude *:\...\system32\perflib*.datexclude.dir "*:\...\temporary internet files"exclude "*:\documents and settings\...\ntuser.dat.LOG"exclude "*:\documents and settings\...\ntuser.dat"exclude "*:\documents and settings\...\usrclass.dat.LOG"exclude "*:\documents and settings\...\usrclass.dat"

These are system files that cannot be recovered without possiblycorrupting the operating system. If subfile backup is being used, thedirectory containing cache files should be excluded withexclude.dir.If you are using a disk compression program, you might want to


7.C

reatingan

Include-Exclude

List

exclude thedblspace.*anddrvspace.*files. It is not necessary toback up these hidden files because Tivoli Storage Manager backsthem up in the file spaces used by these programs. If you do backup these large files, your communication session might time outbefore Tivoli Storage Manager finishes sending the files. Consultyour disk compression documentation for the file names or enter thefollowing command to look for hidden files:

dir \ /s /a:h

Excluding Files with UNC NamesYou can exclude remotely accessed files by specifying theiruniversal naming convention (UNC) names in your excludestatement. For example, assume that local drive letterg is mapped tothe remote share point\\remote\books

You would like to exclude from backups all files at the root of thisshare point that have an extension of .txt. You could use either of thefollowing commands:exclude g:*.txtexclude \\remote\books\*.txt

You cannot specify UNC names for removable drives such as CD,ZIP, or diskette. For example, the following command isnot valid:exclude \\ocean\a$\winnt\system32\...\*

Including and Excluding Groups of FilesTo specify groups of files that you want to include or exclude, usethe wildcard characters listed in Table 11 on page 119. This tableapplies toinclude andexcludestatementsonly. For informationabout using wildcard characters in Tivoli Storage Managercommands, see “Using Wildcard Characters” on page 322.


Table 11. Wildcard and Other Special CharactersCharacter Function

? The match-one character matches any single characterexceptthe directory separator; it does not match the end of the string.For example:

¶ The pattern ab?,matchesabc, butdoes not matchab,abab, or abzzz.

¶ The pattern ab?rs,matchesabfrs, butdoes not matchabrs, or abllrs.

¶ The pattern ab?ef?rs,matchesabdefjrs, butdoes notmatch abefrs, abdefrs, or abefjrs.

¶ The pattern ab??rs,matchesabcdrs, abzzrs, butdoes notmatch abrs, abjrs, or abkkkrs.

* The match-all character. For example:

¶ The pattern ab*, matchesab, abb, abxxx, butdoes notmatch a, b, aa, bb.

¶ The pattern ab*rs,matchesabrs, abtrs, abrsrs, butdoesnot match ars, or aabrs, abrss.

¶ The pattern ab*ef*rs, matchesabefrs, abefghrs, butdoesnot match abefr, abers.

¶ The pattern abcd.*,matchesabcd.c, abcd.txt, butdoes notmatch abcd, abcdc, or abcdtxt.

\... The match-n character matches zero or more directories.

\ The directory separator character limits the scope of the searchfor the matchingn characters and directories. If a pattern doesnot begin with a directory separator (or one does not follow thedrive specification), a match-all directories is appended to thepattern. For example, these patterns are equivalent:

c:*c:\...\*

[ The open character-class character begins the enumeration of acharacter class. For example:

xxx[abc] matches xxxa, xxxb, or xxxc.


7.C

reatingan

Include-Exclude

List

Table 11. Wildcard and Other Special Characters (continued)Character Function

– The character-class range includes characters from the firstcharacter to the last character specified. For example:

xxx[a-z] matches xxxa, xxxb, xxxc, ... xxxz.

This format should not be used to specify remote drives in anexcludestatement.

\ The literal escape character. When used within a character class,it treats the next character literally. When used outside of acharacter class, it is not treated in this way. For example, if youwish to include the ’]’ in a character class, enter [...\]...]. Theescape character removes the usual meaning of ’]’ as the closecharacter-class character.

] The close character-class character ends the enumeration of acharacter class.

: The drive separator character separates a file specification. Thecharactersbeforethe colon identify a drive name. Thecharactersafter the colon identify either a directory name or afile name. For example:

d:\direct\file.nam

Examples Using Wildcards with Include and ExcludePatterns

Table 12 contains examples of ways you might use wildcardcharacters withinclude andexcludepatterns.

You cannot use wildcard characters with theinclude.fs.nasandexclude.fs.nasoptions.

Table 12. Using Wildcard Characters with Include and ExcludePatternsTask Pattern

Exclude all files during backup withan extension ofbak, except thosefound on thed: drive in thedevdirectory.

exclude ?:*.bakinclude d:\dev\*.bak


Table 12. Using Wildcard Characters with Include and ExcludePatterns (continued)Task Pattern

Exclude all files and directories inany tmp directory that might exist,exceptfor the file d:\tmp\save.fil.Include this file.

exclude ?:\...\tmp\...\*include d:\tmp\save.fil

Exclude any .obj file for backup inany directory on thec: e: f: andg:drives.

exclude [ce-g]:\...\*.obj

The c: e: f: andg: drives are localor removable.

Exclude the .obj files found in theroot directory in thed: drive only.

exclude d:\*.obj

Exclude any file that resides underthe tmp directory found in any filespace on any drive.

exclude ?:tmp\...\*

Exclude thec:\mydir\test1directory.

exclude.dir c:\mydir\test1

Exclude all directories under the\mydir directory with namesbeginning withtest.

exclude.dir c:\mydir\test*

Exclude all directories directly underthe \mydir directory with namesbeginning withtest, on any drive.

exclude.dir ?:\mydir\test*

Exclude all directories and files onthe local drives, except thec: drive.

exclude.dir ?:\...\*exclude [abd-z]:\...\*exclude.dir [abd-z]:\...\*

Processing Include and Exclude OptionsInclude-exclude options can be defined on the server using theinclexcl parameter. The include-exclude statements specified by theserver are evaluated along with those in the client options file. Theserver include-exclude statements are always enforced and placed atthe bottom of the include-exclude list and evaluated before the clientinclude-exclude statements.


7.C

reatingan

Include-Exclude

List

If the client options file include-exclude list contains one or moreinclexcl options that specify include-exclude files, theinclude-exclude statements in these files are placed in the listposition occupied by theinclexcl option and processed accordingly.

Tivoli Storage Manager evaluates allexclude.dirstatementsfirst, andremoves the excluded directories and files from the list of objectsavailable for processing. See “Excluding Directories” on page 113and “Exclude Options” on page 177 for more information about theexclude.diroption.

After evaluating allexclude.dirstatements, Tivoli Storage Managerevaluates the include-exclude list from the bottom up and stops whenit finds an include or exclude statement that matches the file it isprocessing. The order in which the include and exclude options areentered therefore affects which files are included and excluded. See“Setting Common Options” on page 127 for more information aboutthe order in which all options are processed.

To display a list of all include-exclude statements in effect on yourclient workstation in the actual order they are processed, use thequery inclexcl command. See “Query Inclexcl” on page 385 formore information.

The client program processes theinclude andexcludeoptions asfollows:

1. Files are checked; directories areonly checked if theexclude.diroption is specified.

2. File names are compared to the include-exclude list from thebottom up.When a match is found, the processing stops andchecks whether the option isinclude or exclude. If the option isinclude, the file is backed up. If the option isexclude, the file isnot backed up.

3. If a matchis not found, files listed are implicitly included andbacked up.


4. If policy administration is in effect, files are backed up accordingto the default management class, or the management class youspecify on a matching include option.

The following examples demonstratebottom upprocessing.

Example 1Assume thatc: is defined as the domain, and you definedthe following statements for theinclude andexcludeoptions:

exclude ?:\*.objinclude c:\foo\...\*.objexclude c:\foo\junk\*.obj

The file being processed is:c:\foo\dev\test.obj.Processing follows these steps:

1. Rule 3 (the lastinclude or excludestatement defined) ischeckedfirst because of bottom up processing. The filec:\foo\junk\*.obj does not match the file name that isbeing processed.

2. Processing moves to Rule 2 and checks. This time, filec:\foo\...\*.obj matches the file name that is beingprocessed. Processing stops, the option is checked, and itis include.

3. File c:\foo\dev\test.obj is backed up.

Example 2Assume thatc: is defined as the domain, and you definedthe following statements for theinclude andexcludeoptions:

exclude ?:\*.objinclude c:\foo\...\*.objexclude c:\foo\junk\*.obj

The file being processed is:c:\widg\copyit.bat.Processing follows these steps:1. Rule 3 is checked and finds no match.2. Rule 2 is checked and finds no match.3. Rule 1 is checked and finds no match.4. Because a match is not found, filec:\widg\copyit.bat

is implicitly included and backed up.


7.C

reatingan

Include-Exclude

List

Example 3Assume thatc: is defined as the domain, and that youdefined the following statements for theinclude andexcludeoptions:

exclude ?:\...\*.objinclude c:\foo\...\*.objexclude c:\foo\junk\*.obj

The current file being processed is:c:\lib\objs\printf.obj. Processing follows these steps:1. Rule 3 is checked and finds no match.2. Rule 2 is checked and finds no match.3. Rule 1 is checked and a match is found.4. Processing stops, the option is checked, and it isexclude.5. File c:\lib\objs\printf.obj is not backed up.

Processing Rules when Using UNC NamesWhen processing files with UNC names, Tivoli Storage Manageruses the rules described above. In addition, the following rules apply.

Explicit Use of UNC names for Remote DrivesTivoli Storage Manager will recognize explicit use of UNC namesfor remote drives. For example, in the list below the UNC namepattern can be substituted for the DOS pattern. Assume local driveletter r: is mapped to remote share point\\remote\c$, s: ismapped to\\remote\share4, andt: is mapped to\\remote\share2.

Table 13. Using UNC Names with Include and ExcludePatternsUNC Name Pattern DOS Pattern

\\remote\c$\include\file.out r:\include\file.out

\\remote\c$\...\file.out r:\...\file.out

\\remote\share4\exclude\* s:\exclude\*

\\remote\share2\...\?.out t:\...\?.out


Conversion of DOS Pathnames for Fixed and RemoteDrives

Tivoli Storage Manager converts DOS pathnames that are mapped toremote share points. For example, a remote share point that ismapped fromr:\test\...\exclude.out

to\\remote\share\test\...\exclude.out

is converted. Remote share points that are not mapped are notconverted. Files on removable media are not converted.

File Space Name MatchingFile space names that are specified with a wildcard must be UNCnames. For example, the specification?:\...\test.txt onlymatches files namedtest.txt which are specified in one or more ofthe following ways:\\server\d$\test.txt\\server\share\directory\test.txta:\diskette\test.txt

Character Class MatchingThe following examples show valid matches using character class:\\remote[a-z]\share\file.txtmatches \\remotea\share\file.txt\\remote\share[a-z]\file.txt

matches \\remote\sharex\file.txt\\remote\share\file[a-z].txt

matches \\remote\share\fileg.txt


7.C

reatingan

Include-Exclude

List

Setting Common Options

You can use defaults for processing options or you can tailor theprocessing options to meet specific needs. This chapter:¶ Provides an overview of processing options.¶ Explains how to create and modify a client options file.¶ Includes an options reference section that provides detailed

information about each option.

As a quick reference, this chapter includes instructions for thefollowing tasks:

Task Page

Creating and Modifying a Client Options File 127

Setting Options in the Client Options File 143

Using Options with Commands 144

Creating and Modifying a Client Options FileDuring the installation, Tivoli Storage Manager provides a sampleclient options file calleddsm.smp. This file contains processingoptions that are categorized as follows:¶ Communication options¶ Backup and archive processing options¶ Restore and retrieve processing options¶ Scheduling options¶ Format and language options¶ Command processing options

8


8.S

ettingC

omm

onO

ptions

¶ Authorization options¶ Error processing options¶ Transaction processing option¶ Web client options

Tivoli Storage Manager provides a sample options file nameddsm.smp. The dsm.smp file is a generic configuration file thatcontains communication parameters normally used in a Windowsenvironment.

When the installation process completes, the Setup Wizard launchesautomatically if nodsm.opt file exists to help you configure aninitial options file.

You can use one of the following methods to edit your client optionsfile:

¶ From the client GUI, clickUtilities and then clickSetupWizard .

¶ From the client GUI, clickEdit and then clickPreferences.

The preferences editor updates the client configuration file,dsm.opt, if any options change.

The preferences editor uses environment variables DSM_DIR andDSM_CONFIG to locate thedsm.opt file. The preferences editorqueries the server for options stored at the server, but only updatesthe client options file on the client. The preferences editor groupsoptions into categories:¶ General¶ Backup¶ Restore¶ Include-Exclude¶ Scheduler¶ Communication¶ Regional Settings¶ Authorization¶ Command Line¶ Diagnostics¶ Web client


You may use some optionsonly with commands. For moreinformation about these options, see “Using Options withCommands” on page 269.

Communication OptionsYou use communication options to specify how your client nodecommunicates with a Tivoli Storage Manager server.

For Windows NT or Windows 2000 you can use one of thefollowing protocols:¶ TCP/IP¶ Named Pipes

For Windows 98 and Me you can use the TCP/IP protocol.

Use thecommmethodoption to specify the communication protocol.For more information, see “Commmethod” on page 155.

You can also use thelanfreecommmethodoption to specify thecommunication protocol in a SAN environment. See“Lanfreecommmethod” on page 197 for more information.

Ask your Tivoli Storage Manager administrator for assistance insetting your communication options.

TCP/IP OptionsTo use the TCP/IP communication protocol, you must include thetcpserveraddressoption in your client options file. The other TCP/IPoptions have default values which you can modify only if you wantto change the default value.

Table 14. TCP/IP OptionsOption Description Page

httpport Specifies a TCP/IP port address for theTivoli Storage Manager Web client.

184


8.S

ettingC

omm

onO

ptions

Table 14. TCP/IP Options (continued)Option Description Page

httpsport Specifies a TCP/IP port address for theHTTPS secure socket layer (SSL)interface to the Tivoli Storage ManagerWeb client. This option is for AIX, AIX5L, and Windows clientsonly.

186

lanfreetcpport Specifies the TCP/IP port number wherethe Tivoli Storage Manager storage agentis listening.

198

tcpbuffsize Specifies the size, in kilobytes, of theTivoli Storage Manager internal TCP/IPcommunication buffer.

250

tcpnodelay Specifies that Tivoli Storage Managerimmediately sends small transactions tothe server.

253

tcpport Specifies the TCP/IP port address for aTivoli Storage Manager server.

254

tcpserveraddress Specifies the TCP/IP address for a TivoliStorage Manager server.

256

tcpwindowsize Specifies the size, in kilobytes, of theTCP/IP sliding window for your clientnode.

257

webports Enables the use of the Web client outsidea firewall by specifying the TCP/IP portnumber used by the Client Acceptorservice and the Web Client Agent servicefor communications with the Web GUI.

266


Named Pipes OptionThe communication option for Named Pipes is:

Table 15. Named Pipes Communication OptionOption Description Page

namedpipename Specifies the name of a named pipe touse for communications between a TivoliStorage Manager client and server on thesame Windows server domain.

208

Node OptionsUse the following option to specify the client node for which torequest backup-archive services.

Table 16. Node OptionsOption Description Page

clusternode Specifies whether Tivoli Storage Manageris running as a cluster node.

154

nasnodename Specifies the node name for the NAS fileserver.

209

nodename Specifies one of the following:¶ The name of your workstation so that

you can establish communicationswith the Tivoli Storage Managerserver.

¶ The name of another workstation.Use this if you want to restore orretrieve your files from a TivoliStorage Manager server to a differentworkstation than the one from whichyou stored the files.

210

virtualnodename Specifies the name of another clientnode. Use this option if you want torestore or retrieve your files from aTivoli Storage Manager server to a clientnode other than the one on which youstored files.

264


8.S

ettingC

omm

onO

ptions

Backup and Archive Processing OptionsYou can use the following options to control some aspects of backupand archive processing.

Table 17. Backup and Archive Processing OptionsOption Description Page

autofsrename Specifies whether to rename an existingfile space on a Unicode-enabled serverso a Unicode-enabled file space can becreated for the current operation. Thisoption is for Windows NT and Windows2000 clientsonly.

148

backupregistry Specifies whether to back up theWindows registry during domainincremental backup or backup whichincludes the Windows system drive.

152

changingretries Specifies the number of retries whenattempting to back up or archive a filethat is in use.

153

compressalways Specifies whether to continuecompressing an object if it grows duringcompression, or resend the objectuncompressed. This option is used withthe compressionoption.

158

compression Specifies whether to compress filesbefore sending them to the server.

159

dfsbackupmntpnt Specifies whether Tivoli StorageManager sees a DFS (NTFS or FAT) asa junction or a directory. This option isvalid for Windows 2000only.

163

dirmc Specifies the management class to usefor directories. If not specified, TivoliStorage Manager uses the managementclass with the longest retention period.

165


Table 17. Backup and Archive Processing Options (continued)Option Description Page

domain Specifies the drives to include in yourdefault client domain for an incrementalbackup.

166

domain.nas Specifies the volumes to include in yourdefault domain for nas backups. Thisoption is for Windows NT and Windows2000 clientsonly.

168

enablelanfree Specifies whether to enable an availableLAN-Free path to a storage areanetwork (SAN) attached storage device.

171

exclude Excludes a file or group of files frombackup services. Any file in your clientdomain that is not specifically excludedwith this option is considered forbackup. Equivalent to theexclude.backup, exclude.file, andexclude.file.backupoptions.

177

exclude.archive Excludes a file or group of files fromarchive services.

177

exclude.backup Excludes a file or a group of files frombackup services only. Equivalent to theexclude, exclude.file, andexclude.file.backupoptions.

177

exclude.compression Excludes files from compressionprocessing.

177

exclude.dir Excludes the specified directory, itsfiles, and all its subdirectories and theirfiles from backup services.

177

exclude.encrypt Excludes specified files from encryptionprocessing.

177

exclude.file Excludes files, but not directories, thatmatch a pattern. Equivalent to theexclude, exclude.file.backup, andexclude.backupoptions.

177


8.S

ettingC

omm

onO

ptions


exclude.file.backup Excludes a file from normal backupservices. Equivalent to theexclude,exclude.file, andexclude.backupoptions.

177

exclude.fs.nas Excludes file systems on the NAS fileserver from an image backup when usedwith the backup nascommand. If youdo not specify a NAS node name, thefile system identified applies to all NASservers. Thebackup nascommandignores all other exclude statementsincluding exclude.dirstatements. Thisoption is for Windows NT and Windows2000 clientsonly.

177

exclude.subfile Excludes files from adaptive subfilebackup processing.

177

guitreeviewafterbackup Specifies whether the client is returnedto the Backup, Restore, Archive, orRetrieve window after a successfuloperation completes.

183

inclexcl Specifies the path and file name of aninclude-exclude options file.

187

include Includes files or assigns managementclasses for backup or archiveprocessing.

189

include.archive Includes files or assigns managementclasses for archive processing.

189

include.backup Includes files or assigns managementclasses for backup processing.

189

include.compression Includes files for compressionprocessing.

189

include.encrypt Includes specified files for encryptionprocessing.

189

include.file Includes a file for backup services, orassigns a management class to a file.

189



include.fs.nas Assigns a management class when usedwith the backup nascommand. If youdo not specify a NAS node name, thefile system identified applies to all NASfile servers. Thebackup nascommandignores all other include statements.This option is for Windows NT andWindows 2000 clientsonly.

189

include.subfile Includes files for adaptive subfilebackup processing.

189

include.systemobject Assigns management classes for backupof Windows 2000 system objects. Bydefault, Tivoli Storage Manager bindsall system objects to the defaultmanagement class. You cannot use thisoption to bind individual systemobjectcomponents to a different managementclass. You cannot use this option toinclude or exclude a system object fromprocessing. This option is valid forWindows 2000only.

189

incrthreshold The incrthreshold option specifies thethreshold value for the number ofdirectories in any journaled file spacethat might have active objects on theserver, but no equivalent object on theworkstation.

195

memoryefficientbackup Specifies a memory-saving backupalgorithm for incremental backups whenused with theincremental command.

207

skipntpermissions Specifies whether to back up WindowsNT, 2000 security information.

240

skipntsecuritycrc Specifies whether to compute thesecurity CRC for permission comparisonduring subsequent backups. Use thisoption on Windows NT, 2000only.

241


8.S

ettingC

omm

onO

ptions


subdir Specifies whether to includesubdirectories of a named directory.

243

subfilebackup Specifies whether Tivoli StorageManager uses adaptive subfile backup.

245

subfilecachepath Specifies the path where the client cacheresides for adaptive subfile backupprocessing.

246

subfilecachesize Specifies the client cache size foradaptive subfile backup.

247

tapeprompt Specifies whether you want TivoliStorage Manager to wait for a taperequired for a backup or archive to bemounted, or whether to prompt you foryour choice.

248

Restore and Retrieve Processing OptionsThe following options relate to restore and retrieve processing.

Table 18. Restore and Retrieve Processing OptionsOption Description Page

activatekey Specifies whether to activate the registrykey to update the registry after restoringfiles.

147


183

localbackupset Specifies whether the Tivoli StorageManager GUI bypasses initial logonwith the server to restore a local backupset on a Windows standaloneworkstation.

202


Table 18. Restore and Retrieve ProcessingOptions (continued)Option Description Page

replace Specifies whether to overwrite anexisting file, or to prompt you for yourselection when you restore or retrievefiles.

224

subdir Specifies whether you want to includesubdirectories of a named directory.

243

tapeprompt Specifies whether you want TivoliStorage Manager to wait for a taperequired for a restore or retrieve to bemounted, or to prompt you for yourchoice.

248

Scheduling OptionsYou can use the following options to regulate central scheduling.Tivoli Storage Manager uses scheduling options only when theScheduler is running.

Table 19. Scheduling OptionsOption Description Page

managedservices Specifies the services to be managed bythe Tivoli Storage Manager ClientAcceptor.

204

maxcmdretries Specifies the maximum number of timesthe client scheduler attempts to process ascheduled command that fails.

206

postschedulecmd,postnschedulecmd

Specifies a command to process afterrunning a schedule.

218

preschedulecmd,prenschedulecmd

Specifies a command to process beforerunning a schedule.

220

queryschedperiod Specifies the number of hours the clientscheduler waits between unsuccessfulattempts to contact the server forscheduled work.

222


8.S

ettingC

omm

onO

ptions

Table 19. Scheduling Options (continued)Option Description Page

retryperiod Specifies the number of minutes theclient scheduler waits between attemptsto process a scheduled command thatfails or between unsuccessful attempts toreport results to the server.

228

runasservice Forces the client command process tocontinue running, even if the account thatstarted the client logs off. Use this optionon Windows NT and Windows 2000only.

230

schedcmddisabled Specifies whether to disable thescheduling of generic commandsspecified by your Tivoli Storage Manageradministrator.

231

schedlogname Specifies the name of the file whereschedule log information is stored.

233

schedlogretention Specifies the number of days to keep logfile entries in the schedule log, andwhether to save pruned entries.

234

schedmode Specifies which schedule mode to use,polling or prompted.

236

tcpclientaddress Specifies the TCP/IP address of yourclient node. Use this option only with theschedulecommand when you specifypromptedas the schedule mode.

251

tcpclientport Specifies the TCP/IP port number of yourclient node. Use this option only with theschedulecommand when you specifypromptedas the schedule mode.

252


Format and Language OptionsYou can use the following options to select different formats fordate, time, numbers, and for different languages if you have theappropriate client installed for that language.

Table 20. Format and Language OptionsOption Description Page

dateformat Specifies the format for displaying dates. 161

language Specifies the language used for messages. 199

numberformat Specifies the format for displayingnumbers.

212

timeformat Specifies the format for displaying time. 258

Command Processing OptionsThe following options apply when you use Tivoli Storage Managercommands.

Table 21. Command Processing OptionsOption Description Page

editor Specifies if the command-line interfaceeditor and command retrieve capabilityis turned on or off.

170


183

quiet Specifies that processing informationdoes not display on your screen. Thisoption can be overidden by the server.

223

scrolllines Specifies the number of lines to displayat one time when displaying a list ofitems. Use this option only whenscrollprompt is set toyes.

238


8.S

ettingC

omm

onO

ptions

Table 21. Command Processing Options (continued)Option Description Page

scrollprompt Specifies whether Tivoli StorageManager stops after displaying thenumber of lines specified byscrolllines,or it scrolls to the end of the list.

239

verbose Specifies that processing informationshould display on your screen. Thealternative isquiet. This option can beoverridden by the server.

263

Authorization OptionsThese options control access to a Tivoli Storage Manager server.

Table 22. Authorization OptionsOption Description Reference

encryptkey Specifies whether to save theencryption key locally or whether toprompt the user for the encryptionkey.

173

optfile Specifies the options file you wantto use when you start a session.

213

password Specifies a Tivoli Storage Managerpassword.

214

passwordaccess Specifies how Tivoli StorageManager handles a password if oneis required for your workstation.

216

revokeremoteaccess Restricts an administrator withclient access privileges fromaccessing your workstation throughthe Web client.

229


Error Processing OptionsThese options specify the name of the error log file and how TivoliStorage Manager treats the entries in the log file.

Table 23. Error Processing OptionsOption Description Page

errorlogname Specifies the path and name of the errorlog.

174

errorlogretention Specifies the number of days to keep logfile entries in the error log, and whetherto save pruned entries.

175

Transaction Processing OptionsThese options control how Tivoli Storage Manager processestransactions between the client and server.

Table 24. Transaction Processing OptionsOption Description Page

commrestartdurationSpecifies the maximum number ofminutes you want the client to try toreconnect to a Tivoli Storage Managerserver after a communication erroroccurs.

156

commrestartinterval Specifies the number of seconds youwant the client to wait between attemptsto reconnect to a Tivoli Storage Managerserver after a communication erroroccurs.

157

largecommbuffers Specifies whether the client will useincreased buffers to transfer largeamounts of data between the client andthe server.

201

resourceutilization Specifies the number of sessions openedbetween the Tivoli Storage Managerserver and client during processing.

226


8.S

ettingC

omm

onO

ptions

Table 24. Transaction Processing Options (continued)Option Description Page

txnbytelimit Specifies the number of kilobytes TivoliStorage Manager can buffer together in atransaction before sending data to theserver.

259

usedirectory Specifies whether the client should ignorecommmethodparameters set in the clientoptions file and query the ActiveDirectory for the communication methodand server with which to connect. Usewith Windows 2000only.

261

Web Client OptionsThe following are options for the Tivoli Storage Manager WebClient.

Table 25. Web Client OptionsOption Description Page

httpport Specifies a TCP/IP port address for theWeb client.

184

httpsport Specifies a TCP/IP Secure Socket Layer(SSL) port address for the Web client.This option is for AIX, AIX 5L, andWindows clientsonly.

186

managedservices Specifies whether the Tivoli StorageManager Client Acceptor daemonmanages the Web client.

204

revokeremoteaccess Restricts administrator access on a clientworkstation through the Web client.

229


Table 25. Web Client Options (continued)Option Description Page

webports Enables the use of the Web clientoutside a firewall by specifying theTCP/IP port number used by the TivoliStorage Manager Client Acceptorservice and the Web Client Agentservice for communications with theWeb GUI.

266

Setting Options in the Client Options FileThis section describes how to set options in your client optionsfiledsm.opt , and how to use options with commands.

To view or modify the options file, clickEdit and then clickPreferencesfrom the GUI. The graphical options editor updates theclient configuration options file if any options have changed.

You can edit the client options file with your favorite text editor.

To set an option in your client options file, enter the option nameand one or more blank spaces, followed by the option value. Forexample:

compression yesnodename client_a

Some options consist of only the option name, such asverboseandquiet. You can enter the entire option name or its abbreviation. Forexample, you can specify theverboseoption as either of thefollowing:

verboseve

Follow these additional rules when entering options in your clientoptions file:¶ Do not enter comments on the same line as an option.¶ Indent options with spaces or tabs.


8.S

ettingC

omm

onO

ptions

¶ Begin each comment with an asterisk (*) as the first character ina line.

¶ Enter each option on a separate line and enter all parameters foran option on the same line.

¶ Enter one or more blank spaces between parameters.¶ Use blank lines between options.¶ The maximum number of characters for a file name is 256. The

maximum combined length of the file name and path name is260 characters.

If you update the client options file while a GUI or Web clientsession is active, you must restart the session to pick up the changes.If you use the Setup Wizard to make changes, the changes areeffective immediately.

Using Options with CommandsYou can override some of the options in your options file byentering them with appropriate backup-archive commands.

Options are processed in the following order (precedence):1. Options defined on the server with server-enforced client options.

The server overrides client values.2. Options entered locally on the command line.3. Options defined on the server for a schedule using the options

parameters.4. Options entered locally in the options file.5. Options received from the server with client options not enforced

by the server. The serverdoes notoverride client values.6. Default option values.

Tivoli Storage Manager also includes a group of client commandoptions that you can enteronly on the command line with specificcommands. For a complete list of command line options, adescription, and where to go in this book for more information, see“Using Options with Commands” on page 269.

To use an option with a command, enter a dash (–), the option name,an equal sign (=), and the option parameters. For example,


dsmc incremental -domain=c:

For options that do not include parameters, enter a dash (–) and theoption name. For example,

dsmc incremental -quiet

Note: Use a leading dash (-) or forward slash (/) to indicate that thefollowing text is the name of an option. If an object namebegins with one of these characters you must surround it ineither single quotes (’) or double quotes (″). Most operatingsystem command line processors strip the quotes beforesubmitting the command line arguments to the Tivoli StorageManager client application. In such cases, using escapecharacters or doubling the quotes allows the client to receivethe quoted object name. In loop mode, surround such objectsin either single quotes (’) or double quotes (″).

You can enter the entire option name or its abbreviation. Forinformation about how to read the syntax diagrams, see “ReadingSyntax Diagrams” on page xxvii.

Entering Options with a CommandFollow these general rules to enter options with a command:

¶ Enter options before or after command parameters. For example,you can enter thesubdir option before or after a filespecification:

dsmc selective -subdir=yes c:\devel\proj1\*dsmc selective c:\devel\proj1\* -subdir=yes

¶ When entering several options on a command, separate eachoption with a blank space.

¶ Enclose the value in quotes (" ") if the option value that youenter contains a blank space. For example,

dsmc archive -description="Project A" "c:\devel\proj1\*"

¶ Any option that you enter on the command line, with theexception ofdomain, overrides the value set in the client optionsfile. When you use thedomain option with theincremental


8.S

ettingC

omm

onO

ptions

command, it adds to the domain specified in your client optionsfile rather than overriding the current value.

¶ The maximum number of characters for a file name is 256. Themaximum combined length of the file name and path name is260 characters.

Client Options ReferenceThe following sections contain detailed information about each ofthe Tivoli Storage Manager processing options. Information for eachoption includes:

¶ A description of the option.

¶ A syntax diagram of the option. The option name containsuppercase and lowercase characters. The uppercase charactersindicate the minimum abbreviation you can use for the optionname. See “Reading Syntax Diagrams” on page xxvii for anexplanation of these diagrams.

¶ Detailed descriptions of the option parameters. If the parameteris a constant (a value that does not change), use the minimumabbreviation.

¶ Examples of using the option in the client options file.

¶ Examples of using the option on the command line (ifapplicable). Options with a command line example ofDoes notapply cannot be used with command line or scheduledcommands.


ActivatekeyThe activatekey option specifies whether to activate the registry keyto update the registry after restoring files. Use this option with therestore registry command.

Syntax

ÊÊ ACTIVATEkeyYes

NoÊÍ

ParametersNo

Specifies that Tivoli Storage Manager should not update theregistry after restoring files.

YesSpecifies that Tivoli Storage Manager should update the registryafter restoring files. This is the default.

ExamplesOptions file:

activate yes

Command line:-activate=yes


8.S

ettingC

omm

onO

ptions

AutofsrenameThe autofsrenameoption renames an existing file space on a serverso that a Unicode-enabled file space with the original name can becreated for the current operation. The server can define theautofsrenameoption and override theautofsrenamesetting on theclient. This option is for Windows NT and Windows 2000 clientsonly.

When you specifyautofsrename yes in your client options file,and the server value ofautofsrenameis set toclient, TivoliStorage Manager generates a unique name by appending_OLD to thefile space name you specify in the current operation. For example,Tivoli Storage Manager renames the file space\\your-node-name\h$ to \\your-node-name\h$_OLD. If the newfile space name is too long, the suffix replaces the last characters ofthe file space name, as follows:

\\your-node-name_OLD

If the new file space name already exists on the server, TivoliStorage Manager renames the new file space\\your-node-name_OLDx, wherex is a unique number.

Tivoli Storage Manager proceeds to create new Unicode-enabled filespaces that contain only the data specified in the current operation.For example, to archive files from your H-disk named\\your-node\h$, issue the following archive command:

arc h:\logs\*.log

Before the archive takes place, the server renames the file space to\\your-node\h$_OLD. The archive places the data specified in thecurrent operation into the Unicode-enabled file space named\\your-node\h$. The new Unicode-enabled file space now containsonly the \logs directory and the *.log files specified in the operation.Tivoli Storage Manager stores all subsequent full and partialincremental, selective backup, and archive data in the newUnicode-enabled file spaces.


Renamed file spaces remain on the server as stabilized file spaces.These file spaces contain all the original data, which you can restoreas long as they remain on the server.

After installing the Windows NT, 2000 client, perform a fullincremental backup and rename all existing file spaces that are notUnicode enabled and back up the files and directories within themunder the new Unicode-enabled file spaces. This operation requiresincreased processing time and storage on the server.

File spaces that are not Unicode enabled can be viewed in thecharacter set of the locale from which Tivoli Storage Managerbacked up the files. A workstation running in a different locale maybe unable to view or restore from these file spaces. Unicode-enabledfile spaces that are backed up in one locale are visible in all otherlocales, provided that the workstation has the proper fonts installed.For more information on migrating to Unicode-enabled file spaces,see “Migrating to the Unicode-Enabled Client” on page 3.

To restore or retrieve from a file space that is not Unicode enabled,specify the source on the server and the destination on the client.See “Restoring from File Spaces that are not Unicode Enabled” onpage 400 for information on how to restore from file spaces that arenot Unicode enabled. See “Retrieving from File Spaces that are notUnicode Enabled” on page 431 for information on how to retrievefrom file spaces that are not Unicode enabled.

Place this option in the client options file (dsm.opt).

Syntax

ÊÊPrompt

AUTOFsrenameYesNo

ÊÍ


8.S

ettingC

omm

onO

ptions

ParametersYes

Specifies that Tivoli Storage Manager automatically renames allfile spaces that are not Unicode enabled in the current backup orarchive operation.

NoSpecifies that Tivoli Storage Manager does not rename filespaces that are not Unicode enabled in the current backup orarchive operation.

PromptSpecifies that Tivoli Storage Manager prompts you whether torename the file spaces that are not Unicode enabled in thecurrent operation. This is the default.

Considerations:

1. This option applies when the server sets theautofsrenameoptionto client.

2. When the client scheduler is running, the default behavior is tonot prompt. The next interactive session prompts you to renamethe file space.

3. The client prompts one time per file spaceonly. If you specifyno at the prompt, the client cannot rename the file spaces later.However, the Tivoli Storage Manager administrator can renamethe file spaces on the server.

4. When backing up files to a file space that is not Unicodeenabled, the Unicode-enabled client skips the files and directorieswith names containing characters from a code page that isdifferent from the current locale.

5. If files and directories with names containing characters from acode page other than the current locale were previously backedup with a client that was not Unicode enabled, they may beexpired. The Unicode-enabled client expires these files if you donot migrate the file space to a Unicode-enabled file space. Youcan back up and archived these files to a Unicode-enabled filespace.



autofsrename yes


8.S

ettingC

omm

onO

ptions

BackupregistryThe backupregistryoption specifies whether to back up theWindows registry during domain incremental backup or backupswhich include the Windows system drive.

On the native and Web GUIs, this option is only valid whenexecuting theBackup Domain action.

Note: For Windows 2000, this option is ignored if you specifysystemobjectin a domain statement during an incrementalbackup.

Syntax

ÊÊYes

BACKUPRegistryNo

ÊÍ

ParametersYes

The Tivoli Storage Manager program backs up the registryduring incremental backups that include the system drive. This isthe default.

NoThe Tivoli Storage Manager program does not back up theregistry.


backupreg no

Command line:-backupreg=yes

This option is valid only on the initial command line. It isnot valid in interactive mode.


ChangingretriesThe changingretriesoption specifies how many additional times youwant the client to attempt to back up or archive a file that is in use.Use this option with thearchive, incremental, andselectivecommands.

Use this option only whenserialization, an attribute in amanagement class copy group, isshared staticor shared dynamic.

With shared staticserialization, if a file is open during an operation,the operation repeats the number of times that you specified. If thefile is open during each attempt, the operation does not complete.

With shared dynamicserialization, if a file is open during anoperation, the operation repeats the number of times that youspecified. The backup or archive occurs during the last attemptwhether the file is open or not.

Note: The server can also define this option.

Syntax

ÊÊ »CHAngingretries numberretries ÊÍ

Parametersnumberretries

Specifies the number of times a backup or archive operation isattempted if the file is in use. The range of values is zerothrough 4; the default is 4.


changingretries 3

Command line:-cha=0


8.S

ettingC

omm

onO

ptions

ClusternodeThe clusternodeoption specifies whether Tivoli Storage Managermanages cluster drives in a Microsoft Cluster Server (MSCS)environment. For information on how to configure a cluster server,see the Appendix inTivoli Storage Manager Installing the Clients,SH26-4119.

This option is for Windows NT and Windows 2000 clientsonly.

Syntax

ÊÊNo

CLUSTERnodeYes

ÊÍ

ParametersYes

Specifies that you want to back up cluster resources.

NoSpecifies that you want to back up local disks. This is thedefault.


cluster no

Command line:-cluster=yes



CommmethodThe commmethodoption specifies the communication method youuse to provide connectivity for client-server communication.

SyntaxÊÊ COMMMethod TCPip

NAMedpipesÊÍ

ParametersTCPip

The Transmission Control Protocol/Internet Protocol (TCP/IP)communication method.

NAMedpipesThe interprocess communication method that permits messagedata streams to pass between a client and a server. Use thiscommunication method with a Windows NT server running onthe same workstation as the client.


commm tcp

Command line:-commmethod=tcp



8.S

ettingC

omm

onO

ptions

CommrestartdurationThe commrestartdurationoption specifies the maximum number ofminutes you want the client to attempt to reconnect with a serverafter a communication error occurs.

Note: If a communication failure occurs when a schedule is running,the scheduled operation fails if the client cannot reconnectwith the server before the startup window for the scheduleends.

You can use thecommrestartdurationoption and thecommrestartintervalin busy or unstable network environments todecrease connection failures.

SyntaxÊÊ COMMRESTARTDuration minutes ÊÍ

Parametersminutes

The maximum number of minutes you want the client to attemptto reconnect with a server after a communication failure occurs.The range of values is zero through 9999; the default is 60.


commrestartduration 90

Command line:Does not apply.


CommrestartintervalThe commrestartintervaloption specifies the number of seconds youwant the client to wait between attempts to reconnect with a serverafter a communication error occurs.

Note: Use this option only whencommrestartdurationis a valuegreater than zero.

You can use thecommrestartdurationoption and thecommrestartintervalin busy or unstable network environments todecrease connection failures.

SyntaxÊÊ COMMRESTARTInterval seconds ÊÍ

Parametersseconds

The number of seconds you want the client to wait betweenattempts to reconnect with a server after a communication failureoccurs. The range of values is zero through 65535; the default is15.


commrestartinterval 30



8.S

ettingC

omm

onO

ptions

CompressalwaysThe compressalwaysoption specifies whether to continuecompressing an object if it grows during compression, or resend theobject uncompressed. Use this option with thecompressionoption.

Use thecompressalwaysoption with thearchive, incremental, andselectivecommands.


Syntax

ÊÊYes

COMPRESSAlwaysNo

ÊÍ

ParametersYes

File compression continues even if the file grows as a result ofcompression. This is the default.

NoBackup-archive client objects are resent uncompressed if theygrow during compression. API behavior depends on theapplication. Application backups may fail.


compressalways yes

Command line:-compressa=no

This option is valid only on the initial command line.


CompressionThe compressionoption compresses filesbeforeyou send them tothe server. Compressing your files reduces data storage for backupversions and archive copies of your files. It can, however, affectTivoli Storage Manager throughput. A fast processor on a slownetwork connection benefits from compression, but a slow processoron a fast network connection does not.

For Windows NT, 2000: Tivoli Storage Manager backs up namedstreams on a file basis only. Tivoli Storage Manager does notsupport the backup of a named stream containing sparse file data.Tivoli Storage Manager backs up a sparse file as a regular file ifclient compression is off. Specifycompression=yesto enable filecompression when backing up sparse files to minimize networktransaction time and maximize server storage space.

If you specifycompressalways=yes, compression continues even ifthe file size increases. To stop compression if the file size grows,and resend the file uncompressed, specifycompressalways=No.

If you specifycompression=yes, you can control compressionprocessing in the following ways:¶ Use theexclude.compressionoption in your client options file to

exclude specific files or groups of files from compressionprocessing. See “Exclude Options” on page 177 for moreinformation.

¶ Use theinclude.compressionoption in your client options file toinclude files within a broad group of excluded files forcompression processing. See “Include Options” on page 189 formore information.

This option controls compressiononly if your administrator specifiesthat your client node can compress files before sending them to theserver.

Use thecompressionoption with thearchive, incremental, andselectivecommands.



8.S

ettingC

omm

onO

ptions

Syntax

ÊÊNo

COMPRESSIonYes

ÊÍ

ParametersNo

Files are not compressed before they are sent to the server. Thisis the default.

YesFiles are compressed before they are sent to the server.


compression yes

Command line:-compressi=no


DateformatThe dateformatoption specifies the format you want to use todisplay dates.

Use this option if you want to change the default date format for thelanguage of the message repository you are using.

Notes:

1. Thisdateformatoption does not affect the Web client. The Webclient uses the date format for the locale that the browser isrunning in. If the browser is not running in a locale that TivoliStorage Manager supports, the Web client uses the date formatfor American English.

2. When you change the date format and use theschedlogretentionoption to prune the schedule log, Tivoli Storage Managerremoves all entries in the schedule log with a different dateformat when pruning the log. When you change the date formatand use theerrorlogretentionoption to prune the error log,Tivoli Storage Manager removes all entries in the error log witha different date when pruning the log. When changing the dateformat, copy the schedule log and error log if you want topreserve log entries that contain a different date format.

SyntaxÊÊ DATEformat format_number ÊÍ

Parametersformat_number

Displays the date using one of the following formats. Select thenumber that corresponds to the date format you want to use:1 MM/DD/YYYY (This is the default)2 DD-MM-YYYY3 YYYY-MM-DD4 DD.MM.YYYY5 YYYY.MM.DD


8.S

ettingC

omm

onO

ptions


dateformat 3

Command line:-date=4

This option is valid on the initial command line and ininteractive mode. If you use this option in interactive mode,it remains in effect for the entire interactive session or untilyou enter anotherdateformatoption.


DfsbackupmntpntThe dfsbackupmntpntoption specifies whether Tivoli StorageManager views a Microsoft DFS junction residing on an NTFS orFAT drive as a junction or a directory. If Tivoli Storage Managerviews Microsoft DFS junction as a junction, only the name of themounted junction is backed up or archived. The subtree under thejunction point is not backed up or archived.

Place this option in the client options file (dsm.opt). You canspecify this option by using the preferences editor. This option isvalid for Windows 2000only.

This option is effective only when you back up or archive aMicrosoft DFS root and is ignored when you back up or archive aMicrosoft DFS junction. To restore a DFS tree, the root of the treemust already exist.

For more information on backing up a DFS root, see “Backing UpMicrosoft Dfs Files” on page 60.

Syntax

ÊÊYes

DFSBackupmntpntNo

ÊÍ

ParametersYes

Specifies that Tivoli Storage Manager views all Microsoft DFSjunctions asjunctionsand backs up only the name of anymounted junction it encounters during a backup operation. Thisis the default.

NoSpecifies that Tivoli Storage Manager views all Microsoft DFSjunctions asdirectoriesand backs up the contents of files andsubdirectories of any junction it encounters during a backupoperation.


8.S

ettingC

omm

onO

ptions


dfsbackupmntpnt no



DirmcThe dirmc option specifies the management class you want to usefor directories. If you do not specify this option to associate amanagement class with directories, the client program uses themanagement class in the active policy set of your policy domainwith the longest retention period. Select a management class forindividual directories that retains directories at least as long as itretains the files associated with them.

If you specify a management class with this option, all directoriesspecified in a backup operation are bound to that management class.

The dirmc option specifies the management class of directories youback up and does not effect archived directories. Archived directoriesare always bound to the default management class.

The server can also define this option.

SyntaxÊÊ DIRMc mgmtclassname ÊÍ

Parametersmgmtclassname

Specifies the name of the management class you want toassociate with directories. The management class name that youspecify is used for all directories that you back up. If you do notuse this option, the management class with the longest retentionperiod is associated with directories.


dirm managdir

Command lineDoes not apply.


8.S

ettingC

omm

onO

ptions

DomainThe domain option specifies the drives that you want to include forincremental backup in your client domain. The server can also definethis option.

Use thedomain option in your client options file to define yourdefault client domain. Tivoli Storage Manager uses your defaultclient domain in the following situations to determine which localdrives to process during an incremental backup:

¶ When you run an incremental backup using theincrementalcommand and you do not specify which local drives to process.

¶ When your administrator defines a schedule to run anincremental backup for you, but does not specify which localdrives to process.

If you do not use thedomain option to specify local drives in yourclient options file, Tivoli Storage Manager uses theall-localparameter as the default.

When you use thedomain option with theincremental command,Tivoli Storage Manager adds local drives that you specify to thelocal drives defined in your client options file. For example, if youenter the following in your client options file:

domain c: d: e:

and the following on the command line:dsmc incremental -domain="g: h:"

Tivoli Storage Manager performs an incremental backup for yourc:d: e: g: andh: local drives.

If you use both a file specification and thedomain option with theincremental command, Tivoli Storage Manager ignores thedomainoption and processes only those drives specified in the filespecification. For example, if you enter:

dsmc incremental e: f: -domain="g: h:"


Tivoli Storage Manager performs an incremental backup for thee:and f: drivesonly.

Syntax

ÊÊ »all-local

DOMaindomainsystemobject

ÊÍ

Parametersall-local

Backs up all local hard drives. For Windows 2000: Thesystemobjectdomain is included in all-local processing. This isthe default.

domainDefines the drives to include in your default client domain.

When you usedomain with the incremental command, itprocesses these drives in addition to those specified in yourdefault client domain.

systemobjectBacks up all relevant system objects. Systemobject is included ifall-local is specified. This is valid for Windows 2000only.


domain c: d: e:

domain c: systemobject (Windows 2000 only)

Command line:-domain=“c: d:”


8.S

ettingC

omm

onO

ptions

Domain.nasThe domain.nasoption specifies the volumes to include in yourNAS image backups. You can specifyall-nas to include all themounted file systems on the NAS file server, except those youexclude with theexclude.fs.nasoption. When you use this option inyour client options file (dsm.opt), thedomain.nasoption definesyour default domain for NAS image backups.

Tivoli Storage Manager uses your domain for NAS image backupswhen you run abackup nascommand and you do not specifywhich volumes to process.

When you perform a NAS file system image backup using thebackup nascommand, Tivoli Storage Manager adds volumes thatyou specify on the command line to the volumes defined in yourdsm.opt file. For example, if you enter the following in yourdsm.opt file:domain.nas nas1/vol/vol0 nas1/vol/vol1

and you enter the following on the command linedsmc backup nas -nasnodename=nas1 /vol/vol2

Tivoli Storage Manager performs a backup for the followingvolumes on nodenas1: vol/vol0, vol/vol1, andvol/vol2.

When performing a backup, if you use a file specification andspecifydomain.nas=all-nas in the dsm.opt file, all-nas takesprecedence. Tivoli Storage Manager processes all mounted volumeson the NAS file server.

The domain.nasoption is valid for Windows NT and Windows 2000clientsonly




Syntax

ÊÊ »all-nas

DOMAIN.Nasdomain

ÊÍ

Parametersdomain

Defines the volumes you want to process.

all-nasProcesses all mounted volumes on the NAS file server, exceptthose you exclude with theexclude.fs.nasoption. This is thedefault.


domain.nas nas1/vol/vol0 nas1/vol/vol1domain.nas all-nas



8.S

ettingC

omm

onO

ptions

EditorThe editor option turns the command line interface (CLI) editor andretrieve capability on or off.

For Windows NT and Windows 2000, this option is always off, evenif you explicitly specifyyes. This is because the client uses thecommand line history capabilities of the Windows NT and Windows2000 command line console. If the editor and command retrievefunctions are not working on a specific workstation setting, werecommend that you turn off this function.

Syntax

ÊÊYes

EditorNo

ÊÍ

ParametersYes

Turns on the CLI editor and command retrieve capability. This isthe default. However, for Windows NT or Windows 2000 thevalue for this option is alwayseditor=No.

NoTurns off the CLI editor and command retrieve capability.


editor yes



Enablelanfree

The enablelanfreeoption specifies whether to enable an availableLAN-Free path to a storage area network (SAN) attached storagedevice. A LAN-Free path allows backup, restore, archive, andretrieve processing between the Tivoli Storage Manager client andthe SAN-attached storage device.

To support LAN-Free data movement you must install and configurethe Tivoli Storage Manager Managed System for SAN feature on theclient workstation. For more information, refer toTivoli StorageManager for Windows Managed System for SAN Storage AgentUser’s Guide, GC35-0434.


To specify a communication protocol between the Tivoli StorageManager client and Storage Agent, see “Lanfreecommmethod” onpage 197 for more information.

Note: To restore backup sets in a SAN environment, see “RestoreBackupset” on page 407 for more information.

Syntax

ÊÊNo

ENABLELanfreeYes

ÊÍ

ParametersYes

Specifies that you want to enable an available LAN-Free path toa SAN-attached storage device.

NoSpecifies that you do not want to enable a LAN-Free path to aSAN-attached storage device. This is the default.


8.S

ettingC

omm

onO

ptions


enablelanfree yes

Command line:-enablelanfree=yes.


EncryptkeyThe encryptkeyoption specifies whether to save the encryption keylocally when performing a backup-archive operation or whether toprompt for the encryption key. The encryption key password is savedto the Registry in encrypted format. If you save the encrypted keypassword, you are not prompted for it each time you perform abackup, archive, or restore. Place this option in your client optionsfile.

Note: The Web client saves the encryption key password in theRegistry. If there no key is saved, you are prompted for the initialencryption key password when you begin encryption processing.

Syntax

ÊÊsave

ENCryptkeyprompt

ÊÍ

Parameterssave

Specifies that you want to save the encryption key password to alocal file Registry in encrypted format. When you specifysave,Tivoli Storage Manager does not prompt for the password foreach backup and restore operation. This is the default.

promptSpecifies that you want to save the encryption key password to alocal file. Tivoli Storage Manager prompts for the password foreach backup and restore operation.


encryptkey prompt

Command line:-encryptkey=prompt


8.S

ettingC

omm

onO

ptions

ErrorlognameThe errorlognameoption specifies the fully qualified path and filename of the file where you want to store information about errorsthat occur during processing. The value for this option overrides theDSM_LOG or DSM_DIR environment variables. Thedsmwebcl.loganddsmsched.log files will be created in the same directory asdsmerror.log.

SyntaxÊÊ ERRORLOGName filespec ÊÍ

Parametersfilespec

The fully qualified path and file name where you want to storeerror log information. Ensure that all directories andsubdirectories in the path exist and are accessible by clientprocessing. Tivoli Storage Manager will not create directories foryou.

The default is the path indicated by the DSM_LOG orDSM_DIR environment variable. If DSM_LOG or DSM_DIRare not specified, thedsmerror.log file will reside in thecurrent working directory.


errorlogname c:\temp\dsmerr.log

Command line:

-errorlog=c:\temp\dsmerr.log



ErrorlogretentionThe errorlogretentionoption specifies how many days to maintainerror log entries before pruning, and whether to save the prunedentries. The error log is pruned when the first error is written to thelog after a Tivoli Storage Manager session is started. If the onlysession you run is the client scheduler, and you run it twenty-fourhours a day, the error log might not be pruned according to yourexpectations. Stop the session and start it again to prune the errorlog when the next error is written.

Syntax

ÊÊN D

ERRORLOGRetentiondays S

ÊÍ

ParametersN or days

Specifies how long to wait before pruning the error log.

N Do not prune the error log. This permits the error log togrow indefinitely. This is the default.

daysThe number of days to keep log file entries before pruningthe log. The range of values is zero through 9999.

D or SSpecifies whether to save the pruned entries. Enter a space orcomma to separate this parameter from the previous one.

D Discard the error log entries when you prune the log. This isthe default.

S Save the error log entries when you prune the log.

The pruned entries are copied from the error log to thedsmerlog.pru file located in the same directory as the errorlog.


8.S

ettingC

omm

onO

ptions


errorlogretention 400 S

Command line:-errorlogr=400,S



Exclude OptionsThe exclude options exclude objects from backup or archiveservices. For example, you might want to exclude all temporaryfiles, any local caches of network files, all files that containcompiled object code that you can easily reproduce using othermethods, or your operating system files.

You can exclude specific files from encryption processing during abackup.

You can exclude remotely accessed files by specifying UniversalNaming Convention(UNC) names in your exclude statement. See“Excluding Files with UNC Names” on page 118 for examples ofstatements using UNC file names.

Notes:

1. When you exclude a file that was previously included, existingbackup versions become inactive during the next incrementalbackup.

2. Theexcludestatements are not case sensitive.

3. The server can define exclude options with theinclexcl option.

Exclude any system files that could corrupt the operating systemwhen recovered. You should also exclude the client directorycontaining the client files.

Use wildcard characters to exclude a broad range of files. See“Including and Excluding Groups of Files” on page 118 for a list ofwildcard characters that you can use. Then, if necessary, use theinclude option to make exceptions.

To exclude an entire directory calledany\test , enter the following:exclude.dir c:\any\test

To exclude subdirectories that begin withtest under theanydirectory, enter the following:

exclude.dir c:\any\test*


8.S

ettingC

omm

onO

ptions

Attention: See “Excluding System Files” on page 117 for a list offiles that you should always exclude.

Compression ProcessingIf you want to exclude specific files or groups of files fromcompression processing during a backup or archive operation,consider the following:

¶ You must specifycompression=yesto enable compressionprocessing. If you do not specify thecompressionoption or youspecifycompression=no, Tivoli Storage Manager does notperform compression processing. See “Compression” onpage 159 for more information.

If you specifycompression=yesand noexclude.compressionstatements exist, Tivoli Storage Manager considers all files forcompression processing.

¶ Tivoli Storage Manager processesexclude.dirand otherinclude-exclude statements first. Tivoli Storage Manager thenconsiders anyexclude.compressionstatements. For example,consider the following include-exclude list:exclude c:\test\*.*exclude.compression c:\test\file.txtinclude c:\test\file.txt

Tivoli Storage Manager examines the first and last statements(reading from bottom to top) and determines thatc:\test\file.txt is a candidate for back up. Tivoli StorageManager then examines theexclude.compressionc:\test\file.txt statement and determines that it is not acandidate for compression processing.

¶ Include-exclude compression processing is valid for backup andarchive processingonly.

¶ For Windows NT, 2000: As with other include-excludestatements, you can specifyexclude.compressionstatements inUnicode using theinclexcl option. See “Inclexcl” on page 187for more information.


Adaptive Subfile Backup ProcessingIf you want to exclude files from adaptive subfile backup processingusing theexclude.subfileoption, consider the following:

¶ You must specifysubfilebackup=yesto enable include-excludeadaptive subfile backup processing. If you do not specify thesubfilebackupoption or you specifysubfilebackup=no, TivoliStorage Manager does not perform adaptive subfile backupprocessing. See “Subfilebackup” on page 245 for moreinformation.

If you specifysubfilebackup=yesand noexclude.subfilestatements exist, Tivoli Storage Manager considers all files foradaptive subfile backup processing.

¶ Tivoli Storage Manager processesexclude.dirand otherinclude-exclude statements first. Tivoli Storage Manager thenconsiders anyexclude.subfilestatements. For example, considerthe following include-exclude list:exclude c:\test\*.*exclude.subfile c:\test\file.txtinclude c:\test\file.txt

Tivoli Storage Manager examines the first and last statements(reading from bottom to top) and determines thatc:\test\file.txt is a candidate for back up. Tivoli StorageManager then examines theexclude.subfilec:\test\file.txt statement and determines that it is not acandidate for adaptive subfile backup

¶ Include-exclude adaptive subfile backup processing is valid forbackup and restore processingonly.

¶ For Windows NT, 2000: As with other include-excludestatements, you can specifyexclude.subfilestatements inUnicode using theinclexcl option. See “Inclexcl” on page 187for more information.

Processing NAS File SystemsUse theexclude.fs.nasoption to exclude file systems from NetworkAttached Storage (NAS) image backup processing.


8.S

ettingC

omm

onO

ptions

A NAS file system specification uses the following conventions:¶ NAS nodes represent a new node type. The NAS node name

uniquely identifies a NAS file server and its data to TivoliStorage Manager. You can prefix the NAS node name to the filespecification to specify the file server to which the excludestatement applies. If you do not specify a NAS node name, thefile system you specify applies to all NAS file servers.

¶ Regardless of the client platform, NAS file system specificationsuse the forward slash (/) separator, as in this example:/vol/vol0.

¶ You cannot use wildcards withexclude.fs.nasand include.fs.nasstatements.

For example, to exclude the/vol/vol1 file system of a NAS nodecallednetappsj, specify the following exclude statement:exclude.fs.nas netappsj/vol/vol1

To exclude/vol/vol1 from backup services on all NAS nodes,specify the following exclude statement:exclude.fs.nas /vol/vol1

Syntax

ÊÊ » options pattern ÊÍ

excludeExcludes files that match the pattern from backup services.When you back up files, any files you exclude with this optionare not considered for backup.

exclude.archiveExcludes a file or a group of files that match the pattern fromarchive servicesonly.

exclude.backupExcludes a file or a group of files that match the pattern frombackup servicesonly.


exclude.compressionExcludes files from compression processing ifcompression=yesis specified.

exclude.dirExcludes a directory, its files, and all its subdirectories and theirfiles from backup services. Theexclude.diroption works only ifthe excluded directory is a subdirectory. Use this option toexclude a portion of your data in which no underlying files needto be backed up.

When you exclude a directory, you can still back up specificfiles within that directory using a selective backup. However, thenext time you perform an incremental backup, these backupversions are expired. If you exclude a directory that waspreviously included, Tivoli Storage Manager marks existingbackup versions inactive during next incremental.

exclude.encryptExcludes the specified files from encryption processing.

exclude.fileExcludes files, but not directories, that match the pattern.

exclude.file.backupExcludes files that match the pattern from normal backupservices.

exclude.fs.nasExcludes file systems on the NAS file server from an imagebackup when used with thebackup nascommand. If you do notspecify a NAS node name, the file system identified applies toall NAS file servers. Thebackup nascommand ignores all otherexclude statements includingexclude.dirstatements. This optionis for Windows NT and Windows 2000 clientsonly.

exclude.subfileExcludes files from adaptive subfile backup processing. Thisoption is valid for all Windows clients.


8.S

ettingC

omm

onO

ptions

Parameterspattern

Specifies the file or group of files that you want to exclude frombackup services. End the pattern with a file specification.

Note: For NAS file systems: You must prefix the NAS nodename to the file specification to specify the file server towhich the exclude statement applies. If you do not specifya NAS node name, the file system identified refers to theNAS nodename specified in the client options file(dsm.opt) or on the command line.

If the pattern begins with a single or double quote or containsany embedded blanks or equal signs, you must surround thevalue in either single (’) or double (″) quotation marks. Theopening and closing quotation marks must be the same type ofquotation marks.


exclude ?:\...\swapper.datexclude "*:\ea data. sf"exclude ?:\io.sysexclude ?:\...\spart.parexclude c:\*\budget.finexclude c:\devel\*exclude.dir c:\home\joddaexclude.archive c:\home\*.objexclude.encrypt c:\system32\mydocs\*exclude.compression c:\test\file.txtexclude.subfile c:\test\file.txtexclude.fs.nas netappsj/vol/vol0



GuitreeviewafterbackupThe guitreeviewafterbackupoption specifies whether the clientreturns to the Backup, Restore, Archive, or Retrieve window after asuccessful operation completes.

Syntax

ÊÊNo

GUITREEViewafterbackupYes

ÊÍ

ParametersNo

Returns you to the Tivoli Storage Manager main window after asuccessful operation completes. This is the default.

YesReturns you to the Backup, Restore, Archive, or Retrievewindow after a successful operation completes.


guitreeviewafterbackup yes



8.S

ettingC

omm

onO

ptions

HttpportThe httpport option specifies a TCP/IP port address for the Webclient.

Tivoli Storage Manager Firewall SupportThe webportsoption enables the use of the Web client outside afirewall by specifying the TCP/IP port number used by the TivoliStorage Manager Client Acceptor service and Web Client Agentservice for communications with the Web GUI.

The ports you specify with thewebportsoption and the client optionhttpport must be opened in the firewall.

To enable the backup-archive client, Command Line Admin client,and the Scheduler (running in polling mode) to run outside afirewall, the port specified by the server optiontcpport (default1500) must be opened in the firewall.

Note: Tivoli Storage Manager does not support the schedulerrunning inpromptedmode outside a firewall.

See “Tcpport” on page 254 and “Webports” on page 266 for moreinformation. See “Tivoli Storage Manager Firewall Support” onpage 27 for further considerations regarding Tivoli Storage Managerfirewall support.

SyntaxÊÊ HTTPport port_address ÊÍ

Parametersport_address

Specifies the TCP/IP port address that is used to communicatewith the Web client. The range of values is 1000 through 32767;the default is 1581.



httpport 1502

Command line:-httpport=1502 (Windows Windows 98, Windows Me)


8.S

ettingC

omm

onO

ptions

HttpsportThe httpsportoption specifies a TCP/IP port address for the HTTPSsecure socket layer (SSL) interface to the Web client.

SyntaxÊÊ HTTPSport port_address ÊÍ


Specifies the TCP/IP port address that is used by the HTTPSsecure socket layer (SSL) interface to communicate with theWeb client. The range of values is 0 and 1000 through 32767;the default is 0 which disables HTTPS.


httpsport 1548

Command line:-httpsport (Windows 98, Me)


InclexclThe inclexcl option specifies the path and file name of aninclude-exclude options file.

Place theinclexcl option in the include-exclude list in your clientoptions file.

Multiple inclexcl statements are permitted. However, you mustspecify this option for each include-exclude file.

Ensure that you soter your include-exclude options file in a directoryto which all users have read access.

When processing occurs, the include-exclude statements within theinclude-exclude file are placed in the list position occupied by theinclexcl option and processed accordingly.

Considerations for Windows NT, 2000 ClientsFor Windows NT and Windows 2000 clients, the include-exclude filecan be in Unicode or non-Unicode format. If you specify anon-Unicode include-exclude file, the file name must be in the samecode page as the one that the client is running.

A Unicode include-exclude file provides the following benefits:¶ Names with characters from another code page no longer have

to be identified with wildcard characters.¶ File names and directories from any code page can befully

specifiedfor the client to process.

To create an include-exclude file in Unicode format, perform thefollowing steps:1. Open Notepad.2. List your include andexcludestatements. See Table 8 on

page 114 for include-exclude options you can use. You may needto copy file names with characters from other code pages usingMicrosoft Windows Explorer.

3. Click File and then clickSave As. The Save As window isdisplayed.


8.S

ettingC

omm

onO

ptions

4. Select theSave as Unicodecheckbox, specify the file and targetdirectory, and save the file.

5. Place aninclexcl option specifying the include-exclude file youjust created in your client options file

For more information about creating an include-exclude options file,see “Creating an Include-Exclude List” on page 111.

SyntaxÊÊ INCLExcl filespec ÊÍ

Parametersfilespec

Specifies the path and file name ofone include-exclude optionsfile.


inclexcl c:\dsm\backup.excl



Include OptionsThe include options specify one of the following:

¶ Objects within a broad group of excluded objects that you wantto include for backup and archive services.

¶ Files within a broad group of excluded files that you want toinclude for encryption processing.

¶ Files within a broad group of excluded files that you want toinclude for compression processing.

¶ Files that are included for backup or restore processing that youalso want to include for adaptive subfile backup processing.

¶ Objects to which you want to assign a specific managementclass and a management class name.

¶ A management class to assign to all objects to which you do notexplicitly assign a management class.

If you do not assign a specific management class to objects, TivoliStorage Manager uses the default management class in the activepolicy set of your policy domain.

You can include remotely accessed files by specifying UniversalNaming Convention(UNC) names in your include statement. See“Excluding Files with UNC Names” on page 118 for examplestatements using UNC file names.

Notes:1. An include option cannot override anexclude.diroption.2. The include statements are not case sensitive.3. The server can also define these options with theinclexcl option.

Compression ProcessingIf you want to include specific files or groups of files forcompression processing during a backup or archive operation,consider the following:

¶ You must specifycompression=yesto enable compressionprocessing. If you do not specify thecompressionoption or you


8.S

ettingC

omm

onO

ptions

specifycompression=no, Tivoli Storage Manager does notperform compression processing. See “Compression” onpage 159 for more information.

¶ Tivoli Storage Manager processesexclude.dirand otherinclude-exclude statements first. Tivoli Storage Manager thenconsiders anyinclude.compressionstatements. For example,consider the following include-exclude list:include.compression c:\test\file.txtexclude c:\test\file.txt

Tivoli Storage Manager examines theexcludec:\test\file.txt statement first and determines thatc:\test\file.txt is excluded from processing and is not acandidate for compression processing.

¶ Include-exclude compression processing is valid for backup andarchive processingonly.

¶ For Windows NT, 2000: As with other include-excludestatements, you can specifyinclude.compressionstatements inUnicode using theinclexcl option. See “Inclexcl” on page 187for more information.

Adaptive Subfile Backup ProcessingIf you want to include files for adaptive subfile backup processingusing theinclude.subfileoption, consider the following:

¶ You must specifysubfilebackup=yesto enable include-excludeadaptive subfile backup processing. If you do not specify thesubfilebackupoption or you specifysubfilebackup=no, TivoliStorage Manager does not perform adaptive subfile backupprocessing. See “Subfilebackup” on page 245 for moreinformation.

¶ Include-exclude adaptive subfile backup processing is valid forbackup and restore processingonly.

¶ Tivoli Storage Manager processesexclude.dirand otherinclude-exclude statements first. Tivoli Storage Manager thenconsiders anyinclude.subfilestatements. For example, considerthe following include-exclude list:


include.subfile c:\test\file.txtexclude c:\test\file.txt

Tivoli Storage Manager examines theexcludec:\test\file.txt statement first and determines thatc:\test\file.txt is excluded from processing and is not acandidate for subfile processing.

¶ For Windows NT, 2000: As with other include-excludestatements, you can specifyinclude.subfilestatements inUnicode using theinclexcl option. See “Inclexcl” on page 187for more information.

Processing NAS File SystemsUse theinclude.fs.nasoption to bind a management class toNetwork Attached Storage (NAS) file systems for backup processing.

A NAS file system specification uses the following conventions:¶ NAS nodes represent a new node type. The NAS node name

uniquely identifies NAS file server and its data to Tivoli StorageManager. You can prefix the NAS node name to the filespecification to specify the file server to which the includestatement applies. If you do not specify a NAS node name, thefile system you specify applies to all NAS file servers.

¶ Regardless of the client platform, NAS file system specificationsuse the forward slash (/) separator, as in this example:/vol/vol0.

¶ You cannot use wildcards withinclude.fs.nasandexclude.fs.nasstatements.

For example, to assign a management class to the/vol/vol1 filesystem of a NAS node callednetappsj, specify the followinginclude statement:include.fs.nas netappsj/vol/vol1 nasMgmtClass

See “Creating an Include-Exclude List” on page 111 for moreinformation.


8.S

ettingC

omm

onO

ptions

Syntax

ÊÊ » options patternmgmtclassname

ÊÍ

includeIncludes files or assigns management classes for backup orarchive processing.

include.archiveIncludes files or assigns management classes for archiveprocessing.

include.backupIncludes files or assigns management classes for backupprocessing.

include.compressionIncludes files for compression processing if you specifycompression=yes.

include.encryptIncludes the specified files for encryption processing. By default,Tivoli Storage Manager does not perform encryption processing.

include.fileIncludes a file for backup services, or assigns a managementclass to a file.

include.fs.nasAssigns a management class when used with thebackup nascommand. If you do not specify a NAS node name, the filesystem identified applies to all NAS file servers. Thebackupnas command ignores all other include statements. This option isfor Windows NT and Windows 2000 clientsonly.

include.subfileIncludes files for adaptive subfile backup processing. This optionis valid for all Windows clients.


include.systemobjectAssigns management classes for backup of Windows 2000system objects. By default, Tivoli Storage Manager binds allsystem objects to the default management class. You cannot usethis option to bind individual systemobject components to adifferent management class. You cannot use this option toinclude or exclude a system object from processing. This optionis valid for Windows 2000only.

Note: Other include-exclude statements do not affect systemobject processing. It is unnecessary to explicitly includethe registry staging directoryincludec:\adsm.sys\...\* for back up, to ensure that theregistry is backed up properly. If you accidently exclude adirectory that is critical to a system object backup, thesystem object backup is not affected.

Parameterspattern

Specifies the objects to include for backup services or to assigna specific management class. End this variable with a filespecification.

Note: For NAS file systems: You must prefix the NAS nodename to the file specification to specify the file server towhich the include statement applies. If you do not specifya NAS node name, the file system identified refers to theNAS node name specified in the client options file(dsm.opt) or on the command line.

If the pattern begins with a single or double quote or containsany embedded blanks or equal signs, you must surround thevalue in either single (’) or double (″) quotation marks. Theopening and closing quotation marks must be the same type ofquotation marks.


8.S

ettingC

omm

onO

ptions

Note: When usinginclude.systemobject, the only valid pattern isALL (all types of system objects). By default, Tivoli StorageManager binds all system objects to the default managementclass.

mgmtclassnameSpecifies the name of the management class to assign to theobjects. If a management class is not specified, the defaultmanagement class is used.


include c:\proj\text\devel.*include c:\proj\text\* textfilesinclude ?:* managallinclude.backup c:\win98\system\* mybackupclassinclude.archive c:\win98\system\* myarchiveclassinclude.encrypt c:\win98\proj\gordon\*include.compress c:\test\file.txtinclude.subfile c:\test\file.txtinclude.fs.nas netappsj1/vol/vol0 homemgmtclass



IncrthresholdThe incrthreshold option specifies the threshold value for thenumber of directories in any journaled file space that might haveactive objects on the server, but no equivalent object on theworkstation.

When a Windows client deletes a file or directory with a long name,it sometimes reports this using a compressed name. After the objectis deleted, the compressed name may be reused and the deletionnotice may no longer identify a unique object. During a journaledincremental backup of a file space, this may result in theno activeversionresponse from the server resulting in an unsuccessful expirefor an object.

The incrthreshold option allows you to specify what to do when thiscondition arises:

¶ If you specify incrthreshold=0 (the default), Tivoli StorageManager takes no action. The primary consequence is that,during a restore of such a directory, these objects may beinadvertently restored. When the next non-journaled incrementalis run on this directory, Tivoli Storage Manager expires allobjects in the directory that exist on the server but not on theworkstation.

¶ If you specify a value greater than zero, Tivoli Storage Managersaves an object’s directory name in the journal during journaledbackups. During a full file space journaled incremental backup,if the number of directories in the file space is greater than orequal to this value, a full incremental backup of each directoryoccurs. This takes place automatically after completion of thejournaled backup and does not require entry of anothercommand.

¶ If you specify incrthreshold=1, Tivoli Storage Manager performsa full incremental backup of these directories whenever anoactive versionresponse is received during a full file spacejournaled incremental backup.


8.S

ettingC

omm

onO

ptions

Place this option in your client options file (dsm.opt). This option isfor Windows NT, 2000 clientsonly.

See “Incremental” on page 356 for more information about journaledbackups.

SyntaxÊÊ INCRTHreshold numberdirectories ÊÍ

Parametersnumberdirectories

Specifies the threshold value for the number of directories in anyjournaled file space that may contain active files that should beexpired. When this threshold is reached during a full file spacejournaled incremental, the client initiates an incremental backupon each such directory at the completion of the journaledbackup. The range of values is 0 through 2,000,000,000; thedefault is 0.


incrthreshold 1

Command line:Does not apply


Lanfreecommmethod

The lanfreecommmethodoption specifies the communicationsprotocol between the Tivoli Storage Manager client and StorageAgent. This enables processing between the client and theSAN-attached storage device.


SyntaxÊÊ LANFREECommmethod commmethod ÊÍ

Parameterscommmethod

Specifies the supported protocol for your Tivoli Storage Managerclient:TCPip

The Transmission Control Protocol/Internet Protocol(TCP/IP) communication method.

Use thelanfreetcpportto specify the TCP/IP port numberwhere the Storage Agent is listening. See “Lanfreetcpport”on page 198 for more information.

NAMedpipesThe interprocess communication method that permitsmessage data streams to pass between a client and a server.This is the default for Windows NT, 2000.


lanfreec tcp

Command line:-lanfreec=tcp


8.S

ettingC

omm

onO

ptions

Lanfreetcpport

The lanfreetcpportoption specifies the TCP/IP port number wherethe Tivoli Storage Manager Storage Agent is listening.

Use this option when you specifylanfreecommmethod=TCPip forcommunication between the Tivoli Storage Manager client andStorage Agent.


See “Lanfreecommmethod” on page 197 for more information aboutthe lanfreecommmethodoption.

SyntaxÊÊ LANFREETCPport port_address ÊÍ


Specifies the TCP/IP port number where the Storage Agent islistening. The range of values is 1000 through 32767; the defaultis 1500.


lanfreetcp 1520

Command line:-lanfreetcp=1520


LanguageThe languageoption specifies the national language in which topresent client messages.

You can use American English (AMENG) with all clients.

The Tivoli Storage Manager client automatically detects the languageof the system locale and displays Tivoli Storage Manager for thatlanguage. For example, a supported operating system will displayTivoli Storage Manager in French by default, without specifying thelanguageoption. If Tivoli Storage Manager cannot load the Frenchmessage catalog, it will default to the American English languagepack. For example, if the client is running on an unsupportedlocale/language combination, such as French/Canada orSpanish/Mexico, Tivoli Storage Manager defaults to AmericanEnglish. You can override the default language by specifying thelanguageoption.

Note: The languageoption does not affect the Web client. The Webclient displays in the language associated with the locale ofthe browser. If the browser is running in a locale that TivoliStorage Manager does not support, the Web client displays inAmerican English.

SyntaxÊÊ LANGuage language ÊÍ

Parameterslanguage

Specifies the language you want to use. The available languagesinclude:¶ AMENG (American English).¶ BPORTUGUESE (Brazilian Portuguese)¶ SCHINESE (Chinese, Simplified)¶ TCHINESE (Chinese, Traditional)¶ FRENCH (Standard French)


8.S

ettingC

omm

onO

ptions

¶ GERMAN (Standard German)¶ ITALIAN (Standard Italian)¶ JAPANESE (Japanese)¶ KOREAN (Korean)¶ SPANISH (Standard Spanish)


language ameng



LargecommbuffersThe largecommbuffersoption specifies whether the client usesincreased buffers to transfer large amounts of data between the clientand the server. You can disable this option when your workstation isrunning low on memory.

Syntax

ÊÊNo

LARGECOMmbuffersYes

ÊÍ

ParametersNo

Specifies that increased buffersare notused to transfer largeamounts of data to the server. This is the default.

YesSpecifies that increased buffersare used to transfer largeamounts of data to the server.


largecommbuffers yes



8.S

ettingC

omm

onO

ptions

LocalbackupsetThe localbackupsetoption specifies whether the Tivoli StorageManager GUI bypasses initial logon with the Tivoli Storage Managerserver to restore a local backup set on a standalone workstation. Youcan use this option on the command line or place it your clientoptions file (dsm.opt).

If you specify localbackupset=yes, the GUI does not attempt initiallogon with the server. In this case, the GUI only enables the restorefunctionality.

If you specify localbackupset=no (the default), the GUI attemptsinitial logon with the server and enables all GUI functions.

To start the GUI and bypass the initial logon with the server torestore a local backup set on a standalone workstation, enter:

dsm -localbackupset=yes

Note: The restore backupsetcommand supports restore of localbackup sets on a standalone workstationwithout using thelocalbackupsetoption. See “Restore Backupset” on page 407for more information.

Syntax

ÊÊNo

LOCALbackupsetYes

ÊÍ

ParametersNo

Specifies that the GUI attempts initial logon with the server andenables all functions. This is the default.

YesSpecifies that the GUI does not attempt initial logon with theserver and enables only the restore functionality.



localbackupset yes

Command line:dsm -localbackupset=yes


8.S

ettingC

omm

onO

ptions

ManagedservicesThe managedservicesoption specifies whether the Tivoli StorageManager Client Acceptor service (CAD) manages the scheduler, theWeb client, or both.

See “Configuring the CAD to Manage the Scheduler” on page 91 forinstructions to set up the CAD to manage the scheduler.

The CAD serves as an external timer for the scheduler. When thescheduler is started, it queries the server for the next scheduledevent. The event is either executed immediately or the schedulerexits. The CAD restarts the scheduler when it is time to execute thescheduled event.

Notes:1. If you specify theschedmode=promptoption, the server prompts

the CAD when it is time to run the schedule. The scheduler willconnect and disconnect to the server when the CAD is firststarted.

2. Specifypasswordaccess=generatein your client options, so thatTivoli Storage Manager generates your password automatically.See “Passwordaccess” on page 216 for more information.

Using themanagedservicesoption can provide the followingbenefits:¶ Memory retention problems that may occur when using

traditional methods of running the scheduler are resolved. Usingthe CAD to manage the scheduler requires very little memorybetween scheduled operations.

¶ The CAD can manage both the scheduler program and the Webclient, reducing the number of background processes on yourworkstation.

¶ By default, if you do not specify themanagedservicesoption,the CAD manages the Web client to provide backwardcompatibility.



SyntaxÊÊ MANAGEDServices

» mode

ÊÍ

Parametersmode

Specifies whether the CAD manages the scheduler, the Webclient, or both.

webclientSpecifies that the CAD manages the Web client. This is thedefault.

scheduleSpecifies that the CAD manages the scheduler.


The following are examples of how you might specify themanagedservicesoption in your options file.

Task Specify that the CAD manages the Web clientonly.managedservices webclient

Task Specify that the CAD manages the scheduleronly.managedservices schedule

Task Specify that the CAD manages both the Web clientand the scheduler.

managedservices schedule webclient

Note: The order in which these values are specifiedis not important.



8.S

ettingC

omm

onO

ptions

MaxcmdretriesThe maxcmdretriesoption specifies the maximum number of timesthe client scheduler (on your workstation) attempts to process ascheduled command that fails. The command retry startsonly if theclient scheduler has not yet backed up a file, never connected to theserver, or failed before backing up a file. Use this optiononly whenthe scheduler is running.

Your administrator can also set this option. If your administratorspecifies a value for this option, that value overrides what youspecify in the client options fileafter your client node successfullycontacts the server.

SyntaxÊÊ MAXCMDRetries maxcmdretries ÊÍ

Parametersmaxcmdretries

Specifies the number of times the client scheduler can attempt toprocess a scheduled command that fails. The range of values iszero through 9999; the default is 2.


maxcmdr 4

Command line:-maxcmdretries=3



MemoryefficientbackupThe memoryefficientbackupoption specifies a memory conservingalgorithm for processing incremental backups, that backs up onedirectory at a time, using less memory. Use this option with theincremental command when your workstation is memoryconstrained.


Syntax

ÊÊNo

MEMORYEFficientbackupYes

ÊÍ

ParametersNo

Your client node uses the faster, more memory-intensive methodwhen processing incremental backups. This is the default.

YesYour client node uses the method that requires less memorywhen processing incremental backups.


memoryefficientbackup yes

Command line:-memoryef=no


8.S

ettingC

omm

onO

ptions

NamedpipenameThe namedpipenameoption specifies the name of a named pipe touse for communications between a client and a server on the sameWindows server domain. This option is valid for the Windows NTand Windows 2000 clientsonly.

SyntaxÊÊ NAMedpipename name ÊÍ

Parametersname

The name of a named pipe. The default is\pipe\dsmserv.


namedpipename \pipe\dsmser1

Command line:-namedpipename=\pipe\dsmser1

This option is valid only on the initial command line. It is not validin interactive mode.


NasnodenameThe nasnodenameoption specifies the node name for the NAS fileserver when processing NAS file systems. The node name identifiesthe NAS file server to the Tivoli Storage Manager server. The servermust register the NAS file server.

You can specify this option on the command line or in the clientoptions file (dsm.opt).

You can override the default value in thedsm.opt file by entering adifferent value on the command line. If you do not specify thenasnodenameoption in thedsm.opt file, you mustspecify thisoption on the command line when processing NAS file systems.

The nasnodenameoption is valid for Windows NT and Windows2000 clientsonly

SyntaxÊÊ NASNodename nodename ÊÍ

Parametersnodename

Specifies the node name for the NAS file server.


nasnodename nas2

Command line:-nasnodename=nas2


8.S

ettingC

omm

onO

ptions

NodenameThe nodenameoption identifies your workstation to the server. Youcan use different node names to identify multiple operating systemson your workstation.

When you use thenodenameoption, Tivoli Storage Managerprompts for the password assigned to the node you specify, if apassword is required.

If you want to restore or retrieve files from the server while you areworking from a different workstation, use thevirtualnodenameoption. See “Virtualnodename” on page 264 for more information.

If you are working from a different workstation, you can use thenodenameoption only if you specifypasswordaccess=prompt.

The node name is not necessarily the TCP/IP host name.

SyntaxÊÊ NODename nodename ÊÍ

Parametersnodename

Specifies a 1 to 64character node name for which you want torequest Tivoli Storage Manager services.

The default is the name of the workstation unlessclusternode=yes. Then, the default is the cluster name.

Permit the node name to default to the workstation name.


nodename cougar

Command line:-nod=banshee




8.S

ettingC

omm

onO

ptions

NumberformatThe numberformatoption specifies the format you want to use todisplay numbers.

Use this option if you want to change the default number format forthe language of the message repository you are using.

Note: This numberformatoption does not affect the Web client.The Web client uses the number format for the locale that thebrowser is running in. If the browser is not running in asupported locale, the Web client uses the number format forAmerican English.

SyntaxÊÊ NUMberformat number ÊÍ

Parametersnumber

Displays numbers using any one of the following formats.Specify the number (1–6) that corresponds to the number formatyou want to use.1 1,000.00 (This is the default)2 1,000,003 1 000,004 1 000.005 1.000,006 1’000,00


num 4

Command line:-numberformat=4

This option is valid on the initial command line and ininteractive mode.


OptfileThe optfile option specifies the client options file you want to usewhen you start a Tivoli Storage Manager session.

SyntaxÊÊ OPTFILE file_name ÊÍ

Parametersfile_name

Specifies an alternate client options file, if you use the fullyqualified path name. If you specify only the file name, TivoliStorage Manager assumes you want the current directory. Thedefault isdsm.opt.


Does not apply.

Command line:dsmc query session -optfile= myopts.opt



8.S

ettingC

omm

onO

ptions

PasswordThe passwordoption specifies a Tivoli Storage Manager password.If you do not specify this option and your administrator has setauthentication toOn, you are prompted for a password when youstart a Tivoli Storage Manager session.

Note: If the server prompts for a password, the password does notdisplay as you enter it. However, if you use the passwordoption on the command line, your password will display asyou enter it.

The passwordoption is ignored when thepasswordaccessoption isset togenerate.

SyntaxÊÊ PASsword password ÊÍ

Parameterspassword

Specifies a 1 to 64character password. A password is notcase-sensitive. Valid characters include:

CharactersDescription

A–Z Any letter, A through Z, uppercase or lowercase0–9 Any number, 0 through 9+ Plus. Period_ Underscore- Hyphen& Ampersand


password secretword


Command line:-password=secretword



8.S

ettingC

omm

onO

ptions

PasswordaccessThe passwordaccessoption specifies whether you want to generateyour password automatically or set as a user prompt. Youradministrator can require a password for your client node byenabling the authentication feature. Ask your administrator if apassword is required for your client node.

If a password is required, you can choose to:

¶ Set the password for your client node yourself and have TivoliStorage Manager prompt for it each time you request services.

¶ Let Tivoli Storage Manager automatically generate a newpassword for your client node each time it expires, encrypt andstore the password in a file, and retrieve the password from thatfile when you request services. You are not prompted for thepassword.

When thepasswordaccessoption is set togenerateand you specifythe passwordoption, thepasswordoption is ignored.

Set thepasswordaccessoption togeneratein the followingsituations:¶ When using the Web client.¶ When performing NAS operations.

Syntax

ÊÊprompt

PASSWORDAccessgenerate

ÊÍ

Parametersprompt

You are prompted for your workstation password each time aclient connects to the server. This is the default.


To keep your client node password secure, enter commandswithout the password and wait for Tivoli Storage Manager toprompt you for the password.

generateEncrypts and stores your password locally and generates a newpassword when the old password expires. An encrypted passwordis kept on your workstation when a session starts.

A password prompt displays when registering a workstation witha server using open registration or if your administrator changesyour password manually.


passwordaccess generate



8.S

ettingC

omm

onO

ptions

Postschedulecmd/PostnschedulecmdThe postschedulecmdoption specifies a command that the clientprogram processes after it runs a schedule. The client program waitsfor the command to complete before it continues with otherprocessing.

If you do not want to wait, specifypostnschedulecmd.

Note: The postschedulecmdoption (and thepostnschedulecmdoption) can be defined on the server.

SyntaxÊÊ POSTSchedulecmd

POSTNschedulecmd″cmdstring″ ÊÍ

Parameters″cmdstring″

Specifies the command to process. You can enter a command tobe executed after a schedule with this option. Use only onepostschedulecmdoption.

Use a blank, or null, string forcmdstringif you want to preventany commands from running that the administrator uses forpostschedulecmdor preschedulecmd. If you specify a blank ornull string oneither option, it prevents the administrator fromusing a command onboth options.

If your administrator uses a blank or null string on thepostschedulecmdoption, you cannot run a post-schedulecommand.

If the command string contains blanks, enclose it in doublequotes. If you have double quotes within the command string,use single quotes to enclose them.


postschedulecmd "restart database"


The command string is a valid command for restarting yourdatabase.



8.S

ettingC

omm

onO

ptions

Preschedulecmd/PrenschedulecmdThe preschedulecmdoption specifies a command that the clientprogram processes before it runs a schedule. The client programwaits for the command to complete before it starts the schedule.

If you do not want it to wait, specifyprenschedulecmd.

Note: The preschedulecmdoption (and theprenschedulecmdoption) can also be defined on the server.

SyntaxÊÊ PRESchedulecmd

PRENSchedulecmd″cmdstring″ ÊÍ

Parameters″cmdstring″

Specifies the command to process. Use only onepreschedulecmdoption. You can enter a command to beexecuted before a schedule using this option.

Use a blank or null string forcmdstringif you want to preventany commands from running that the administrator uses forpostschedulecmdandpreschedulecmd. If you specify a blank ornull string oneither option, it prevents the administrator fromusing a command onboth options.

If your administrator uses a blank or null string on thepreschedulecmdoption, you cannot run a pre-schedulecommand.

If the command string contains blanks, enclose it in doublequotes. If you placed double quotes within the command string,use single quotes to enclose them.


preschedulecmd "<insert your database product'squiesce command here> database"


The command string is a valid command for quiescing yourdatabase.



8.S

ettingC

omm

onO

ptions

QueryschedperiodThe queryschedperiodoption specifies the number of hours youwant the client scheduler to wait between attempts to contact theserver for scheduled work. This option applies only when you set theschedmodeoption topolling. This option is used only when thescheduler is running.

Your administrator can also set this option. If your administratorspecifies a value for this option, that value overrides the value set inyour client options file after your client node successfully contactsthe server.


SyntaxÊÊ QUERYSCHedperiod hours ÊÍ

Parametershours

Specifies the number of hours the client scheduler waits betweenattempts to contact the server for scheduled work. The range ofvalues is 1 through 9999; the default is 12.


querysch 6

Command line:-queryschedperiod=8



QuietThe quiet option limits the number of messages that display on yourscreen during processing. For example, when you run theincremental, selective, or archive commands, information mayappear about each file that is backed up. Use thequiet option if youdo not want to display this information.

When you use thequiet option, error and processing informationappears on your screen, and messages are written to log files. If youdo not specifyquiet, the default option,verboseis used.

This option also affects the amount of information reported in theNT eventlog and schedule log.

Note: The server can also define thequiet option and override theclient setting.

SyntaxÊÊ QUIET ÊÍ

ParametersThere are no parameters for this option.


quiet

Command line:-quiet



8.S

ettingC

omm

onO

ptions

ReplaceThe replaceoption specifies what you want the system to do when itrestores files that already exist on your workstation. This optionapplies to therestore, retrieve, andrestore backupsetcommandsonly.

Syntax

ÊÊPrompt

REPlaceAllYesNo

ÊÍ

ParametersPrompt

You are prompted whether to overwrite a file that already existson your workstation. If the existing file is read-only, you areprompted whether to overwrite it. This is the default.

AllAll existing files are overwritten, including read-only files. OnWindows NT and 2000 workstations, all locked files are replacedwhen the system is rebooted. If access to a file is denied, youare prompted to skip or overwrite the file. No action is taken onthe file until there is a response to the prompt.

YesAny existing files are overwritten,exceptread-only files. If a fileis read-only, you are prompted to overwrite the file or skip it.No action is taken on the file until there is a response to theprompt. If access to a file is denied, the file is skipped.

NoExisting files are not overwritten. No prompts will display.

Note: On Windows NT and 2000 workstations, you can choose toreplace locked files when the system is rebooted. TivoliStorage Manager cannot perform an in-place restore of active


files. However, it will stage restored versions of active filesfor replacement during the next reboot, except files containingnamed streams, sparse files, and directories. You can onlyrestore these files if they are unlocked.


replace all

Command line:-replace=no


8.S

ettingC

omm

onO

ptions

ResourceutilizationThe resourceutilizationoption regulates the level of resources theTivoli Storage Manager server and client can use during processing.

When you request a backup or archive, the client can use more thanone session to the server. The default is to use a maximum of twosessions; one to query the server and one to send file data. Theclient can use only one server session if you specify aresourceutilizationsetting of 1.

A client can use more than the default number of sessions whenconnecting to a server that is Version 3.7 or higher. For example,resourceutilization=10 permits up to eight sessions with the server.Multiple sessions may be used for querying the server and sendingfile data.

Multiple query sessions are used when multiple file specificationsare used with a backup or archive command. For example, if youenter:inc filespaceA filespaceB

and you specifiedresourceutilization=5, the client may start asecond session to query files on file space B. Whether or not thesecond session starts depends on how long it takes to query theserver about files backed up on file space A. The client may also tryto read data from the file system and send it to the server onmultiple sessions.

The following factors can affect the throughput of multiple sessions:

¶ The server’s ability to handle multiple client sessions. Is theresufficient memory, multiple storage volumes, and CPU cycles toincrease backup throughput?

¶ The client’s ability to drive multiple sessions (sufficient CPU,memory, etc.).

¶ The configuration of the client storage subsystem. File systemsthat are striped across multiple disks, using either softwarestriping or RAID-5 can better handle an increase in random read


requests than a single drive file system. Additionally, a singledrive file system may not see performance improvement if itattempts to handle many random concurrent read requests.

¶ Sufficient bandwidth in the network to support the increasedtraffic.

Potentially undesirable aspects of running multiple sessions include:

¶ The client could produce multiple accounting records.

¶ The server may not start enough concurrent sessions. To avoidthis, the servermaxsessionsparameter must be reviewed andpossibly changed.

¶ A query node command may not summarize client activity.


SyntaxÊÊ RESOURceutilization number ÊÍ

Parametersnumber

Specifies the level of resources the Tivoli Storage Managerserver and client can use during processing. The range of valuesthat you can specify is 1 through 10.


resourceutilization 7



8.S

ettingC

omm

onO

ptions

RetryperiodThe retryperiodoption specifies the number of minutes the clientscheduler waits between attempts to process a scheduled commandthat fails, or between unsuccessful attempts to report results to theserver. Use this option only when the scheduler is running.

Your administrator can also set this option. If your administratorspecifies a value for this option, that value overrides the value inyour client options file after your client node successfully contactsthe server.

SyntaxÊÊ RETRYPeriod minutes ÊÍ

Parametersminutes

Specifies the number of minutes the client scheduler waitsbetween attempts to contact the server, or to process a scheduledcommand that fails. The range of values is 1 through 9999; thedefault is 20.


retryp 10

Command line:-retryperiod=15



RevokeremoteaccessThe revokeremoteaccessoption restricts an administrator with clientaccess privilege from accessing a client workstation that is runningthe Web client. This option does not restrict administrators withclient owner, system, or policy privilege from accessing yourworkstation through the Web client.

Syntax

ÊÊNone

REVOKEremoteaccessAccess

ÊÍ

ParametersNone

Does not revoke access to administrators who have client accessauthority for the client. This is the default.

AccessRevokes access to administrators who have client accessauthority for the client.


revokeremoteaccess none



8.S

ettingC

omm

onO

ptions

RunasserviceThe runasserviceoption forces the client command process tocontinue running, even if the account that started the client logs off.Use this option with theAT command and the NT scheduler whenyou schedule client command batch jobs. This option is valid for theWindows NT and Windows 2000 clientsonly.


Syntax

ÊÊ RUNASSERViceNo

YesÊÍ

ParametersNo

Does not force the client command process to continue running,even if the account that started the client logs off. This is thedefault.

YesForces the client command process to continue running, even ifthe account that started the client logs off.


runasservice yes

Command line:-runasservice=yes



SchedcmddisabledThe schedcmddisabledoption specifies whether to disable thescheduling of commands by the serveraction=command option onthe define scheduleserver command.

This option does not disable thepreschedulecmdandpostschedulecmdcommands. However, you can specifypreschedulecmdor postschedulecmdwith a blank or a null string todisable the scheduling of these commands and the commandsscheduled by the server using theaction=command option on thedefine scheduleserver command.

Use thequery schedulecommand to query the schedules defined byyour administrator. See “Query Schedule” on page 392 for moreinformation.

Place this option in your client options file.


Syntax

ÊÊNo

SCHEDCMDDisabledYes

ÊÍ

ParametersYes

Specifies that Tivoli Storage Manager disables the scheduling ofcommands by the server using theaction=command option onthe define scheduleserver command.

NoSpecifies that Tivoli Storage Manager does not disable thescheduling of commands by the server using theaction=command option on thedefine scheduleservercommand. This is the default.


8.S

ettingC

omm

onO

ptions


schedcmddisabled no



SchedlognameThe schedlognameoption specifies the path and file name whereyou want to store schedule log information. Use this option onlywhen the scheduler is running.

When you run theschedulecommand, output from scheduledcommands display on your screen. Output is also sent to the file youspecify with this option.

SyntaxÊÊ SCHEDLOGName filespec ÊÍ

Parametersfilespec

Specifies the path and file name where you want to storeschedule log information when processing scheduled work.

If you specify a file name only, the file is stored in your currentdirectory. The default is the installation directory with a filename of dsmsched.log.


schedlogname c:\mydir\schedlog.jan

Command line:-schedlogn=c:\mydir\schedlog.jan



8.S

ettingC

omm

onO

ptions

SchedlogretentionThe schedlogretentionoption specifies the number of days to keepentries in the schedule log, and whether to save the pruned entries.The schedule log is pruned after a scheduled event completes.

Syntax

ÊÊ SCHEDLOGRetentionN

days

D

SÊÍ

ParametersN or days

Specifies how long to wait before pruning the schedule log.N Do not prune the log. This permits the log to grow

indefinitely. This is the default.days

Specifies the number of days to keep log file entries beforepruning. The range of values is zero through 9999.

D or SSpecifies whether to save the pruned entries. Use a space orcomma to separate this parameter from the previous one.

D Discards the log entries when pruning the log. This is thedefault.

S Saves the log entries when pruning the log.

Pruned entries are copied to the dsmsched.pru file that isstored in the same directory as the schedule log.


schedlogretention 30 S

Command line:-schedlogretention=30,S




8.S

ettingC

omm

onO

ptions

SchedmodeThe schedmodeoption specifies whether you want to use thepollingmode (your client node periodically queries the server for scheduledwork), or thepromptedmode (the server contacts your client nodewhen it is time to start a scheduled operation). All communicationmethods can use the client polling mode, but only TCP/IP can usethe server prompted mode.

Note: This option appliesonly if you are using the TCP/IPcommunication method, and the scheduler command isrunning.

Your administrator can specify that the server support both modes orjust one mode. If your administrator specifies that both modes aresupported, you can select either schedule mode. If your administratorspecifies only one mode, you must specify that mode in your clientoptions file or scheduled work will not process.

If you specify thepromptedmode, you must supply values for thetcpclientaddressand tcpclientportoptions on theschedulecommand. You can then be contacted at an address or port other thanthe one that made first contact with the server.

Notes:

1. Tivoli Storage Manager does not support the scheduler runningin prompted mode outside a firewall.

2. The server can also be define this option.

Syntax

ÊÊPOlling

SCHEDMODePRompted

ÊÍ

ParametersPOlling

The client scheduler queries the server for scheduled work at


prescribed time intervals. This is the default. You can set thetime intervals using thequeryschedperiodoption.

PRomptedThe client scheduler waits for the server to contact your clientnode when scheduled work needs to be done.


schedmode prompted

Command line:-schedmod=po



8.S

ettingC

omm

onO

ptions

ScrolllinesThe scrolllines option specifies the number of lines of informationthat display on your screen at one time. Use this option when youset thescrollpromptoption toYesand you use commands.


SyntaxÊÊ SCROLLLines number ÊÍ

Parametersnumber

Specifies the number of lines of information that display on yourscreen at one time. The range of values is 1 through 80; thedefault is 20.


scrolllines 25

Command line:-scrolll=25



ScrollpromptThe scrollpromptoption specifies whether you want Tivoli StorageManager to stop and wait after displaying the number of lines ofinformation you specified with thescrolllines option, or scrollthrough and stop at the end of the information list.


Syntax

ÊÊNo

SCROLLPromptYes

ÊÍ

ParametersNo

Scrolls to the end of the list and stops. This is the default.

YesStops and waits after displaying the number of lines youspecified with thescrolllines option. The following promptdisplays at the bottom of the screen:Press ‘Q’ to quit, ‘C’ to continuous scroll, or ‘Enter’ tocontinue.


scrollprompt yes

Command line:-scrollp=yes



8.S

ettingC

omm

onO

ptions

SkipntpermissionsThe skipntpermissionsoption bypasses processing of NTFS securityinformation on Windows NT and Windows 2000 clients only. Selectthis option for incremental backups, selective backups, or restores.Use this option with the following commands:¶ archive¶ incremental¶ restore¶ retrieve¶ selective

Syntax

ÊÊNo

SKIPNTPermissionsYes

ÊÍ

ParametersNo

If you specifyNo, the NTFS security information is backed upor restored. This is the default.

YesIf you specifyYes, the NTFS security information is not backedup or restored.


skipntp yes

Command line:–skipntp=yes


SkipntsecuritycrcThe skipntsecuritycrcoption controls the computation of the securitycyclic redundancy check (CRC) for a comparison of NTFS securityinformation during an incremental or selective backup archive,restore, or retrieve operation. Ifskipntsecuritycrc no(the default) isused, performance might be slower because the program mustretrieve all the security descriptors.

Use this option with the following commands:¶ archive¶ incremental¶ restore¶ retrieve¶ selective

This option is valid for Windows NT, 2000 clientsonly.

Syntax

ÊÊNo

SKIPNTSecuritycrcYes

ÊÍ

ParametersNo

If you specifyNo, the security CRC is generated during abackup. This is the default.

YesIf you specifyYes, the security CRC is not generated during abackup. All the permissions are backed up, but the program willnot be able to determine if the permissions are changed duringthe next incremental backup. Whenskipntpermissions=yes, theskipntsecuritycrcoption does not apply.


skipnts no


8.S

ettingC

omm

onO

ptions

Command line:–skipnts=no


SubdirThe subdir option specifies whether you want to includesubdirectories of named directories for processing on the followingcommands:

archivedelete archiveincrementalquery archivequery backupquery backupsetrestorerestore backupsetretrieveselective

Place this option in your client options file (dsm.opt).


Syntax

ÊÊNo

SUbdirYes

ÊÍ

ParametersNo

Subdirectories are not processed. This is the default.

YesSubdirectories are processed. Because the client programsearches all subdirectories of a directory that is being processed,processing can take longer to complete. SpecifyYesonly whennecessary.


8.S

ettingC

omm

onO

ptions

Note: If you use thepreservepathoption in addition tosubdir=yes, it can affect which subdirectories areprocessed. For more information, see “Preservepath” onpage 302.

If a subdirectory is a mounted file system, it will not processeven if you specfifysubdir=yes.


subdir no

Command line:

To restore the structure:\path2\dir1\path2\dir1\file1\path2\dir1\dir2\path2\dir1\dir2\file1

enter any of the following commands:rest \path\dir1\* \path2\ -su=yesrest \path\dir1\file* \path2\ -su=yesrest \path\dir1\file1* \path2\ -su=yes


SubfilebackupThe subfilebackupoption specifies whether to enable adaptivesubfile backup.


Syntax

ÊÊno

SUBFILEBackupyes

ÊÍ

ParametersNo

Specifies that Tivoli Storage Manager does not use adaptivesubfile backup. This is the default.

YesSpecifies that Tivoli Storage Manager uses adaptive subfilebackup.


subfileb yes

Command line:-subfileb=yes



8.S

ettingC

omm

onO

ptions

SubfilecachepathThe subfilecachepathoption specifies the path where the clientcache resides for adaptive subfile backup processing. If you do notspecify a path, Tivoli Storage Manager creates a path called\cacheunder the directory where the Tivoli Storage Manager executablesreside.

All directories and subdirectories in the pathname you specify withthe subfilecachepathoption must exist. For example, if you specifyc:\temp\cache, c:\temp must already exist.

Notes:1. The server can also define this option.2. You should exclude the subfilecache directory from backup.

SyntaxÊÊ SUBFILECACHEPath path_name ÊÍ

Parameterspath_name

Specifies the path name where the client cache resides foradaptive subfile backup processing.


subfilecachep c:\temp\cc_tsm

Command line:-subfilecachep=c:\temp\cc_tsm



SubfilecachesizeThe subfilecachesizeoption specifies the client cache size foradaptive subfile backup. If the cache size is too small, base files forsome files will not be cached and subfile processing will not applyfor them. However, setting the value too large can take up more diskspace than can be spared. The files maintained in the cache shouldclosely reflect the files used on a regular basis.


SyntaxÊÊ SUBFILECACHESize size ÊÍ

Parameterssize

Specifies the size, in megabytes, of the client cache for adaptivesubfile backup processing. The range is 1 through 1024 (1 GB);the default is 10.


subfilecaches 10

Command line:-subfilecaches=10



8.S

ettingC

omm

onO

ptions

TapepromptThe tapepromptoption specifies whether you want to wait for a tapeto mount if it is required for a backup, archive, restore, or retrieveprocess, or to be prompted for a choice.

Tape prompting does not occur during a scheduled operationregardless of the setting for thetapepromptoption.

The tapepromptoption can be used with the following commands:archiveincrementalrestoreretrieveselective


Syntax

ÊÊNo

TAPEPromptYes

ÊÍ

ParametersNo

You are not prompted for your choice. The server waits for theappropriate tape to mount. This is the default.

YesYou are prompted when a tape is required to back up, archive,restore, or retrieve data. At the prompt, you can wait for theappropriate tape to be mounted, always wait for a tape to bemounted, skip a particular object, skip all objects on a singletape, skip all objects on all tapes, or cancel the entire operation.


tapeprompt yes


Command line:-tapep=yes



8.S

ettingC

omm

onO

ptions

TcpbuffsizeThe tcpbuffsizeoption specifies the size of the internal TCP/IPcommunication buffer. Although it uses more memory, a largerbuffer can improve communication performance.

SyntaxÊÊ TCPBuffsize size ÊÍ

Parameterssize

Specifies the size, in kilobytes, that you want to use for theinternal TCP/IP communication buffer. The range of values is 1through 512; the default is 31.

Depending on the operating system communication settings, yoursystem might not accept all values in the range of 1 through 512.


tcpb 2

Command line:-tcpbuffsize=31



TcpclientaddressThe tcpclientaddressoption specifies a TCP/IP address if your clientnode has more than one address, and you want the server to contactan address other than the one that was used to make the first servercontact.

Use this option only if you use thepromptedparameter with theschedmodeoption or when theschedulecommand is running.

SyntaxÊÊ TCPCLIENTAddress client_address ÊÍ

Parametersclient_address

Specifies the TCP/IP address you want the server to use tocontact your client node. Specify a TCP/IP Internet domain nameor a dot address.


tcpclienta dsmclnt.sanjose.ibm.com

Command line:-tcpclientaddress=128.33.10.249



8.S

ettingC

omm

onO

ptions

TcpclientportThe tcpclientportoption specifies a different TCP/IP port number forthe server to contact than the one that was used to make the firstserver contact. If the default port or the specified port is busy, theserver attempts to use any available port. Use this option only if youspecify thepromptedparameter with theschedmodeoption or whenthe schedulecommand is running.

SyntaxÊÊ TCPCLIENTPort client_port_address ÊÍ

Parametersclient_port_address

Specifies the TCP/IP port address you want the server to use tocontact your client node. The range of values is 1000 through32767; the default is 1501.


tcpclientp 1502

Command line:-tcpclientport=1492



TcpnodelayThe tcpnodelayspecifies whether to send small transactions to theserver, without buffering them first. Asmall transactionis smallerthan the byte limit set with thetxnbytelimit option. Specifyingtcpnodelayyesmight improve performance in higher-speednetworks.

Syntax

ÊÊNo

TCPNodelayYes

ÊÍ

ParametersNo

Do not send small transactions without buffering them first. Thisis the default.

YesSend small transactions without buffering them first. When youspecify tcpnodelayyes, data packets less than the maximumtransmission unit (MTU) size are sent immediately. Specifyingtcpnodelayyesmight improve performance in higher-speednetworks.


tcpnodelay yes



8.S

ettingC

omm

onO

ptions

TcpportThe tcpport option specifies a TCP/IP port address for a server. Youcan obtain this address from your administrator.

Tivoli Storage Manager Firewall SupportTo enable the backup-archive client, Command Line Admin client,and the Scheduler (running in polling mode) to run outside afirewall, the port specified by the optiontcpport (default 1500) mustbe opened in the firewall.


The webportsoption enables the use of the Web client outside afirewall by specifying the TCP/IP port number used by the TivoliStorage Manager Client Acceptor service and the Web Client Agentservice for communications with the Web GUI.

The ports specified with thewebportsoption and the client optionhttpport must be opened in the firewall. See “Httpport” on page 184and “Webports” on page 266 for more information.

See “Tivoli Storage Manager Firewall Support” on page 27 forfurther considerations regarding Tivoli Storage Manager firewallsupport.

SyntaxÊÊ TCPPort port_address ÊÍ


Specifies the TCP/IP port address that is used to communicatewith a server. The range of values is 1000 through 32767; thedefault is 1500.



tcpp 1501

Command line:-tcpport=1501



8.S

ettingC

omm

onO

ptions

TcpserveraddressThe tcpserveraddressoption specifies the TCP/IP address for aserver. You can obtain this server address from your administrator.

SyntaxÊÊ TCPServeraddress server_address ÊÍ

Parametersserver_address

Specifies a 1 to 64character TCP/IP address for a server.Specify a TCP/IP domain name or a dot address.


tcps dsmchost.endicott.ibm.com

Command line:-tcpserveraddress=129.33.24.99



TcpwindowsizeThe tcpwindowsizeoption specifies the amount of data in kilobytesthat is buffered when receiving data on a TCP/IP connection. Toimprove backup or archive performance, increase the tcpwindowsizeon the server. To improve restore or retrieve performance, increasethe tcpwindowsize on the client.

SyntaxÊÊ TCPWindowsize window_size ÊÍ

Parameterswindow_size

Specifies the size, in kilobytes, to use for your client nodeTCP/IP sliding window.

The range of values is 1 through 2048 for Windows 2000only.For Windows 98, Me, and NT 4.0, we recommend a maximumvalue of 63 or less. The default is 32.

Note: Depending on the operating system communicationsettings, your system might not accept all values in therange of values. By default, Windows 2000 does notsupport a value greater then 63KB. Refer toDescriptionof Windows 2000 TCP Features, Microsoft knowledgebase, article Q224829, for details regarding TCP featuresin Windows 2000.


tcpwindowsize 1

Command line:-tcpw=24



8.S

ettingC

omm

onO

ptions

TimeformatThe timeformat option specifies the format in which you want todisplay system time.

Use this option if you want to change the default time format for thelanguage of the message repository you are using.

Note: This timeformat option does not affect the Web client. TheWeb client uses the time format for the locale that thebrowser is running in. If the browser is not running in alocale that Tivoli Storage Manager supports, the Web clientuses the time format for American English.

SyntaxÊÊ TIMEformat format_number ÊÍ

Parametersformat_number

Displays time in one of the formats listed below. Select theformat number that corresponds to the format you want to use.1 23:00:00 (This is the default)2 23,00,003 23.00.004 12:00:00 A/P


timeformat 4

Command line:-time=3


TxnbytelimitThe txnbytelimit option specifies the number of kilobytes the clientprogram buffers before it sends a transaction to the server.

Note: This option can also be defined and adjusted by the server asrequired during self-tuning operations.

A transactionis the unit of work exchanged between the client andserver. Because the client program can transfer more than one file ordirectory between the client and server before it commits the data toserver storage, a transaction can contain more than one file ordirectory. This is called atransaction group.

This option permits you to control the amount of data sent betweenthe client and server before the server commits the data and changesto the server database, thus changing the speed with which the clientperforms work. The amount of data sent applies when files arebatched together during backup or when receiving files from theserver during a restore procedure.

The server administrator can limit the number of files or directoriescontained within a transaction group using thetxngroupmaxoption;the actual size of a transaction can be less than your limit. Once thisnumber is reached, the client sends the files to the servereven ifthetransaction byte limit is not reached.

SyntaxÊÊ TXNBytelimit number ÊÍ

Parametersnumber

Specifies the number of kilobytes the client program can buffertogether in a transaction before it sends data to the server. Therange of values is 300 through 2097152 (2 GB); the default is2048.


8.S

ettingC

omm

onO

ptions


txnb 2048

Command line:-txnb=2048

This option is valid only on the initial command line. It is not validin interactive mode.


UsedirectoryThe usedirectoryoption queries the Active Directory for thecommunication method and server with which to connect. Use thisoption to ignorecommmethodparameters in the client options file(dsm.opt). Optimally, the administrator enables only one server andone specific communication protocol for a given client node. If anode is registered to more than one server published in ActiveDirectory, the first server returned in the Active Directory query willbe used. If the client cannot contact the server, the client session willfail.

This option is valid in the client options file (dsm.opt) and on thecommand line.

This option is valid for Windows 2000only.

Syntax

ÊÊNo

USEDIRectoryYes

ÊÍ

ParametersYes

Specifies that the client will ignorecommmethodparameters setin the client options file and query the Active Directory for thecommunication method and server with which to connect.

NoSpecifies that the client will use the communication methodspecified in the option file. If there is no communication methodspecified in the option file the default communication methodand server are used.


usedirectory no


8.S

ettingC

omm

onO

ptions

Command line:-usedir=yes


VerboseThe verboseoption specifies that you want processing information todisplay on your screen. This is the default. When you run theincremental, selective, or archive commands, information displaysabout each file that is backed up. Use thequiet option if you do notwant to display this information.

This option also affects the amount of information displayed in NTevent log and schedule log files.

If the server specifies either thequiet or verboseoption in the serverclient option set, the server settings override the client values, evenif force is set toNo on the server.


SyntaxÊÊ VErbose ÊÍ



verbose

Command line:-verbose



8.S

ettingC

omm

onO

ptions

VirtualnodenameThe virtualnodenameoption specifies the node name of yourworkstation when you want to restore or retrieve files to a differentworkstation. Place this option in the client options file (dsm.opt).

When you use thevirtualnodenameoption in your client optionsfile, or with a command:

¶ You must specify the name you specified with thenodenameoption in your client options file. This name should be differentfrom the name returned by thehostnamecommand on yourworkstation.

¶ Tivoli Storage Manager prompts for the password assigned tothe node you specify, if a password is required. If you enter thecorrect password, you have access to all backups and archivesthat originated from the specified node.

When connecting to a server, the client must identity itself to theserver. This login identification is determined in the following ways:

¶ If the nodenameandvirtualnodenameoptions are not specified,or a virtual node name is not specified on the command line, thedefault login ID is the name returned by thehostnamecommand.

¶ If the nodenameoption is specified, the name specified with thenodenameoption overrides the name returned by thehostnamecommand.

¶ If the virtualnodenameoption is specified, or a virtual nodename is specified on a command line, it cannot be the samename as the name returned by thehostnamecommand.

When the virtual node name is accepted by the server, a password isrequired (assuming authentication is on), even if thepasswordaccessoption isgenerate. Once a connection to the server is established,then access is permitted to any file backed up using this login ID.


SyntaxÊÊ VIRTUALNodename nodename ÊÍ

Parametersnodename

Specifies a 1- to 64-character name that identifies the node forwhich you want to request Tivoli Storage Manager services.There is no default.


virtualnodename cougar

Command line:-virtualn=banshee



8.S

ettingC

omm

onO

ptions

WebportsThe webportsoption enables the use of the Web client outside afirewall by specifying the TCP/IP port number used by the TivoliStorage Manager Client Acceptor service and Web Client Agentservice for communications with the Web GUI.

If you do not specify this option, values for both the Client Acceptorservice and the Web Client Agent service arerequired.

If you do not specify this option, the default value, zero (0), is usedfor both ports. This causes TCP/IP to randomly assign a free portnumber for the Client Acceptor service and the Web Client Agentservice. The port value TCP/IP assigns is in the range of 1024through 5000.

The ports you specify with thewebportsandhttpport options mustbe opened in the firewall.

To enable the backup-archive client, Command Line Admin client,and the Scheduler (running in polling mode) to run outside afirewall, the port specified by the server optiontcpport (default1500) must be opened in the firewall.


To enable the administrative Web interface to run outside a firewallthe port specified by server optionhttpport (default is 1580) must beopened in the firewall.

See “Httpport” on page 184 and “Tcpport” on page 254 for moreinformation.

See “Tivoli Storage Manager Firewall Support” on page 27 forfurther considerations regarding Tivoli Storage Manager firewallsupport.


SyntaxÊÊ WEBPorts cadport agentport ÊÍ

Parameterscadport

Specifies therequiredTivoli Storage Manager Client Acceptorservice port number. If a value is not specified, the default, zero(0), causes TCP/IP to randomly assign a free port number.

agentportSpecifies therequiredTivoli Storage Manager Web client agentservice port number. If a value is not specified, the default, zero(0), causes TCP/IP to randomly assign a free port number.


webports 2123 2124

Command line:-webports=2123,2124


8.S

ettingC

omm

onO

ptions

Using Options with Commands

The client program includes a group ofclient command optionsthatyou can enter with specific commandsonly from the command line.You can also enter common options to override many of the optionsset in your client options file. Options are processed following thisprecedence (order):1. Options defined on the server with server-enforced client options.

The clientcannotoverride the value.2. Options entered locally on the command line.3. Options defined on the server for a schedule using the options

parameters.4. Options entered locally in the options file.5. Options received from the server with client options not enforced

by the server. The clientcan override the value.6. Default option values.

For a complete list of client command options, their descriptions, thecommands with which you can use them, and the location in thisbook for more information, see Table 26 on page 270. For acomplete list of common options, see “Setting Common Options” onpage 127.

Entering Options with a CommandFollow these general rules when you enter options with a command:

¶ Enter a command, a dash (–), the option name, an equal sign(=), and the option value or parameter. For example,

dsmc archive -description="Project A" c:\devel\proj1\*

9


9.U

singO

ptionsw

ithC

omm

ands

¶ For options that do not include parameters, enter a command, adash (–) and the option name. For example,

dsmc incremental -quiet

¶ Enter either the option name, or an abbreviation for the optionname. For example, to enter thelatestoption, enter either-lator -latest. The capital letters in the syntax of each optionindicate the minimum abbreviation for that option name. Tounderstand how to read the syntax diagrams, see “ReadingSyntax Diagrams” on page xxvii.

¶ Enter options in any order before or after command parameters.For example, you can enter thesubdir option before or after afile specification:

dsmc selective -subdir=yes c:\devel\proj1\dsmc selective c:\devel\proj1\ -subdir=yes

¶ Separate options with a blank space when you enter more thanone option in a command.

¶ Enclose the option parameter in quotes (" ") if it contains ablank space:

dsmc archive -description="Project A" c:\devel\proja.lst

¶ The maximum number of characters for a file name is 256. Themaximum combined length of the file name and path name is260 characters.

Table 26. Client Command OptionsCommandOption Description Commands Page

archmc Overrides the defaultmanagement class for a file ora group of files.

archive 275

class Specifies whether to display alist of NAS objects or clientobjects when using thefollowing commands:

query backupdelete filespacequery filespace

276

deletefiles Deletes the local copy of filesfrom your workstation afterthey are archived on the server.

archive 277


Table 26. Client Command Options (continued)CommandOption Description Commands Page

description Specifies a description for afile that you are archiving,deleting, or retrieving. Alsospecifies the description of abackupset that you want toquery.

archivedelete archivequery archivequery backupsetretrieve

278

detail Displays management classattributes for availablemanagement classes.

querymgmtclass

279

dirsonly Backs up, restores, archives,retrieves, or displays directoriesonly.

archiveincrementalquery archivequery backuprestoreretrieveselective

280

filelist Specifies a list of files to beprocessed for the command.Tivoli Storage Manager opensthe designated filelist andprocesses the files listed withinaccording to the command.When thefilelist option is used,file specification is ignored.

archivedelete archiveexpireincrementalquery backupquery archiverestoreretrieveselective

281

filesonly Backs up, restores, retrieves, ordisplays filesonly.

incrementalquery archivequery backuprestoreretrieveselective

284

fromdate Sets a date limit for files.Tivoli Storage Manager doesnot include files processedbefore this date, although olderdirectories might be included.

query archivequery backuprestoreretrieve

285


9.U

singO

ptionsw

ithC

omm

ands


fromnode Displays file spaces for analternate node. Also specifiesan alternate node from whichto restore or retrieve files.

query archivequery backupquery filespacequery mgmtclassrestoreretrieve

286

fromtime Specifies a beginning time onthe specified date. Use with thefromdateoption. This option isignored if thefromdateoptionis absent.


287

ifnewer Replaces existing files with thelatest backup version only ifthe backup version is newerthan the existing version.

restorerestore backupsetretrieve

288

inactive Processes inactive backupversions of files.

query backuprestorerestore nas

289

incrbydate Requests an incrementalbackup by date.

incremental 290

latest Restores the most recentbackup version of a filewhether it is active or inactive.

restore 292

location Specifies whether TivoliStorage Manager searches for abackup set on the server, inlocal files, or on a tape deviceduring a query or restoreoperation.

query backupsetrestore backupset

293

mode Specifies whether to performan image backup on an entirefile system or only those filesthat change after the originalimage backup.

backup nas 295



monitor Specifies whether you want tomonitor an image backup orrestore of one or more filesystems belonging to a NASfile server.

backup nasrestore nas

296

nojournal Use this option with the withthe incremental command tospecify that the traditional fullincremental backup isperformed, instead of thedefault journal-based backup.

incremental 297

noprompt Suppresses the confirmationprompt when deleting anarchived file.

delete archive 298

pick Displays a list of files fromwhich you can select files todelete, restore, or retrieve.

delete archiverestoreretrieve

restore nas

299

pitdate Specifies the file backup dateto use when you select files torestore. Use with thepittimeoption.


300

pittime Specifies a point-in-time on thespecified date. Use with thepitdateoption. This option isignored if thepitdateoption isabsent.


301

preservepath Specifies how the restoredirectory path is built.

restorerestore backupsetretrieve

302


9.U

singO

ptionsw

ithC

omm

ands


todate Sets a date limit for files.Tivoli Storage Manager doesnot include files that areprocessed after this date. Usewith the totime option.


305

totime Specifies an ending time on thespecified date. Use with thetodateoption. This option isignored if thetodateoption isabsent.


306

type Displays node types that youspecify.

query node 307

v2archive Use this option with thearchive command to archiveonly files and not directories tothe server.

archive 308

Command Line Options ReferenceThe following sections contain detailed information about each ofthe Tivoli Storage Manager command line options. These options arearranged in alphabetical order. Information for each option includes:

¶ A description of the option.

¶ A syntax diagram of the option. The option name is shown in acombination of uppercase and lowercase characters. Theuppercase characters indicate the minimum abbreviation you canuse for the option name. See “Reading Syntax Diagrams” onpage xxvii for an explanation of these diagrams.

¶ Detailed descriptions of the option parameters. If the parameteris a constant (a value that does not change), the minimumabbreviation is shown in uppercase letters.

¶ Examples of using the option on the command line.


ArchmcThe archmc option specifies the available management class foryour policy domain to which you want to bind your archived files.

SyntaxÊÊ ARCHMc managementclass ÊÍ

Parametersmanagementclass

Specifies an available management class in the active policy setof your policy domain. This management class overrides thedefault management class for the files you are archiving.

ExamplesCommand line:

dsmc archive –archmc=RET2YRS c:\plan\proj1\budget.jan\*


9.U

singO

ptionsw

ithC

omm

ands

ClassThe classoption specifies whether to display a list of NAS objectsor client objects when using the following commands:¶ query backup¶ delete filespace¶ query filespace

For example, to display a list of the file spaces belonging to a NASnode, specify theclass=nasoption with thequery filespacecommand.

Syntax

ÊÊclient

CLASSnas

ÊÍ

Parametersnas

Specifies that you want to display a list of file spaces for a NASnode.

clientSpecifies that you want to display a list of file spaces for a clientnode. This is the default.


q backup -class=nas


DeletefilesUse thedeletefilesoption with thearchive command to deletearchived files from your workstation.

SyntaxÊÊ DELetefiles ÊÍ



dsmc archive c:\foo\*.c –deletefiles


9.U

singO

ptionsw

ithC

omm

ands

DescriptionThe descriptionoption assigns or specifies a description for fileswhen performing archive, delete, retrieve, or query archiveoperations. For example, if you want to archive a file namedbudget.jan and assign to it the description1999 Budget for Proj 1,you would enter:

dsmc archive –des="1999 Budget for Proj 1" c:\plan\proj1\budget.jan

You can also use this option to specify the description of a backupset that you want to query.

SyntaxÊÊ DEScription description ÊÍ

Parametersdescription

Assigns a description to the file you are archiving. If you do notspecify a description, the default isarchive date:x, wherex isthe current system date.

If you use thearchive command to archive more than one file,the description you enter applies to each file. For example, toarchive a group of files and assign the same description,ProjectX, to each file, you would enter:

dsmc archive –description="Project X" c:\allproj\*.x

You can then use the description to retrieve all of the files.


dsmc archive –des="1999 Budget for Proj 1" c:\foo\*.prj


DetailThe detail option displays detailed information about eachmanagement class in your active policy set. If you do not use thedetail option, only the management class name and a briefdescription displays. If you specify thedetail option, informationabout attributes in each copy group contained in each managementclass will display. A management class can contain a backup copygroup, an archive copy group, both, or neither.

For Windows NT, 2000 Unicode-enabled clients: A Unicode-enabledfile space may not display correctly if the server cannot display theUnicode name. In this case, use the file space identifier (fsID) of thefile space to identify these file spaces on the server. Use thedetailoption with thequery filespacecommand to determine the fsID of afile space. The fsID also displays in the file information dialog inthe native and Web client GUIs.

SyntaxÊÊ DETail ÊÍ



dsmc query mgmtclass -detail


9.U

singO

ptionsw

ithC

omm

ands

DirsonlyThe dirsonly option processes directoriesonly.

SyntaxÊÊ DIrsonly ÊÍ



dsmc query backup -dirsonly c:*


FilelistUse thefilelist option to process a list of files. The Tivoli StorageManager client opens the file you specify with this option andprocesses the list of files within according to the specific command.With the exception of therestore and retrieve commands, when youuse thefilelist option, Tivoli Storage Manager ignores all other filespecifications on the command line.

The files (entries) listed in the filelist must adhere to the followingrules:¶ Each entry must be a fully or partially qualified path to a file or

directory or a relative path.¶ Each entry must be on a new line.¶ Do not use wildcards characters.¶ Each entry results in the processing of only one object (file or

directory).¶ If the file name contains any spaces, enclose the file name with

quotes.¶ The filelist can be an MBCS file or a Unicode file with all

Unicode entries. This is valid on Windows NT, 2000only.¶ Tivoli Storage Manager ignores any entry that is not valid.

The following is an example of a list of files within a filelist:c:\myfiles\directory\file1c:\tivoli\mydir\yourfile.doc..\notes\avi\dir1..\fs1\dir2\file3"d:\fs2\Ha Ha Ha\file.txt""d:\fs3\file.txt"

If an entry in the filelist indicates a directory, only that directory willprocess and not the files within the directory.

If the file name (thefilelistspec) you specify with thefilelistoption does not exist, the command fails. Tivoli Storage Managerskips any entries in the filelist that are not valid files or directories.Tivoli Storage Manager logs errors associated with an entry in thefilelist, and processing continues to the next entry.


9.U

singO

ptionsw

ithC

omm

ands

Use file specifications with therestore and retrieve commands todenote the destination for the restored filelist entries. For example, inthe restore command:restore -filelist=c:\filelist.txtd:\dir\, the file specificationd:\dir represents the restoredestination for all entries in the filelist. However, in theselectivecommand:selective -filelist=c:\filelist.txt d:\dir, thefile specificationd:\dir is ignored.

If you specify a directory in a filelist for thedelete archivecommand, the directory is not deleted. Filelists that you use with thedelete archivecommand should not include directories. Afterdeleting the files, use wildcard specifications on the command line todelete the directories.

The entries in the list will be processed in the order they appear inthe filelist. For optimal processing performance, pre-sort the filelistby filespace name and path.

Note: Tivoli Storage Manager may be back up a directory twice ifthe following conditions exist:¶ The filelist contains an entry for the directory¶ The filelist contains one or more entries for files within

that directory¶ No backup of the directory exists

For example, your filelist includes the entriesc:\dir0\myfile andc:\dir0. If the \dir0 directory doesnot exist on the server, thec:\dir0 directory is sent to theserver a second time.

SyntaxÊÊ FILEList filelistspec ÊÍ

Parametersfilelistspec

Specifies the location and name of the file that contains the listof files to process with the command.


Note: When you specify thefilelist option on the command line,you cannot use thesubdir option.


sel -filelist=c:\avi\filelist.txt


9.U

singO

ptionsw

ithC

omm

ands

FilesonlyThe filesonly option restricts backup and restore processing to filesonly. You cannot restore or retrieve directories from the server whenusing thefilesonly option with therestore or retrieve commands.However, directories with default attributes are created, if required,as placeholders for files that you restore or retrieve.

SyntaxÊÊ FILESOnly ÊÍ



dsmc incremental -filesonly


FromdateThe fromdateoption specifies a date from which you want to searchfor backed up or archived files. Files that were backed up orarchived before this date are not included, although older directoriesmight be included, if necessary, to restore or retrieve the files.

SyntaxÊÊ FROMDate date ÊÍ

Parametersdate

Specifies the date from which you want to search for backupcopies or archived files. Enter the date in the format you selectedwith the dateformatoption.

When you includedateformatwith a command, it must precedethe fromdate, pitdate, andtodateoptions.


dsmc query backup -fromdate=12/11/1999C:\Windows\Program Files\*.exe


9.U

singO

ptionsw

ithC

omm

ands

FromnodeThe fromnodeoption permits one node to perform commands foranother node. A user on another node must use theset accesscommand to permit you to query, list, restore, or retrieve files forthat other node.

SyntaxÊÊ FROMNode node ÊÍ

Parametersnode

Specifies the node name on a workstation or a file server whosebackup copies or archived files you want to access.


dsmc query archive -fromnode=bob -subdir=yes d:\


FromtimeUse thefromtime option with thefromdateoption to specify abeginning time. This option is ignored if you do not specify thefromdateoption.

SyntaxÊÊ FROMTime time ÊÍ

Parameterstime

Specifies a beginning time on a specific date. If you do notspecify a time, the time defaults to 23:59:59. Specify the time inthe format you selected with thetimeformat option.

When you include thetimeformat option in a command, it mustprecede thefromtime, pittime, andtotime options.


dsmc q b -timeformat=4 -fromt=11:59AM-fromd=06/30/99 -tot=11:59PM -tod=06/30/99 c:\*


9.U

singO

ptionsw

ithC

omm

ands

IfnewerThe ifnewer option replaces an existing file with the backup if thebackup is newer than the existing file. Only active backups areconsidered unless you also use theinactive or latestoptions.

Note: This option is ignored if thereplaceoption is set toNo.

SyntaxÊÊ IFNewer ÊÍ



dsmc restore -ifnewer d:\logs\*.log


InactiveUse theinactive option with thepick option and the followingcommands:¶ restore¶ restore nas¶ query backup

You can also use thepick option to display backup versions andarchive copies that match the file specification you enter.

Only active backups are considered unless you also use either theinactive or the latestoption.

SyntaxÊÊ INActive ÊÍ



dsmc restore -inactive c:\id\projecta\


9.U

singO

ptionsw

ithC

omm

ands

Incrbydate

Note: If you have limited time during the week to perform backups,but extra time on weekends, you can maintain current serverstorage of your workstation files by performing a partialincremental backup on weekdays and a full incrementalbackup on weekends.

Use theincrbydateoption with theincremental command to backup new and changed files with a modification date later than the lastincremental backup stored at the server, unless the file is excludedfrom backup. Files added at the client after the last incrementalbackup, but with a modification date earlier than the lastincremental, are not backed up.

An incremental-by-date updates the date and time of the lastincremental at the server. If an incremental-by-date is performed ononly part of a file system, the date of the last full incremental is notupdated and the next incremental-by-date will back up these filesagain.

Both full and partial incrementals back up new and changed files.An incremental-by-date takes less time to process than a fullincremental and requires less memory. However, unlike a fullincremental, an incremental-by-date does not maintain current serverstorage ofall your workstation files because:¶ It does not expire backup versions of files that are deleted from


the management class has changed.¶ It does not back up files with attributes that have changed unless

the modification dates and times have also changed, such as NTsecurity information.

¶ It ignores the copy group frequency attribute of managementclasses.


SyntaxÊÊ INCRbydate ÊÍ



dsmc incremental -incrbydate


9.U

singO

ptionsw

ithC

omm

ands

LatestUse thelatestoption with therestore command to restore the mostrecent backup version of a file, even if the backup is inactive. Onlyactive versions are considered for a restore unless you use either theinactive or the latestoption.

SyntaxÊÊ LATest ÊÍ



dsmc restore c:\devel\projecta\ -latest


LocationThe location option specifies where Tivoli Storage Manager searchesfor the backup set for a query or restore operation. You can use thisoption to locate backup sets on the server or local files. Tapes thatare generated on the server can be used locally by specifying thelocation option and either the file name or the tape device.

Syntax

ÊÊserver

LOCationfiletape

ÊÍ

Parametersserver

Specifies that Tivoli Storage Manager searches for the backupset on the server. This is the default.

fileSpecifies that Tivoli Storage Manager searches for the backupset on a local file.

tapeSpecifies that Tivoli Storage Manager searches for the backupset on a local tape device. This parameter is valid for WindowsNT and Windows 2000 clients. The supported tape devices arethe following:¶ 8mm¶ 4mm¶ DLT¶ 3570¶ 3590

Note: For Windows NT, 2000: If you want to restore a backupset from a 3570 or 3590 tape device, but you do not have


9.U

singO

ptionsw

ithC

omm

ands

the 3570 or 3590 generic device driver on your clientworkstation, you can download these device drivers fromthe following Web site:

ftp://ftp.software.ibm.com/storage/devdrvr/


restore backupset mybackupsetname -loc=serverrestore backupset c:\mybackupsetname.prj -loc=filerestore backupset \\.\TAPE1 -loc=3570


ModeThe modeoption specifies whether you want to perform a full ordifferential image backup of NAS file systems.

Syntax

ÊÊdifferential

MODEfull

ÊÍ

Parametersfull

Specifies that you want to perform a NAS image backup of anentire file system.

differentialSpecifies that you want to perform a NAS image backup of filesthat changed since the last full image backup. If an eligible fullimage backup does not exist, a full image backup is performed.This is the default.


dsmc backup nas -mode=full -nasnodename=nas1 {/vol/vol0}{/vol/vol1}


9.U

singO

ptionsw

ithC

omm

ands

MonitorThe monitor option specifies whether you want to monitor an imagebackup or restore of one or more file systems belonging to aNetwork Attached Storage (NAS) file server. If you specifymonitor=yes, Tivoli Storage Manager monitors the current NASimage backup or restore operation and displays processinginformation on your screen. This is the default.

If you specifymonitor=no, Tivoli Storage Manager does not monitorthe current NAS image backup or restore operation and is availableto process the next command.

Use this option with thebackup nasand restore nascommands.

The monitor option is valid for all Windows clients.

Syntax

ÊÊYes

MONitorNo

ÊÍ

ParametersYes

Specifies that you want to monitor the current NAS imagebackup or restore operation and display processing informationon your screen. This is the default.

NoSpecifies that you do not want to monitor the current NASimage backup or restore operation.


backup nas -mode=full -nasnodename=nas1 -monitor=yes{/vol/vol0} {/vol/vol1}


NojournalUse thenojournal option with theincremental command to specifythat you want to perform a traditional full incremental backup,instead of the default journal-based backup.

Journal-based incremental backup differs from the traditional fullincremental backup in the following ways:¶ Tivoli Storage Manager does not enforce non-default copy

frequencies (other than 0).¶ Attribute changes to an object require a back up of the entire

object.

For these reasons, you may want to use thenojournal option toperform a traditional full incremental backup.

See “Journal-Based Backup (Windows NT, 2000 only)” on page 357for more information about journal-based incremental backup.

This option is valid for Windows NT and Windows 2000only.

SyntaxÊÊ NOJournal ÊÍ



dsmc incr c: -nojournal


9.U

singO

ptionsw

ithC

omm

ands

NopromptThe nopromptoption suppresses the confirmation prompt thatnormally appears before an archived file is deleted. Using this optioncan speed up the delete procedure. However, it also increases thedanger of accidentally deleting an archived file that you wanted tosave.Use this option with caution.

SyntaxÊÊ NOPrompt ÊÍ



dsmc delete archive -noprompt c:\home\project\*


PickThe pick option creates a list of backup versions or archive copiesthat match the file specification you enter. From the list, you canselect the versions to process. Select theinactive option to view bothactive and inactive objects.

SyntaxÊÊ PIck ÊÍ



dsmc restore c:\project\* -pick -inactive


9.U

singO

ptionsw

ithC

omm

ands

PitdateUse thepitdateoption with thepittime option to establish a point intime for which you want to display or restore the latest version ofyour backups. Files that were backed upon or beforethe date andtime you specified, and which were not deletedbeforethe date andtime you specified, are processed. Backup versions that you createafter this date and time are ignored.

SyntaxÊÊ PITDate date ÊÍ

Parametersdate

Specifies the appropriate date. Enter the date in the format youselected with thedateformatoption.



dsmc restore -pitdate=08/01/1999 c:\myfiles\


PittimeUse thepittime option with thepitdateoption to establish a point intime for which you want to display or restore the latest version ofyour backups. Files that were backed upon or beforethe date andtime you specified, and which were not deletedbeforethe date andtime you specified, are processed. Backup versions that you createafter this date and time are ignored. This option is ignored if thepitdateoption is not specified.

SyntaxÊÊ PITTime time ÊÍ

Parameterstime

Specifies a time on a specified date. If you do not specify atime, the time defaults to 23:59:59. Specify the time in theformat you selected with thetimeformat option.



dsmc query backup -pitt=06:00:00 -pitd=08/01/1999c:\myfiles\


9.U

singO

ptionsw

ithC

omm

ands

PreservepathThe preservepathoption specifies how much of the source path toreproduce as part of the target directory path when you restore orretrieve files to a new location. Use the-subdir=yesoption setting toinclude the entire subtree of the source directory (directories andfiles below the lowest-level source directory) as source to berestored. If a required target directory does not exist, it is created. Ifa target file has the same name as a source file, it is overwritten.Use the-replace=promptoption setting to have Tivoli StorageManager prompt you before files are overwritten.

Syntax

ÊÊsubtree

PRESERvepathcompletenobasenone

ÊÍ

Parameterssubtree

Creates the lowest-level source directory as a subdirectory of thetarget directory. Files from the source directory are stored in thenew subdirectory. This is the default.

completeRestores the entire path, starting from the root, into the specifieddirectory. The entire path includes all the directoriesexceptthefile space name.

nobaseRestores the contents of the source directory without the lowestlevel, or base directory, into the specified destination directory.

noneRestores all selected source files to the target directory. No partof the source path at or above the source directory is reproducedat the target.


If you specifysubdir=yes, all files in the source directories arerestored to the single target directory.


For the examples below, assume the server file spacecontains the following backup copies:c:\h1\m1\file.ac:\h1\m1\file.bc:\h1\m1\l1\file.xc:\h1\m1\l1\file.y

This command:dsmc res c:\h1\m1\ c:\ann\ -preservep=complete.

Restores these directories and files:c:\ann\h1\m1\file.ac:\ann\h1\m1\file.b

This command:dsmc res c:\h1\m1\ c:\ann\ -preser=nobase.

Restores these directories and files:c:\ann\file.ac:\ann\file.b

This command:dsmc res c:\h1\m1\ c:\ann\ -preser=subtree.

Restores these directories and files:c:\ann\m1\file.ac:\ann\m1\file.b

This command:dsmc res c:\h1\m1\ c:\ann\ -preser=none.

Restores these directories and files:c:\ann\file.ac:\ann\file.b

This command:dsmc res c:\h1\m1\ c:\ann\ -su=yes -preser=complete

Restores these directories and files:


9.U

singO

ptionsw

ithC

omm

ands

c:\ann\h1\m1\file.ac:\ann\h1\m1\file.bc:\ann\h1\m1\l1\file.xc:\ann\h1\m1\l1\file.y

This command:dsmc res c:\h1\m1\ c:\ann\ -su=yes -preser=nobase.

Restores these directories and files:c:\ann\file.ac:\ann\file.bc:\ann\l1\file.xc:\ann\l1\file.y

This command:dsmc res c:\h1\m1\ c:\ann\ -su=yes -preser=subtree.

Restores these directories and files:c:\ann\m1\file.ac:\ann\m1\file.bc:\ann\m1\l1\file.xc:\ann\m1\l1\file.y

This command:dsmc res c:\h1\m1\ c:\ann\ -su=yes -preser=none.

Restores these directories and files:c:\ann\file.ac:\ann\file.bc:\ann\file.xc:\ann\file.y

This command:dsmc res backupset c:\h1\m1\ c:\ann\ -su=yes-preser=nobase -loc=file

Restores these directories and files:c:\ann\file.ac:\ann\file.bc:\ann\file.xc:\ann\file.y


TodateUse thetodateoption with thetotime option to specify an endingdate and time. For example, you might request a list of files thatwere backed up before 11:59 PM on June 30, 1999.

Use thetodateand totime options with thefromtime and fromdateoptions to request a list of backed up or archived files within aperiod of time. For example, you might request a list of files thatwere backed up between 6:00 AM on July 1, 1999 and 11:59 PM onJuly 30, 1999.

SyntaxÊÊ TODate date ÊÍ

Parametersdate

Specifies an ending date. Enter the date in the format youselected with thedateformatoption.



dsmc restore -todate=12/11/1999 c:\myfiles\


9.U

singO

ptionsw

ithC

omm

ands

TotimeUse thetotime option with thetodateoption to specify an endingtime on a specified date. For example, you might request a list offiles that were backed up before 11:59 PM on June 30, 1999. Thisoption is ignored if thetodateoption is not specified.

Use thetotime and todateoptions with thefromtime and fromdateoptions to request a list of files that were backed up within a periodof time. For example, you might request a list of files that werebacked up between 6:00 AM on July 1, 1999 and 11:59 PM on July30, 1999.

SyntaxÊÊ TOTime time ÊÍ

Parameterstime

Specifies an ending time. If you do not specify a time, the timedefaults to 23:59:59. Specify the time in the format you selectedwith the timeformat option.



dsmc restore -totime=23:00:00 -todate=09/17/1999c:\somefiles\


TypeUse thetypeoption with thequery node command to specify thetype of node to query.

Syntax

ÊÊany

TYpenasserverclient

ÊÍ

Parametersany

Specifies all nodes registered at the server. This is the default.

nasSpecifies all NAS nodes registered at the server.

serverSpecifies client nodes that are other Tivoli Storage Managerservers.

clientSpecifies client nodes that are backup-archive clients.


q node -type=nas


9.U

singO

ptionsw

ithC

omm

ands

V2archiveUse thev2archiveoption with thearchive command to archive onlyfiles to the server. Directories that exist in the path of the source filespecification will not process.

This option differs from thefilesonly option in that thefilesonlyoption archives the directories that exist in the path of the source filespecification.

The v2archiveanddirsonly options are mutually exclusive and anerror message displays if you use both options in the samearchivecommand.

This option is not persistent; you must explicitly specify this optionin eacharchive command.

If you use this option, you may want to consider the following:

¶ You may experience performance problems when retrieving largeamounts of data archived with this option.

¶ You may want to use this option only if you are concerned aboutexpiration performance on a server that already containsextremely large amounts of archived data.

SyntaxÊÊ V2archive ÊÍ


ExamplesThis command:

dsmc archive c:\relx\dir1\ -v2archive -su=y

Archives these files:


c:\relx\dir1\file1c:\relx\dir1\file2c:\relx\dir1\file3c:\relx\dir1\dir2\file4c:\relx\dir1\dir2\file5

Note: c:\relx\dir1 andc:\relx\dir1\dir2 are notarchived.


9.U

singO

ptionsw

ithC

omm

ands

Using Commands

Tivoli Storage Manager provides a command line interface (CLI)that you can use as an alternative to the graphical user interface(GUI). This chapter describes how to start or end a client commandsession and how to enter commands. It also provides detailedinformation about each command. Table 27 shows a list of tasksrelated to entering commands.

Table 27. Entering CommandsTask Page

Starting and Ending a Client Command Session 316

Entering Client Commands 317

Remembering Previous Commands 321

Using Wildcard Characters 322

Table 28 provides an alphabetical list of the commands, a briefdescription, and where to locate more information.

Table 28. CommandsCommand Description Page

archive Archives files from a workstation toTivoli Storage Manager storage.

324

backupactivedirectory

Backs up a Windows 2000 ActiveDirectory database.

326

backupcertserverdb

Backs up a Windows 2000 certificateserver database.

327

10


10.U

singC

omm

ands

Table 28. Commands (continued)Command Description Page

backup clusterdb Backs up the Microsoft cluster servicescluster database on a Windows 2000Server.

328

backup complusdb Backs up the Windows 2000 COM+database.

329

backup eventlog Backs up Windows NT, 2000 event logs. 330

backup frs Backs up replicated file systems onWindows 2000.

332

backup nas Creates an image backup of one or morefile systems belonging to an NAS fileserver.

333

backup registry Backs up the Windows registry. 336

backup rsm Backs up the removable storage managerdatabase on a Windows 2000 Server.

340

backup sysfiles Backs up Windows 2000 system andboot files.

342

backupsystemobject

Backs up all valid Windows NT, 2000system objects.

343

backup sysvol Backs up the Windows 2000 Serversystem volume.

345

cancel process Displays a list of current NAS backupand restore processes and permits you toselect one process to cancel.

346

cancel restore Displays a list of restartable restoresessions and permits you to select one tocancel.

347

delete access Revokes authorization for a user torestore or retrieve files.

348

delete archive Deletes archived files from TivoliStorage Manager storage.

349

delete filespace Deletes file spaces in Tivoli StorageManager storage.

351

expire Inactivates backup objects you specify. 353

help Displays online command help. 355



incremental Backs up new and changed files. 356

loop Starts an interactive command session. 365

macro Executes commands within a macro fileyou specify.

366

monitor process Displays a list of current NAS backupand restore processes. You can thenselect one process to monitor.

367

query access Displays a list of current authorizationrules.

368

queryactivedirectory

Displays information about the activebackup of the Active Directory systemobject.

369

query archive Displays a list of archived files. 370

query backup Displays a list of backup versions. 373

query backupset Queries a backup set from the server or alocal file.

376

query certserverdb Displays information about the activebackup of the certificate server databasesystem object.

378

query clusterdb Displays information about the activebackup of the Microsoft Cluster Servicescluster database system object.

379

query complusdb Displays information about the activebackup of the COM+ database systemobject.

380

query eventlog Displays information about the activebackup of the Windows 2000 event logsystem object.

381

query filespace Displays a list of file spaces in TivoliStorage Manager storage.

382

query frs Displays information about the activebackup of the File Replication Services(FRS) system object.

384


10.U

singC

omm

ands


query inclexcl Displays a list of include-excludestatements in the order in which they areprocessed during backup and archiveoperations.

385

query mgmtclass Displays information about availablemanagement classes.

386

query node Displays all the nodes for which aparticular administrative user ID hasauthority to perform operations. Theauthorized administrative user ID shouldhave at least client owner authority overboth the NAS node and the clientworkstation node they are using eitherfrom command line or from the web.

387

query registry Displays information about the activebackup of the Windows 2000 registrysystem object.

388

query restore Displays a list of your restartable restoresessions in the server database.

389

query rsm Displays information about the activebackup of the Removable StorageManager (RSM) database system object.

391

query schedule Displays information about scheduledevents.

392

query session Displays information about the currentsession.

393

query sysfiles Displays information about the activebackup of the Windows 2000 system andboot files system object.

394

query systemobject Displays information about the activebackup of specific Windows 2000 systemobjects.

395

query sysvol Displays information about the activebackup of the Windows 2000 systemvolume system object.

396



restart restore Displays a list of restartable restoresessions and permits you to select one torestart.

397

restore Restores backup versions from TivoliStorage Manager storage.

398

restoreactivedirectory

Restores a Windows 2000 Server ActiveDirectory database and associated logs.

406

restore backupset Restores a backup set from the server ora local file.

407

restore certserverdb Restores a Windows 2000 certificateserver database.

411

restore clusterdb Restores the Microsoft Cluster Servicescluster database on a Windows 2000Server.

412

restore complusdb Restores a Windows 2000 COM+database.

413

restore eventlog Restores the active Windows NT, 2000event logs.

414

restore frs Restores a replicated file system on aWindows 2000 Server.

416

restore nas Restores the image of a file systembelonging to an NAS file server.

417

restore registry Restores the Windows registry. 420

restore rsm Restores RSM database files on aWindows 2000 Server.

425

restore sysfiles Restores Windows 2000 system and bootfiles.

427

restoresystemobject

Restores valid active Windows 2000system objects stored on the server.

428

restore sysvol Restores the a Windows 2000 systemvolume.

429

retrieve Retrieves archived files from TivoliStorage Manager storage.

430


10.U

singC

omm

ands


schedule Starts the client scheduler on theworkstation.

436

selective Backs up selected files. 438

set access Authorizes another user to access yourbackup versions or archive copies.

441

set password Changes the Tivoli Storage Managerpassword for your workstation.

444

Starting and Ending a Client Command SessionYou can start or end a client command session in either batch modeor interactive mode. Use batch mode when you want to enter asingleclient command. Tivoli Storage Manager processes thecommand and returns to the command prompt.

Use interactive mode when you want to enter aseriesof commands.Since Tivoli Storage Manager establishes connection to the serveronly once for interactive mode, a series of commands can processmore quickly. Tivoli Storage Manager processes the commands andreturns to thetsm> prompt.

Process Commands in Batch ModeWhen you enter asinglecommand in batch mode, precede it withthe executable program name,dsmc. For example, to process theincremental command in batch mode, you would enter:

dsmc incremental

If a password is required, Tivoli Storage Manager prompts you eachtime you enter a command if thepasswordaccessoption is set toprompt, or authentication on the server is set toOn. Type yourpassword and press Enter.


You can also enter your password using thepasswordoption with acommand, but your password appears on the screen. For example, ifyour password issecret, enter:

dsmc incremental –password=secret

If you set thepasswordaccessoption togeneratein your dsm.optfile, you do not need to specify the password with the command.Tivoli Storage Manageronly prompts you for your password if youare registering your workstation with a server or manually changingyour password.

To end a batch mode session, enterquit at the prompt.

Process Commands in Interactive ModeUse theinteractivemode to enter a series of commands. Enterdsmcon the command line and press Enter.Do not precede eachcommand with the executable program name,dsmc. When thetsm>command prompt displays, type the command name and press Enter.Alternatively, you can enterdsmc loopon the command line to starta client command session in interactive mode.Loop is the defaultcommand fordsmc.

If a password is required, Tivoli Storage Manager prompts you whenyou enter the first command. Type your password and press Enter.You can also enter your password using thepasswordoption withthe loop command, but your password is displayed. For example, ifyour password issecret, you would enter:

dsmc loop –password=secret

To end an interactive session, enterquit at the prompt.

Entering Client CommandsA client command can include one or more of these components:¶ Command name¶ Options¶ Parameters

The sections that follow describe each of these components.


10.U

singC

omm

ands

Command NameThe first part of a command is the command name. The commandname consists of a single word, such ashelp or schedule, or anaction word and an object for that action, such asquery archive.Enter the full command name, or its minimum abbreviation. Forexample, you can enter any of the following versions of thequeryschedulecommand:

query scheduleq scq schedquery sc

OptionsThere are two groups of options that you can use with commands:

¶ Client options: The group of options that are set in your clientoptions file (dsm.opt). To override an option in the clientoptions file, enter the option with a command. For detailedinformation about client options, see “Setting Common Options”on page 127.

¶ Client command options: Use this group of options withspecific commands on the command lineonly. For detailedinformation about client command options, see “Using Optionswith Commands” on page 269.

ParametersCommands can have required parameters, optional parameters, or noparameters at all. Required parameters provide information toperform a task. The most commonly required parameter is a filespecification. For example, if you want to archive a file namedbudget.fin from thec:\project directory, you would enter:

dsmc archive c:\project\budget.fin

Some commands have optional parameters. If you do not enter avalue for an optional parameter, Tivoli Storage Manager uses thedefault value. For example, therestore command includes a requiredparameter,sourcefilespec, that specifies the path and file name instorage that you want to restore. The optional parameter,destinationfilespec, specifies the path and file name where you want


to place the restored files. If you do not specify thedestinationfilespec, by default Tivoli Storage Manager restores thefiles to the original source path. If you want to restore the files to adifferentdirectory, enter a value fordestinationfilespec. For example,to restorec:\project\budget.fin to c:\newproj\newbudg.fin,you would enter:

dsmc restore c:\project\budget.fin c:\newproj\newbudg.fin

Enter parameters in the order indicated in the command syntaxdiagram.

File Specification SyntaxUse the following syntax rules when specifying file specificationparameters, such asfilespec, sourcefilespec, anddestinationfilespec:

¶ If a file specification does not begin with a file space name (anopening directory delimiter), the file specification is assumed tobe a subdirectory of the current working directory and TivoliStorage Manager builds the fully qualified file specification. Forexample, if the current working directory isc:\home\me, thenthe destinationfilespecwould bec:\home\me\mydir in thefollowing command:

dsmc restore c:\fs\dir1\ mydir\

¶ When entering thesourcefilespec, if the directory name endswith \, then\* is implied.

When entering a file specification, if the name ends with\, thenit is considered a directory, otherwise it is considered a file.

The following example illustrates these two rules. Even thoughmydir andyourdir are directories, the command will failbecause\* is implied aftermydir, andyourdir is considered afile:restore c:\home\mydir\ c:\away\yourdir

The following example illustrates the second rule. Even thoughmydir andyourdir are directories, the command will failbecausemydir andyourdir are considered files:restore c:\home\mydir c:\away\yourdir


10.U

singC

omm

ands

¶ Do not use wildcards as part of the file space name or anywherein the destinationfilespec. The one exception to this rule is theset accesscommand where wildcards are permitted in the twolowest-levels of the file spec. For example, use the followingcommand to grant access to all files in and below the\fs\dir1directory:

dsmc set access c:\fs\dir1\*\*

¶ The maximum number of characters for a file name is 256. Themaximum number of characters for a path name is 260characters.

¶ Microsoft Dfs volumes are accessed using the standard UNCnames. The following are examples of valid syntax to access MSDfs volumes:

\\Server_Name\Dfs_Root_Name\path\\Fault_Tolerant_Name\Dfs_Root_Name\path

¶ The maximum number of file specifications per command:v Query can contain only one file specification.v Restore and Retrieve can contain two file specifications.v Archive, delete, Incremental, and Selective can contain up to

20 file specifications.

Separate file specifications with a blank space.

Maximum File Size for OperationsTable 29 specifies the maximum file sizes for backup, restore,archive, and retrieve operations.

Table 29. Maximum File Size for Backup, Restore, Archive, andRetrievePlatform Max File Size (in bytes)

(FAT16) 2,147,483,647 (2GB)

(FAT32) 4,294,967,295 (4GB)

(NTFS) 17,592,185,978,880 (16TB-64K)


Remembering Previous CommandsIf you specify theeditor=yesoption in your client options filedsm.opt, Tivoli Storage Manager permits you to recall and edit asmany as 20 previously entered commands by using the Up arrowand Down arrow keys. If you specify theeditor=no option, thefeature to recall previous commands is not active. If the editor andcommand retrieve functions are not working on a specificworkstation setting, you should turn off theeditor option. For moreinformation regarding theeditor option, see “Editor” on page 170.

Pressing the Up arrow key displays the previous command inmemory. Pressing the Down arrow key displays the next commandin memory. Table 30 lists other functions you can perform when yourecall commands.

Table 30. Command Recall and Edit FunctionsFunction Press

Display the previous command in memory. Up arrow

Display the next command in memory. Down arrow

Move to the beginning of the command. Home

Move to the end of the command. End

Move to the left. Left arrow

Move to the right. Right arrow

Move eight spaces to the right. Tab right

Delete a character to the right of the cursor. Delete

Delete a character to the left of the cursor. Backspace

Insert a character. Toggle the Insert key

Finish or execute the command. Enter

Quit the program. F3 or Esc

End the program. CTRL-C


10.U

singC

omm

ands

Using Wildcard CharactersIn a command, you can use wildcard characters in the file name orfile extensiononly. You cannot use them to specify destination files,drives, or directories. Use wildcard characters when you want tospecify multiple files with similar names inonecommand. Withoutwildcard characters, you must repeat the command for each file.Valid wildcard characters that you can use include:* Asterisk. Matches zero or more characters.? Question mark. Matches any single character at the present

position.

Table 31 shows examples of each wildcard.

Table 31. Wildcard CharactersPattern Matches Does Not Match

Asterisk (*)

ab* ab, abb, abxxx a, b, aa, bb

ab*rs abrs, abtrs, abrsrs ars, aabrs, abrss

ab*ef*rs abefrs, abefghrs abefr, abers

abcd.* abcd.c, abcd.txt abcd, abcdc, abcdtxt

Question Mark (?)

ab? abc ab, abab, abzzz

ab?rs abfrs abrs, abllrs

ab?ef?rs abdefjrs abefrs, abdefrs, abefjrs

ab??rs abcdrs, abzzrs abrs, abjrs, abkkkrs

Entering CommandsFollow the general rules below when you enter commands:

¶ Enter a maximum of 256 characters on the command line. Enterthe characters in a continuous string. If you press the return key,the command will process.

¶ When you enter options with a command, always precede theoption with a dash (–).


¶ Enter more than one option in any order in a command before orafter the file specification. Separate multiple options with ablank space.

Client Commands ReferenceThe following sections contain detailed information about each ofthe Tivoli Storage Manager commands. These commands arearranged in alphabetical order. Information for each commandincludes:

¶ A description of the command.

¶ A syntax diagram of the command. The command name isshown in a combination of uppercase and lowercase characters.The uppercase characters indicate the minimum abbreviation youcan use for the command name. See “Reading Syntax Diagrams”on page xxvii for an explanation of these diagrams.

¶ Detailed descriptions of the command parameters. If theparameter is a constant (a value that does not change), theminimum abbreviation is shown in uppercase letters.

¶ Examples of using the command.


10.U

singC

omm

ands

ArchiveThe archive command archives a single file, selected files, or allfiles in a directory and its subdirectories on a server.

Archive files that you want to preserve in their current condition. Torelease storage space on your workstation, delete files as you archivethem. Retrieve the archived files to your workstation whenever youneed them again.

Migrating to Unicode-Enabled File SpacesPlease see “Autofsrename” on page 148 for information about usingthe Unicode-enabled client.

Syntax

ÊÊ ARchiveoptions

» filespec ÊÍ

Parametersoptions

You can use these command line options with thearchivecommand:archmc, deletefiles, description, dirsonly, filelist. Formore information about command line options, see “UsingOptions with Commands” on page 269.

You can use theautofsrename, changingretriesandsubdircommon options with thearchive command. See “SettingCommon Options” on page 127 for information about thesecommon options.

filespecSpecifies path and name of the file you want to archive. You canuse wildcards to specify groups of files or all the files in adirectory. You can also enter more than one file specification ina command. See “Maximum File Size for Operations” onpage 320 for the maximum file size for archive processing.


ExamplesTask Archive a single file namedbudget.jan in the

c:\plan\proj1 directory.

Command: archive c:\plan\proj1\budget.jan

Task Archive all files in thec:\plan\proj1 directory that containa file extension of.txt.

Command: archive c:\plan\proj1\*.txt

Task Archive all files in thec: drive.

Command: archive -subdir=yes c:\*.*

Task Archive all files in the Microsoft DFS volume,MyDfsVolume. You must specifysubdir=yesto archiveallfiles in the volume.

Command: archive\\myserver\mydfsroot\mydfsvolume\*.*


10.U

singC

omm

ands

Backup ActivedirectoryThe backup activedirectory command backs up an Active Directorydatabase on Windows 2000 Server operating system running ActiveDirectory Services. Tivoli Storage Manager backs up the databaseand associated transaction logs. Tivoli Storage Manager deletes thelogs after the database back up.

For information on system objects that you must back up together,see “Backing Up System Objects” on page 49.

SyntaxÊÊ BACKup ACTIVEDirectory

optionsÊÍ

Parametersoptions

For information about common options that you can use withthis command, see “Setting Common Options” on page 127.

ExamplesTask Back up the Active Directory on the local server.

Command: backup actived


Backup CertserverdbThe backup certserverdb command backs up a Windows 2000certificate server database, specifically the server database of clientx.509 certificates. The Certificate Server Database must be on-line toperform a backup. For information on system objects that you mustback up together, see “Backing Up System Objects” on page 49.

This command is valid for Windows 2000 Server operating systems.

SyntaxÊÊ BACKup CERTServerdb

optionsÊÍ

Parametersoptions


ExamplesTask Back up the certificate server database.

Command: back certs


10.U

singC

omm

ands

Backup ClusterdbThe backup clusterdb command backs up a Windows 2000Microsoft Cluster Services cluster database for the local cluster. Forinformation on system objects that you must back up together, see“Backing Up System Objects” on page 49.


SyntaxÊÊ BACKup CLUSTERDB

optionsÊÍ

Parametersoptions


ExamplesTask Back up the Microsoft Cluster Services cluster database.

Command: back clusterdb


Backup ComplusdbThe backup complusdbcommand backs up the Windows 2000COM+ database. COM is a system component model that createsnon-graphic entities without the need to rely on language features ofthe entity’s particular class. COM+ is the integration of MicrosoftTransaction Server (MTS) and Microsoft Message Queuing (MSMQ)with the core operating system.

For information on system objects that you must back up together,see “Backing Up System Objects” on page 49.

This command is valid for Windows 2000 Server, Windows 2000Professional operating systems.

SyntaxÊÊ BACKup COMPlusdb

optionsÊÍ

Parametersoptions


ExamplesTask Back up the COM+ database.

Command: back comp


10.U

singC

omm

ands

Backup EventlogThe backup eventlogcommand backs up the Windows NT andWindows 2000 event logs. For Windows NT, you can back up oneor a combination of these logs: application, security, system.

For Windows 2000, this command backs up all event logs availableto the operating system. The back up of the Windows 2000 event logwill determine which logs will process by enumerating the sub-keysof registry key:- HKLM\SYSTEM\CurrentControlSet\Services\Eventlog

This ensures that all Windows 2000 event logs will process.

Tivoli Storage Manager saves the log copies in theadsm.sys\eventlog directory under root directory of the systemdrive before sending them to the server for backup.

SyntaxFor Windows 2000

ÊÊ BACKup Eventlog ÊÍ

For Windows NT

ÊÊ BACKup EventlogENTIRE

LOG APPLICATIONSECURITYSYSTEM

Ê

Êoptions

ÊÍ


Parameters

Note: For Windows 2000 there are no parameters.

The following parameters are for Windows NT.

ENTIREBacks up the application, security and system logs.

LOGBacks up one of the following event logs:

APPLICATIONBacks up the application event log.

SECURITYBacks up the security event log.

SYSTEMBacks up the system event log.

optionsFor information about common options that you can use withthis command, see “Setting Common Options” on page 127.

ExamplesTask Back up the entire event log.

Command: back event entire

Task Back up the security event log.

Command: back event log security


10.U

singC

omm

ands

Backup FRSThe backup frs command backs up the File Replication Services(FRS) data on a Windows 2000 Server operating system. FRSmaintains a list of replicated files; Tivoli Storage Manager backs upthe files that display in this list.


SyntaxÊÊ BACKup FRs

optionsÊÍ

Parametersoptions


ExamplesTask Back up replicated file systems.

Command: back frs


Backup NASThe backup nascommand creates an image backup of one or morefile systems belonging to a Network Attached Storage (NAS) fileserver. The NAS file server performs the outboard data movement. Aserver process starts in order to perform the backup.

Use thenasnodenameoption to specify the node name for the NASfile server. When using an interactive command line session with anon-administrative ID, Tivoli Storage Manager prompts for anadministrator ID. The NAS node name identifies the NAS file serverto the Tivoli Storage Manager server; the NAS node name must beregistered at the server. Place thenasnodenameoption in your clientoptions filedsm.opt. The value in the client options file is thedefault, but can be overridden on the command line. See“Nasnodename” on page 209 for more information.

Use themodeoption to specify whether to perform a full ordifferential NAS image backup. A full image backup backs up theentire file system. The default is a differential NAS image backup onfiles that change since the last full image backup. If an eligible fullimage backup does not exist, a full image backup is performed. See“Mode” on page 295 for more information.

Use themonitor option to specify whether you want to monitor aNAS file system image backup and display processing informationon your screen. See “Monitor” on page 296.

Use themonitor processcommand to display a list of currentrestore processes for all NAS nodes for which your administrativeuser ID has authority. The authorized administrative user ID shouldhave at least client owner authority over both the NAS node and theclient workstation node they are using either from command line orfrom the web.

Use thecancel processcommand to stop NAS back up processing.For more information, see “Cancel Process” on page 346.

The backup nascommand is valid for Windows NT and Windows2000 clientsonly.


10.U

singC

omm

ands

A NAS file system specification uses the following conventions:¶ Regardless of client platform, NAS file system specifications use

the forward slash (/) separator, as in this example:/vol/vol0.¶ NAS file system designations on the command line require brace

delimiters {} around the file system names, such as:{/vol/vol0}.

Syntax

ÊÊ Backup NASoptions

» filespec ÊÍ

Parametersoptions

You can use these common options with thebackup nascommand:monitor, nasnodename, quiet, verbose. For moreinformation, see “Setting Common Options” on page 127.

You can use themodecommand line option with thebackupnas command. For more information, see “Using Options withCommands” on page 269.

filespecSpecifies the name of one or more file systems on the NAS fileserver. If you do not specify this parameter, Tivoli StorageManager processes all of the file systems defined by thedomain.nasoption. For more information about this option, see“Domain.nas” on page 168.

If you do not specify thefilespecor thedomain.nasoption, thedefaultdomain.nas=all-nas value is used and all file systems onthe NAS file server are backed up.

ExamplesTask Perform the NAS image backup of the entire file system.

Command: backup nas -mode=full -nasnodename=nas1{/vol/vol0} {/vol/vol2}


Task Perform the NAS image backup of the entire file server.

Command: backup nas -nasnodename=nas1


10.U

singC

omm

ands

Backup RegistryThe backup registry command backs up the Windows registry. Theregistry is a centralized database that contains information abouthardware, applications, and operating system settings for eachworkstation on the network. Normally, Tivoli Storage Manager backsup the registry during incremental backups.

Use thebackup registry commandonly if the backupregistryoptionis set atno, preventing back up of the registry. You may also usethis command if you must back up the registry immediately.

Registry backups are copied to theadsm.sys directory under theroot directory of the system drive. If you are using Windows 98 orWindows Me, the directory isadsm98.sys. The registry is thencopied to the server. Tivoli Storage Manager will not back up thecopied registry files in theadsm.sys directory if you exclude thesefiles in your include-exclude list.

To back up all profiles in hkey_users, you can issue the commandbackup registry user curuser. The name of the profile will be theactual registry key with the following filename:adsm.sys\registry\machine\users\userprofiledir\S-1-5-21-8533442-1654749355-78804774-1152

In the above example,machine is the name of the workstation onwhich the profiles reside anduserprofiledir is the user profiledirectory specified in the registry for that user.

This registry key also identifies the SID of the current user.

If the Web client service is run in the context of the local systemaccount,Restore User Profileis not available. This happens becausethere is no user profile to restore on a local system account.

For information on system objects that must be backed up together,see “Backing Up System Objects” on page 49.



ÊÊ BACKup REgistry ÊÍ

For Windows NT

ÊÊ BACKup REgistryENTIRE

MACHINE SAMSECURITYSOFTWARESYSTEM

USER CURUSERDEFAULT

Ê

Êoptions

ÊÍ

For Windows 98, Me

ÊÊ BACKup REgistryENTIRE

MACHINE CONFIGENUMHARDWARENETWORKSECURITYSOFTWARESYSTEM

USERDEFAULT

Ê


10.U

singC

omm

ands

Êoptions

ÊÍ

Parameters

Note: For Windows 2000 there are no parameters. Thebackupregistry command backs up the system registry hives listedin:HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\hivelist

The following parameters are for Windows 98, Me, and NT.

ENTIREBacks up all of theMachineandUser hives listed below. This isthe default.

MACHINEBacks up one of the following machine root key hives (registrysubkeys):

CONFIGValid for Windows 98 and Me only. Backs up the hive(hkey_local_machine\config subkey).

ENUMValid for Windows 98 and Me only. Backs up the hive(hkey_local_machine\enum subkey).

HARDWAREValid for Windows 98 and Me only. Backs up the hive(hkey_local_machine\hardware subkey).

NETWORKValid for Windows 98 and Me only. Backs up the hive(hkey_local_machine\network subkey).

SAMValid for Windows NT only. Backs up the Security AccountsManager (SAM) hive (hkey_local_machine\sam subkey).


SECURITYBacks up the security policy hive(hkey_local_machine\security subkey).

SOFTWAREBacks up the local machine software configuration hive(hkey_local_machine\software subkey).

SYSTEMBacks up the local machine system configuration hive(hkey_local_machine\system subkey).

USERBacks up one of the following user root key hives (registrysubkeys):

CURUSERValid for Windows NT only. Backs up the current (loggedon) user profile.

DEFAULTBacks up the default user profile hive (hkey_users\defaultsubkey).

optionsFor information about common options that you can use withthis command, see “Setting Common Options” on page 127.

ExamplesTask Backup the entire registry.

Command: backup reg entire

Task Backup the Security Accounts Manager (SAM).

Command: backup reg machine sam


10.U

singC

omm

ands

Backup RSMRemovable Storage Manager (RSM) service runs on Windows NTServer and Windows 2000 Server operating systems. Thebackuprsm command backs up the RSM database. The backup copy isplaced in\windows\system32\ntmsdata\export. Then thecommand performs a selective backup of the copy to the server. TheRSM server continues to run during the backup process.

Note: Although thebackup rsm command backs up the RSMdatabase, the command does not back up the data managed byWindows 2000 Remote Storage Service (RSS). To back upand restore offline data managed by RSS, you must use theMicrosoft Backup Utility. Following are somerecommendations for working with offline RSS-managed data:

¶ Restore the RSM database before using Microsoft BackupUtility to restore the offline data managed by RSS.

¶ Retrieve all offline data from RSS that you want toprocess with Tivoli Storage Manager via the MicrosoftBackup Utility before using the Tivoli Storage Managerclient.

¶ Due to a Windows 2000 issue, you must reboot theWindows 2000 Server to complete the restore of the RSMdatabase.

Windows 2000 Servers (Server, Advanced Server and DatacenterServer) may allow many applications to share a bulk storage device.On these servers, RSM manages data on removable storage mediathat exists in a media pool. This data is accessible by mediaapplication and media management programs; the data can be sharedand traced across applications. Tivoli Storage Manager serverssupport RSM by creating application pools for backup media. TivoliStorage Manager clients support RSM recovery by creating a backupof the RSM database when running on a Windows 2000 Server.


SyntaxÊÊ BACKup RSm

optionsÊÍ

Parametersoptions


ExamplesTask Perform a backup of the RSM database.

Command: back rsm


10.U

singC

omm

ands

Backup SysfilesThe backup sysfilescommand backs up Windows 2000 system andboot files. System and boot files consist of the following:¶ All files that are protected by system file protection¶ All files that are in the system file protection service catalog

directory¶ Performance counter configuration files

These files are backed up as a single system object; individual fileswithin this object are backed up as normal files.


SyntaxÊÊ BACKup SYSFiles

optionsÊÍ

Parametersoptions


ExamplesTask Back up system and boot files.

Command: back sysf


Backup SystemobjectThe backup systemobjectcommand backs up all valid systemobjects. For Windows 2000, the following system objects are backedup:¶ Active Directory (domain controller only)¶ Certificate Server Database¶ Cluster Database (cluster node only)¶ COM+ database¶ Registry¶ System and boot files¶ System volume¶ Event logs (system, security and application)¶ Removable Storage Management Database (RSM)¶ Replicated file systems

For Windows NT, the registry and eventlog system objects arebacked up.

Note: Include-exclude statements do not affect system objectprocessing. It is unnecessary to explicitly include the registrystaging directoryinclude c:\adsm.sys\...\* for back up,to ensure that the registry is backed up properly. If youaccidently exclude a directory that is critical to a systemobject backup, the system object backup is not affected.

The restore systemobjectcommand is not valid for Windows 98,Me, or NT. To restore the Windows 98, Me, or NT registry, use therestore registry command. To restore the Windows NT eventlog,use therestore eventlogcommand.

SyntaxÊÊ BACKup SYSTEMObject ÊÍ

ParametersThere are no parameters for this command.


10.U

singC

omm

ands

ExamplesTask Back up all valid system objects.

Command: backup systemobject


Backup SysvolThe backup sysvolcommand backs up a Windows 2000 systemvolume. This is data that has been replicated from the ActiveDirectory and is not part of the directory tree database. Systemvolume data must be marked as such in the FRS set.

This system object is found only on a Windows 2000 Serverfunctioning as a domain controller.


SyntaxÊÊ BACKup SYSVol

optionsÊÍ

Parametersoptions


ExamplesTask Back up a system volume.

Command: back sysvol


10.U

singC

omm

ands

Cancel ProcessThe cancel processcommand displays a list of current back up andrestore processes for all NAS nodes. This command only displaysthose processes for which the administrative user has authority. Fromthe list, the administrative user can select one process to cancel.Client owner privilege over a particular NAS node is sufficientauthority to cancel the selected NAS process.

When using an interactive command line session with anon-administrative ID, Tivoli Storage Manager prompts for anadministrator ID.

The cancel processcommand is valid for Windows NT andWindows 2000 clientsonly.

SyntaxÊÊ Cancel Process ÊÍ


ExamplesTask Cancel current NAS restore process number 2.

Command: cancel process


Cancel RestoreThe cancel restorecommand displays a list of your restartablerestore sessions in the server database. You can select zero or morerestartable restore sessions that you want to cancel. To restartrestartable restore sessions, use therestart restore command.

Use thecancel restorecommand when:¶ You cannot back up files affected by the restartable restore.¶ You want to cancel restartable restore sessions.¶ Restartable restore sessions lock the file space so that files

cannot be moved off sequential volumes.

SyntaxÊÊ CANcel Restore

optionsÊÍ

Parametersoptions

See “Setting Common Options” on page 127 for informationabout common options that you can use with thecancel restorecommand.

ExamplesTask Cancel a restore operation.

Command: cancel restore


10.U

singC

omm

ands

Delete AccessThe delete accesscommand deletes authorization rules for files thatare stored on the server. When you delete an authorization rule, yourevoke user access to any files specified by that rule.

SyntaxÊÊ Delete ACcess

optionsÊÍ

Parametersoptions


ExamplesTask Display a list of current authorization rules and select the

rules you want to delete.

Command: delete access

See the following screen example:

Index Type Node Owner Path_____ ______ ____________________________________1 Backup node1 daisy c:\dev\proja\list.c2 Archive node3 marm c:\fin\budg\depta.jan3 Backup node4 susie c:\plan\exp\deptc.feb4 Archive node5 susies c:\mfg\invn\parta.wipEnter Index of rule(s) to delete, or quit to cancel:

To delete the authorization rules that allowmarmandsusiesto access your files, type2 4 or (2,4), then press Enter.


Delete ArchiveThe delete archivecommand deletes archived files from serverstorage. Your administrator must give you authority to deletearchived files.

Attention: When you delete archived files,you cannot retrievethem.Verify that the files are obsoletebeforeyou delete them.

SyntaxÊÊ Delete ARchive

optionsÊ

Ê filespec{filespacename}filespec

ÊÍ

Parametersoptions

You can use these command line options with thedelete archivecommand:description, filelist, noprompt, pick. For moreinformation about command line options, see “Using Optionswith Commands” on page 269.

You can use thesubdir common option with thedelete archivecommand. For information about common options, see “SettingCommon Options” on page 127.

filespecSpecifies the path and file name that you want to delete fromstorage. Use wildcard characters to specify a group of files or allfiles in a directory.

Note: If you indicatefilespacename, do not include a drive letterin the file specification.

{filespacename}Specifies the file space (enclosed in braces) on the server thatcontains the file you want to delete. This is the name on the


10.U

singC

omm

ands

workstation drive from which the file was archived. You canspecify UNC names; drive label names are only used forremovable media.

Use thefilespacenameif the name has changed, or if you aredeleting files archived from another node with drive labels thatare different from yours. You must specify a mixed or lowercaseNTFS file space name enclosed in quotes and braces. Forexample,{"NTFSDrive"}.

Single quotes or double quotes are valid in loop mode. Forexample,{"NTFSDrive"} and{'NTFSDrive'} are both valid. Inbatch mode, only single quotes are valid. The single quotesrequirement is a restriction of the operating system.

ExamplesTask Delete files from file spaceabc in the proj directory.

Command: del arc {abc}\proj\*.*

Task Delete a file namedbudget.jan.

Command: del arch c:\plan\proj1\budget.jan

Task Delete all files archived from thec:\plan\proj1 directorywith a file extension of.txt.

Command: del arch c:\plan\proj1\*.txt

Task Delete files archived from thec:\project directory usingthe pick option.

Command: d ar c:\project\*.* -pick


Delete FilespaceThe delete filespacecommand deletes file spaces from serverstorage. Afile spaceis a logical space on the server that containsfiles you backed up or archived. Tivoli Storage Manager assigns aseparate file space on the server for each workstation drive fromwhich you back up or archive files. The file space name is the sameas the UNC name. Note that drive label names are only used forremovable media. When you enter thedelete filespacecommand, alist of your file spaces displays. From this list, select those filespaces that you want to delete.

Your administrator must give you authority to delete a file space.You need BACKDEL authority if the file space you want to deletecontains backup versions, or ARCHDEL authority if the file spacecontains archive copies. If the file space containsboth backupversions and archive copies, you need both types of authority.

Deleting NAS File SpacesYou can use thedelete filespacecommand to interactively deleteNAS file spaces from server storage.

Use thenasnodenameoption to identify the NAS file server. Whenusing an interactive command line session with a non-administrativeID, Tivoli Storage Manager prompts for an administrator ID. Placethe nasnodenameoption in your client options filedsm.opt. Thevalue in the client options file is the default, but this value can beoverridden on the command line. If thenasnodenameoption is notspecified in the client options file, you must specify this option onthe command line when processing NAS file systems. See“Nasnodename” on page 209 for more information.

Use theclassoption to specify the class of the file space to delete.To display a list of file spaces belonging to a NAS node so that youmay choose one to delete, use the-class=nasoption. Using thedefault,-class=client, will not change the currentdelete filespacebehavior. See “Class” on page 276 for more information.

To delete NAS file spaces using the Web client, see “Backing Upand Restoring” on page 35.


10.U

singC

omm

ands

Attention: When you delete a file space, you deleteall backupversions and archive copies within that file space. When you delete afile space,you cannot restore the files. Verify that the files areobsoletebeforeyou delete them.

SyntaxÊÊ Delete Filespace

optionsÊÍ

Parametersoptions

You can use these common options with thedelete filespacecommand:scrollprompt, scrolllines, nasnodename. For moreinformation, see “Setting Common Options” on page 127.

You can use theclasscommand line option with thedeletefilespacecommand. For more information, see “Class” onpage 276.

ExamplesTask Delete a file space.

Command: delete filespace

Task Delete a file space. Use thedateformatand timeformatoptions to reformat the dates and times. These formats are ineffect for the entire session unless you enter them again on alater command.

Command: del f –date=5 –time=4

Task Delete NAS file spaces from thedagordon NAS file serverstored on the server.

Command: delete filespace -nasnodename=dagordon-class=nas


ExpireThe expire command inactivates the backup objects you specify inthe file specification or with thefilelist option.

When working in interactive mode, a prompt notifies you beforefiles are expired.

The expire command does not remove workstation files. If youexpire a file or directory that still exists on your workstation, the fileor directory is backed up again during the next incremental backupunless the object is excluded by include-exclude processing.

If you expire a directory that contains active files, those files willnot appear in a subsequent query from the GUI. However, these fileswill display on the command line if you specify the proper querywith a wildcard character for the directory.

Note: Because theexpire command changes the server’s picture ofthe client file system without actually changing the client filesystem, theexpire command is not allowed on files locatedon a file system monitored by the Tivoli Storage Managerjournal service.

SyntaxÊÊ EXPire

optionsfilespec ÊÍ

Parametersoptions

You can use these command line options with theexpirecommand:pick and filelist. For more information aboutcommand line options, see “Using Options with Commands” onpage 269.

Note: If the user specifiesfilelist, thenpick is ignored.


10.U

singC

omm

ands

filespecSpecifies a path and a filename that you want to expire. You canenter only one file specification on this command. However, youcan use wildcards to select a group of files or all the files in adirectory. If you specify thefilelist option, thefilespecdesignation is ignored.

ExamplesTask Inactivate theletter1.txt file in the home directory.

Command:expire c:\home\letter1.txt

Task Inactivate all files in theadmin\mydirdirectory.

Command:expire c:\admin\mydir\*


HelpThe help command displays a Table of Contents of help topics forthe command line client. Enter the number of the topic that youwant to view. If there is more than one screen of topics, scrollbackward or forward through the list. To exit, typeq and pressEnter.

SyntaxÊÊ Help

optionsÊÍ

Parametersoptions


ExamplesTask Display a list of help choices.

Command: help


10.U

singC

omm

ands

IncrementalThe incremental command backs up all new or changed files ordirectories in the default client domain or from file systems,directories, or files you specify. The specified items must not beexcluded from backup services.

To incrementally back up selected files or directories, specify the filespecification in the command. The default is to back up files ordirectories in the default domain.

The following attributes in the management class assigned to the fileor directory affect whether the data is actually backed up:

FrequencyThe number of days that must elapse between successivebackups for the file. Use this attribute during a fullincremental backup. For Windows NT, 2000: Do not use thisattribute during a journal-based backup.

Mode Permits you to back up only files that changed since the lastbackup (modified). Also permits you to back up the fileswhether they changed or not (absolute).

SerializationPermits or denies backup of files or directories according tothe following values:¶ static: In order to be backed up, data must not be

modified during backup or archive.¶ shared static: If data in the file or directory changes

during each of the allowed attempts to back up orarchive it, it is not backed up or archived. The value ofthe changingretriesoption determines how manyattempts are made. The default is 4.

¶ dynamic: The object is backed up or archived on thefirst attempt whether or not data changes during theprocess.

¶ shared dynamic: The object is backed up or archived onthe last attempt, even if data changes during the process.


For more information on management classes, see “UnderstandingStorage Management Policies” on page 97.

Using theinclude option in an include-exclude list, you can assignthe default management class to a file. You can also assign a specificmanagement class to a file.

You can perform either afull incrementalbackup or anincrementalby datebackup. The default is a full incremental backup.

For Windows NT, 2000: If you are journaling a file system and thejournal is valid, the full incremental backup reverts to ajournal-based backup. See “Journal-Based Backup (Windows NT,2000 only)” for more information. You can perform a fullincremental backup without the journal by using thenojournaloption. See “Nojournal” on page 297 for more information.

You can also use theselectivecommand to perform aselectivebackup that backs up only the files, directories or empty directoriesthat you specify. For more information, see “Selective” on page 438.

A full incremental backs up all files or directories that are new orhave changed since the last incremental backup. During a fullincremental backup, the client queries the server or the journaldatabase (Windows NT, 2000) to determine the exact condition ofyour storage. Tivoli Storage Manager uses this information to:¶ Back up new files or directories.¶ Back up files or directories whose contents have changed.¶ Mark inactive backup versions on the server for files or

directories that are deleted from the workstation.¶ Rebind backup versions to management classes if the

management class assignments change.

Journal-Based Backup (Windows NT, 2000 only)If the journal engine serviceis installed and running, then by defaultthe incremental command performs a journal-based incrementalbackup on any journaled file systems. Tivoli Storage Manager doesnot use the journaling facility inherent in Windows NTFS 5 filesystems or any other journaled file system.


10.U

singC

omm

ands

The journal engine servicerecords changes to an object or itsattributes in a journal database. During a journal-based backup, theclient obtains a list of files that are eligible for backup from thejournal database. Performing backups on a regular basis maintainsthe size of the journal.

Journal-based backup can increase backup performance. Withjournal-based backup, the client does not scan the local file systemor obtain information from the server to determine which files toprocess. Journal-based backup also reduces network traffic betweenthe client and server.

Tivoli Storage Manager filters the list based on the currentinclude-exclude list. Tivoli Storage Manager processes, expires, andupdates the resulting files according to policy constraints, such asserialization. The management-class copy frequency attribute isignored during journal-based backup.

The journal engine service excludes specific system files (pagefile,registry, etc.) from having changes recorded in the journal. Becausechanges to these files are not journaled, Tivoli Storage Manager doesnot back up these files. See the journal service configuration filetsmjbbd.ini located in the Tivoli Storage Manager installationdirectory for specific system files that are excluded.

To support journal-based backup, you must install the journalingengine service. Install this service by using thedsmcutil commandor the GUI setup wizard. SeeTivoli Storage Manager Installing theClients, SH26-4119 for more information about using thedsmcutilcommand to install the journaling engine service.

If the file specification on theincremental command is a file space,Tivoli Storage Manager processes any journal entries for that filespace. Tivoli Storage Manager processes directories and wildcardedfile specifications in the same way. Tivoli Storage Manager uses thedomain list if you do not specify a file specification.

Note: Journal-based backup may not fall back to the traditionalincremental backup if the policy domain of your node is changed on


the server, depending on when the policy set within the domain waslast updated and the date of the last incremental. In this case, youmust force a full traditional incremental backup to rebind the files tothe new domain. Use thenojournal option with theincrementalcommand to specify that you want to perform a traditional fullincremental backup, instead of the default journal-based backup.

When a user deletes a file with a long name, the Windows operatingsystem may supply a short, or compressed, name to the journalengine service. After the object is deleted, the compressed name maybe reused and the deletion notice may no longer identify a uniqueobject. During a journaled incremental backup, the attempt to expirethe file will fail because the compressed name is not known to theserver. When this occurs, a record is placed in the journal indicatingthat the current directory is not exactly represented at the server. Usethe incrthreshold option to specify what action is taken when thisoccurs. See “Incrthreshold” on page 195 for more information.

ConsiderationsUnder the following conditions, the journal database is consideredinvalid and the client reverts to the traditional full incrementalbackup:¶ Files on the server for a journaled file space have been deleted.¶ A journaled file space name has changed.¶ The client node name has changed.¶ Policy changes have occured (new policy set activation).¶ The journal is corrupt (out of space conditions, disk error).¶ The journal service is not running.¶ The journal service is stopped or started for any reason,

including system reboot.

Journal-based backup differs from the traditional full incrementalbackup in the following ways:¶ Tivoli Storage Manager does not enforce non-default copy

frequencies (other than 0).¶ Attribute changes to an object require a back up of the entire

object.


10.U

singC

omm

ands

You can use thenojournal option with theincrementalcommand toperform a traditional full incremental backup instead of the defaultjournal-based backup. See “Nojournal” on page 297 for moreinformation.

Virtual Volume and Virtual Mount Point (Windows 2000NTFS)

If you perform an incremental backup of a file space on which avolume is mounted, Tivoli Storage Manager does not traverse themount junction and back up all mounted data. For example, if youhave a mounted volume namedc:\mount on file spacec:, TivoliStorage Manager backs up only the junction point, not the dataunderc:\mount.

To back up all data for a file system, including virtual volumes andvirtual mount points, run an incremental backup on each virtualvolume. You must also perform an incremental backup on the filesystem.

The exclude.diroption isnot valid for a mounted virtual volume ifthe volume is backed up as a file space.Exclude.dir is valid for amount point that is backed up.

Backing Up Microsoft DFS RootIf you perform an incremental backup of Microsoft DFS root withdfsbackupmntpnt=yesspecified, Tivoli Storage Manager backs uponly the junction points,not the subtree under the junctions.

If you want to traverse the DFS tree and back up the files andsubdirectories of any junction it encounters, specify thedfsbackupmntpnt=no option.

This option has no effect if you are backing up individual junctions.The exclude.diroption behavior for DFS junctions is same as formounted virtual volumes. For more information, see“Dfsbackupmntpnt” on page 163.


Incremental-by-DateAn incremental-by-date backup backs up new and changed files witha modification date later than the date of the last incremental backupstored at the server, unless the files are excluded from backup by anexcludestatement.

If an incremental-by-date is performed on only part of a file system,the date of the last full incremental is not updated, and the nextincremental-by-date will back up these files again. Use thequeryfilespacecommand to determine the date and time of the lastincremental backup of the entire file system.

To perform an incremental-by-date backup, use theincrbydateoptionwith the incremental command.

Unlike a full incremental, an incremental-by-date does not maintaincurrent server storage ofall your workstation files because:¶ It does not expire backup versions of files that are deleted from


the management class has changed.¶ It does not back up files with attributes that have changed,

unless the modification dates and times have also changed.¶ It ignores the copy group frequency attribute of management

classes.

For these reasons, if you have limited time during the week toperform backups, but extra time on the weekends, you can use apartial incremental backup on weekdays and a full incrementalbackup on weekends to maintain current server storage of yourworkstation files.

If the incremental command is retried because of a communicationfailure or session loss, the transfer statistics will display the numberof bytes Tivoli Storage Manager attempted to transfer duringallcommand attempts. Therefore, the statistics for bytes transferred maynot match the file statistics, such as those for file size.


10.U

singC

omm

ands

Adaptive Subfile BackupsIf you plan to perform a backup over a network device with limitedbandwidth, such as a modem, you can reduce the network traffic byusing thesubfilebackupoption. If you plan to use this option, ensurethat you specify thesubfilebackup, subfilecachepathandsubfilecachesizeoptions during the initial backup of your file. Theoptions specify whether to perform an adaptive subfile backup alongwith the path and size of the data to be transferred. For informationon these options, see “Setting Common Options” on page 127. Forinformation about adaptive subfile backups, see “Performing aBackup with Limited Bandwidth” on page 44.


Windows 2000 ConsiderationsTivoli Storage Manager backs up named streams on a file basis only.Backup of a named stream containing sparse file data is notsupported. Tivoli Storage Manager will back up a sparse file as aregular file if the client compression is off. Enable file compression(compression=yes) when backing up sparse files to minimizenetwork transaction time and to maximize server storage space.

Microsoft disk quotas do not affect the amount of data you can backup.

SyntaxÊÊ Incremental

options

» filespec

ÊÍ

Parametersoptions

You can use these command line options with theincremental


command:dirsonly, filesonly, incrbydate, nojournal, filelist. Formore information, see “Using Options with Commands” on page269.

You can use the following common options with theincremental command:autofsrename, changingretries, domain,incrthreshold, memoryefficientbackup, subdir, subfilebackup,tapeprompt. For information about these options, see “SettingCommon Options” on page 127.

filespecSpecifies the path and file name that you want to back up. Usewildcards to select a group of files or all the files in a directory.You can also enter up to 20 file specifications in a command byseparating the file specifications with a space. If a filespecification is not specified, the default domain or the domainspecified as an option is backed up. See “Maximum File Size forOperations” on page 320 for the maximum file size for back upprocessing.

If a file system is specified, all new and changed files arebacked up. In addition, the last incremental date for the filespace is updated on the server. If a file or directory is specified,the last incremental date is not updated. This means the file ordirectory might be backed up again if a later backup isperformed using theincrbydateoption.

If a file system is specified, specify the file system without atrailing slash.

ExamplesTask Run an incremental backup of the default client domain

specified in your client options filedsm.opt.

Command: Incremental

Task Run an incremental backup of thec:, d:, ande: drives.

Command: i c: d: e:

Task Run an incremental backup of the\home\ngai directory andits contents on the current drive.


10.U

singC

omm

ands

Command: i \home\ngai\


LoopThe loop command starts an interactive command line session that ismaintained until you enterquit . In an interactive command linesession, it is unnecessary to precede each command name withdsmcand your password, if one is required. After you start an interactivesession, most of the options you enter with other commands are ineffect throughout the session, unless you enter them again using adifferent setting.

You can enter all valid commands in interactive modeexceptthescheduleand loop commands.

Some options cannot be used within the interactive session createdby the loop command and are identified in the option description bythis statement:This option is valid only on the initial command line.It is not valid in interactive mode.

See “Setting Common Options” on page 127 for options that cannotbe used in interactive mode.

SyntaxÊÊ LOOP

optionsÊÍ

Parametersoptions

For information about command line and common options thatyou can use with this command, see “Using Options withCommands” on page 269 and “Setting Common Options” onpage 127.

ExamplesTask Start an interactive command line session.

Command: dsmc


10.U

singC

omm

ands

MacroThe macro command executes a series of commands that youspecify in a macro file. By including themacro command within amacro file, you can nest as many as ten levels of commands.

Comment lines are not supported within the macro file specified forthe macro command.

SyntaxÊÊ MAcro macroname ÊÍ

Parametersmacroname

Specifies the fully qualified name of the file containing thecommands.

ExamplesThe following is an example of how to use themacro command.

Task Selectively back up files in the following directories:c:\devel\project\projac:\devel\project\projbc:\devel\project\projc

Command: macro backabc.mac

wherebackabc.mac contains the following statements:selective c:\devel\project\proja\*.*selective c:\devel\project\projb\*.*selective c:\devel\project\projc\*.*


Monitor ProcessThe monitor processcommand displays a list of current backup andrestore processes for all NAS nodes for which the administrativeuser has authority. The administrative user can then select oneprocess to monitor. Client owner privilege over a particular NASnode is sufficient authority to monitor the selected NAS process.


The monitor processcommand is valid for Windows NT andWindows 2000 clientsonly.

SyntaxÊÊ MONitor Process ÊÍ

ParametersThere are no parameters for this command.

ExamplesTask Monitor a current NAS backup process.

Command: monitor process


10.U

singC

omm

ands

Query AccessThe query accesscommand displays a list of users to whom youhave given access to backup versions or archive copies of specificfiles. Tivoli Storage Manager displays a list of authorization rulesthat you defined with theset accesscommand or withUser AccessList on the graphical user interface (GUI) Utilities menu. Theinformation includes:¶ Authority you gave a user to restore backup versions or retrieve

archive copies.¶ The node name of the user to whom you gave authorization.¶ The files to which the user has access.

SyntaxÊÊ Query ACcess

optionsÊÍ

Parametersoptions

You can use the following common options with thequeryaccesscommand:scrolllines, scrollprompt. For moreinformation about common options you can use with thiscommand, see “Setting Common Options” on page 127.

ExamplesTask Display a list of users who have access to your files.

Command: query access


Query ActivedirectoryThe query activedirectory command queries a Windows 2000Server running Active Directory Services. The command displaysinformation about the active backup of the Active Directory systemobject on the server.

SyntaxÊÊ Query ACTIVEDirectory

optionsÊÍ

Parametersoptions

You can use these command line options with thequeryactivedirectory command:inactive, pitdate, pittime. For moreinformation, see “Using Options with Commands” on page 269.

ExamplesTask Display information about the active backup of the Active

Directory system object on the server.

Command: query actived


10.U

singC

omm

ands

Query ArchiveThe query archive command displays a list of your archived files,the file size, archive date, file specification, expiration date, and filedescription.

SyntaxÊÊ Query ARchive

optionsÊ


ÊÍ

Parametersoptions

You can use these command line options with thequery archivecommand:description, dirsonly, filelist, filesonly, fromdate,fromnode, fromtime, todate, totime. For more information, see“Using Options with Commands” on page 269.

You can use the following common options with thequeryarchive command:scrolllines, scrollprompt, subdir. See “SettingCommon Options” on page 127 for more information..

filespecSpecifies the path and file name that you want to query. Usewildcard characters to specify a group of files or all the files in adirectory.

Note: If you include filespacename, do not include a drive letterin the file specification. Note that drive label names areonly used for removable media.

{filespacename}Specifies the file space (enclosed in braces) on the server thatcontains the file you want to query. This is the name on the


workstation drive from which the file was archived. Thefollowing example is valid for specifying a UNC name:{'\\machine\C$'}.

Use thefilespacenameif the name has changed or if you arequerying files archived from another node with drive labels thatare different from yours.

Note: You must specify a mixed or lowercase NTFSfilespacenameenclosed in quotes and braces. Forexample,{"NTFSDrive"}. Single quotes or double quotesare valid in loop mode. For example:{"NTFSDrive"} and{'NTFSDrive'} are both valid. In batch mode, only singlequotes are valid. The single quotes requirement is arestriction of the operating system.

ExamplesTask Display a list of all your archived files in thec:\proj

directory.

Command: q ar c:\proj\*

Task Display a list of archived files from yourc: drive with thedescription″January Ledgers.″

Command: query archive c:\ -su=y -descr="JanuaryLedgers"

Task Display a list of all your archived files in thec:\projdirectory. Use thedateformatand timeformat options toreformat the dates and times.

Command: q ar –date=5 –time=4 c:\proj\*

Task Display a list of archived files in thec:\proj directorycontaining a file extension of.dev. Use thedateformatandtimeformat options.

Command: q ar –date=5 –time=4 c:\proj\*.dev

Task Last week you changed the label of yourc: drive to storeand archived some files. Yesterday you changed the label to


10.U

singC

omm

ands

dev and archived more files. Display a list of all the filesyou archived in thec:\proj directory when the label wasstore.

Command: q ar {store}\proj\*

Task Last week you archived files from a diskette labeleddocs.Display a list of all the files you archived.

Command: q ar {docs}\*


Query BackupThe query backup command displays a list of backup versions ofyour files. File information includes the file specification, size,backup date, whether the file is active or inactive, and themanagement class asigned to the file. Only the first ten characters ofthe management class name appears.

Querying NAS File System ImagesYou can use thequery backup command to display informationabout file system images backed up for a NAS file server.

Use thenasnodenameoption to identify the NAS file server toquery. When using an interactive command line session with anon-administrative ID, Tivoli Storage Manager prompts for anadministrator ID. Place thenasnodenameoption in your clientoptions filedsm.opt. The value in the client options file is thedefault, but this value can be overridden on the command line. See“Nasnodename” on page 209 for more information.

Use theclassoption to specify the class of the file space to query.To display a list of images belonging to a NAS node, use the-class=nasoption. Using the default,-class=client, will not changethe currentquery backup behavior. See “Class” on page 276 formore information.

SyntaxÊÊ Query Backup

optionsÊ


ÊÍ

Parametersoptions

You can use these command line options with thequery backupcommand:class, dirsonly, filelist, filesonly, fromdate, fromnode,


10.U

singC

omm

ands

fromtime, pitdate, pittime, todate, totime. For more information,see “Using Options with Commands” on page 269.

With the query backup command, you can use the followingcommon options:subdir, scrolllines, nasnodename,scrollprompt. See “Setting Common Options” on page 127 forinformation about these common options.

filespecSpecifies the path and file name that you want to query. Usewildcard characters to specify a group of files or all the files in adirectory. Do not use wild cards when you query NAS filesystem images with -class=nasoption.

Note: If you include filespacename, do not include a drive letterin the file specification. Drive label names are only usedfor removable media.

{filespacename}Specifies the file space (enclosed in braces) on the server thatcontains the file you want to query. This is the drive label orUNC name on the workstation drive from which the file wasbacked up. The following example is valid for specifying a UNCname:{'\\machine\C$'}.

Use thefilespacenameif the name has changed, or if you wantto query files backed up from another node with drive labelnames that are different from yours.

Note: You must specify a mixed or lowercase NTFS file spacename enclosed in quotes and braces. For example,{"NTFSDrive"}. Single quotes or double quotes are validin loop mode. For example:{"NTFSDrive"} and{'NTFSDrive'} are both valid. In batch mode, only singlequotes are valid. The single quotes requirement is arestriction of the operating system.

ExamplesTask Query files from theabc file spaceproj directory.

Command: q b {"abc"}\proj\*.*


Task Display a list of all active and inactive backup versions thatwere backed up from thec:\proj directory.

Command: q backup –ina c:\proj\*

Task Display a list of all active and inactive backup versions thatwere backed up from thec:\proj directory. Use thedateformatand timeformat options to reformat the dates andtimes.

Command: q b –date=5 –time=4 –ina c:\proj\*

Task Last week you backed up files from a diskette labeleddocs.Display a list of those files.

Command: q b {docs}\*

Task Query file system images from thenas2NAS file server.

Command: query backup -nasnodename=nas2-class=nas


10.U

singC

omm

ands

Query BackupsetThe query backupsetcommand queries a backup set from a localfile, tape device, or server. See “Location” on page 293 forinformation on how to specify supported tape devices. Thiscommand displays the backup set name, generation date, retention,and description.

SyntaxÊÊ Query BACKUPSET

options backupsetnamefilename

ÊÍ

Parametersoptions

You can use these command line options with thequerybackupsetcommand:descriptionand location. See “UsingOptions with Commands” on page 269 for information aboutthese command line options.

You can use these common options with thequery backupsetcommand:scrolllines andscrollprompt. See “Setting CommonOptions” on page 127 for information about these commonoptions.

backupsetnameThis parameter is used when -location=serveris in effect andspecifies the name of the backup set on the server you want toquery. Wildcards can be used to specify the backup set name. Ifbackup set name is not specified, all backup sets display.

filenameThis parameter is required when -location=file is in effect andspecifies the file name on your local workstation that containsthe backup set you want to query.

ExamplesTask Query a backup set on the server calledmybackupsetname.


Command: query backupset mybackupsetname-loc=server

Task Query the backup set contained in thebackupsetfile.namefile in the budget directory.

Command: query backupsetc:\budget\backupsetfile.name loc=file


10.U

singC

omm

ands

Query CertserverdbThe query certserverdb command displays information about theactive backup of the Windows 2000 certificate server databasesystem object on the Tivoli Storage Manager server.


SyntaxÊÊ Query CERTServerdb

optionsÊÍ

Parametersoptions

You can use these command line options with thequerycertserverdb command:inactive, nasnodename, mode, monitor,password, pitdate, pittime. For more information about commandline options, see “Using Options with Commands” on page 269.

ExamplesTask Display information about the active backup of the certificate

server database system object on the Tivoli Storage Managerserver.

Command: query certs


Query ClusterdbThe query clusterdb command displays information about the activebackup of the Microsoft Cluster Services cluster database systemobject on the server.


SyntaxÊÊ Query CLUSTERDB

optionsÊÍ

Parametersoptions

You can use these command line options with thequeryclusterdb command:inactive, pitdate, pittime. For moreinformation, see “Using Options with Commands” on page 269.

ExamplesTask Display information about the active backup of the Microsoft

Cluster Services cluster database system object on the server.

Command: query clusterdb


10.U

singC

omm

ands

Query ComplusdbThe query complusdb command displays information about theactive backup of the COM+ database system object on the server.

This command is valid for Windows 2000 Server and Windows 2000Professional operating systems.

SyntaxÊÊ Query COMPlusdb

optionsÊÍ

Parametersoptions

You can use these command line options with thequerycomplusdb command:inactive, pitdate, pittime. For moreinformation, see “Using Options with Commands” on page 269.

ExamplesTask Display information about the active backup of the COM+

database system object on the server.

Command: query complusdb


Query EventlogThe query eventlogcommand displays information about the activebackup of the event log system object on the server.

This command is valid on the Windows 2000 Server operatingsystems.

SyntaxÊÊ Query Eventlog

optionsÊÍ

Parametersoptions

You can use these command line options with thequeryeventlogcommand:inactive, pitdate, pittime. For moreinformation, see “Using Options with Commands” on page 269.

ExamplesTask Display information about the active backup of the Windows

2000 event log system object on the server.

Command: query eventlog


10.U

singC

omm

ands

Query FilespaceThe query filespacecommand displays a list of file spaces for anode stored on the server. Afile spaceis a logical space on theserver that contains files you backed up or archived. Tivoli StorageManager assigns a separate file space on the server for each drive atyour workstation from which you back up or archive files. The filespace name is the same as the drive label name.

For Windows NT and Windows 2000 clients: A Unicode file spacename may not display correctly if the server is unable to display theUnicode name. In this case, use the file space identifier (fsID) toidentify these file spaces on the server. Use thequery filespacecommand with thedetail option to determine the fsID of a filespace. The fsID is also displayed in the file information dialog in theWindows and Web client GUIs.

Querying NAS File SpacesUse thenasnodenameoption to identify the NAS file server toquery. When using an interactive command line session with anon-administrative ID, Tivoli Storage Manager prompts for anadministrator ID. Place thenasnodenameoption in your clientoptions filedsm.opt. The value in the client options file is thedefault, but this value can be overridden on the command line. If thenasnodenameoption is not specified in the client options file, itmust be specified on the command line when processing NAS filesystems. See “Nasnodename” on page 209 for more information.

Use theclassoption to specify the class of the object to query. Todisplay a list of file spaces belonging to a NAS node, use the-class=nasoption. Using the default,-class=client, will not changethe currentquery filespacebehavior. See “Class” on page 276 formore information.

SyntaxÊÊ Query Filespace

optionsÊÍ


Parametersoptions

You can use thefromnodeandclasscommand line options withthe query filespacecommand. For more information, see“Fromnode” on page 286 and “Class” on page 276.

You can use thenasnodename, scrolllines andscrollpromptcommon options with thequery filespacecommand. See“Setting Common Options” on page 127 for more information..

ExamplesTask Display your file spaces.

Command: query filespace

Task Display your file spaces. Use thedateformatand timeformatoptions to reformat the dates and times.

Command: query filespace –date=5 –time=4

Task Query a file space from thenas2NAS file server.

Command: query filespace -nasnodename=nas2-class=nas


10.U

singC

omm

ands

Query FRSThe query frs command displays information about the activebackup of the File Replication Services (FRS) system object on theserver.


SyntaxÊÊ Query FRS

optionsÊÍ

Parametersoptions

You can use these command line options with thequery frscommand:inactive, pitdate, pittime. For more information, see“Using Options with Commands” on page 269.

ExamplesTask Display information about the active backup of the File

Replication Services (FRS) system object on the server.

Command: query frs


Query InclexclThe query inclexcl command displays a list of include-excludestatements in the order in which they will process during backup andarchive operations. The list displays the type of option, the scope ofthe option (archive, all, etc.), and the name of the source file.

You can test the validity of patterns you wish to use in yourinclude-exclude list before you actually insert them in your optionsfile. See thetest patternexplanation below.

SyntaxÊÊ Query INCLexcl

test patternÊÍ

Parameterstest pattern

Use for testing the validity of patterns you wish to use in yourinclude-exclude list. When you use a test pattern with thiscommand, the following occurs:

¶ The internal include-exclude list doesnot display

¶ The pattern is processed as if it had come from aninclude-exclude statement, including all the usual errorchecking

¶ The pattern is displayed as it would appear in theinclude-exclude list

If the test pattern has no errors, the compiled pattern result is thesame as the test pattern.

ExamplesTask Display a list of include-exclude statements.

Command: query inclexcl

Task Test the validity of this pattern: ..\?x?\*.log

Command: query inclexcl..\?x?\*.log


10.U

singC

omm

ands

Query MgmtclassThe query mgmtclasscommand displays information about themanagement classes available in your active policy set.

Your administrator defines management classes that containattributes controlling whether a file is eligible for backup or archiveservices. Management classes also determine how backups andarchives are managed on the server.

Your active policy set contains a default management class; it cancontain any number of additional management classes. You canassign specific management classes to files usinginclude optionsthat are located in the client options filedsm.opt. If you do notassign a management class to a file, Tivoli Storage Manager uses thedefault management class.

SyntaxÊÊ Query Mgmtclass

optionsÊÍ

Parametersoptions

You can use thedetail and fromnodecommand line options withthe query mgmtclasscommand. For more information, see“Using Options with Commands” on page 269.

You can also use thescrolllines andscrollpromptcommonoptions with thequery mgmtclasscommand. For moreinformation about these common options, see “Setting CommonOptions” on page 127.

ExamplesTask Display available management classes.

Command: query mgmtclass


Query NodeThe query node command displays all the nodes for which anadministrative user ID has authority to perform operations. Theauthorized administrative user ID should have at least client ownerauthority over both the NAS node and the client workstation nodethey are using either from command line or from the web.


Use thetypeoption to specify the type of node to filter for. Validvalues arenas, client, serverandany. The default isany. See “Type”on page 307 for more information.

SyntaxÊÊ Query Node

optionsÊÍ

Parametersoptions

You can use thetypecommand line option with the query nodecommand. See “Type” on page 307 for more information.

Use thescrolllines andscrollpromptcommon options with thequery node command. For more information, see “SettingCommon Options” on page 127.

ExamplesTask Display all NAS nodes.

Command: query node -type=nas


10.U

singC

omm

ands

Query RegistryThe query registry command displays information about the activebackup of a Windows 2000 registry system object on the server. Theregistry is a centralized database that contains information abouthardware, applications, and operating system settings.

SyntaxÊÊ Query REgistry

optionsÊÍ

Parametersoptions

You can use these command line options with thequeryregistry command:inactive, pitdate, pittime. For moreinformation, see “Using Options with Commands” on page 269.


2000 registry system object on the server.

Command: query re


Query RestoreThe query restore command displays a list of your restartablerestore sessions in the server database. The list contains thefollowing fields: owner, replace, subdir, preservepath, source, anddestination.

Certain restore operations, called restartable restore sessions, start aspecial protocol within Tivoli Storage Manager. Some restoresessions can be restarted for these reasons:

¶ Restartable restore sessions that fail because of network outage,client failure, server outage, or similar problem can be restartedfrom the point where they failed. Use therestart restorecommand to restart a restore session.

¶ Restartable restore sessionslock the file space so that filescannot be moved off sequential volumes.query restore displaysthe restartable restore sessions and their associated file space.Use thecancel restorecommand to cancel a restartable restoresession.

SyntaxÊÊ Query Restore

optionsÊÍ

Parametersoptions

For information about common options you can use with thequery restore command, see “Setting Common Options” onpage 127.

ExamplesTask The following example displays the output when you use

query restore:


10.U

singC

omm

ands

Sess Restore Elapsed Node Name file spaceNumber State Minutes Name------ ----------- ------- --------- ---------

2 active 5 byufan EDISK-1 restartable 107 crockett OS2


Query RSMThe query rsm command displays information about the activebackup of the Removable Storage Manager (RSM) database systemobject on the server. Thequery rsm command indicates whetherthere is previously backed up RSM data to be restored.

This command is valid for the Windows 2000 Server operatingsystems.

SyntaxÊÊ Query RSM

optionsÊÍ

Parametersoptions

You can use these command line options with thequery rsmcommand:inactive, pitdate, pittime. For more information, see“Using Options with Commands” on page 269.

ExamplesTask Display information about the active backup of the

Removable Storage Manager (RSM) database system objecton the server.

Command: query rsm


10.U

singC

omm

ands

Query ScheduleThe query schedulecommand displays the events scheduled foryour node. Your administrator can set up schedules to performautomatic backups and archives for you. To plan your work, use thiscommand to determine when the next scheduled events occur.

SyntaxÊÊ Query SCHedule

optionsÊÍ

Parametersoptions

You can use these common options with thequery schedulecommand:dateformat, errorlogname, nodename, andpassword.For more information about these common options, see “SettingCommon Options” on page 127.

ExamplesTask Display your scheduled events.

Command: query schedule


Query SessionThe query sessioncommand displays information about yoursession, including the current node name, when the session wasestablished, server information, and server connection information.

SyntaxÊÊ Query SEssion

optionsÊÍ

Parametersoptions

For information about common options you can use with thequery sessioncommand, see “Setting Common Options” onpage 127.

ExamplesTask Display your session information.

Command: query session


10.U

singC

omm

ands

Query SysfilesThe query sysfilescommand displays information about the activebackup of the Windows 2000 system object and boot files on theserver. System and boot files consist of the following:¶ All files that are protected by system file protection¶ All files that are in the system file protection service catalog

directory¶ Performance counter configuration files

SyntaxÊÊ Query SYSFiles

optionsÊÍ

Parametersoptions

You can use these command line options with thequery sysfilescommand:inactive, pitdate, pittime. For more information, see“Using Options with Commands” on page 269.


2000 system and boot files system object on the server.

Command: query sysfiles


Query SystemobjectThe query systemobjectcommand displays information about theactive backup of the following valid Windows 2000 system objectson the server:¶ Active Directory (domain controller only)¶ Certificate Server Database¶ Cluster Database (cluster node only)¶ COM+ database¶ Registry¶ System and boot files¶ System volume¶ Event logs (system, security and application)¶ Removable Storage Management Database (RSM)¶ Replicated file systems

SyntaxÊÊ Query SYSTEMObject

optionsÊÍ

Parametersoptions

You can use these command line options with thequerysystemobjectcommand:inactive, pitdate, pittime. For moreinformation, see “Using Options with Commands” on page 269.

ExamplesTask Display information about the active backup of all the

system objects on the server.

Command: query systemo


10.U

singC

omm

ands

Query SysvolThe query sysvolcommand displays information about the activebackup of the Windows volume system object on the server.

This system object is found only on a Windows 2000 Serverfunctioning as a domain controller.

SyntaxÊÊ Query SYSVol

optionsÊÍ

Parametersoptions

You can use these command line options with thequery sysvolcommand:inactive, pitdate, pittime. For more information, see“Using Options with Commands” on page 269.


2000 system volume system object on the server.

Command: query sysv


Restart RestoreThe restart restore command displays a list of your restartablerestore sessions in the server database. You can select zero or morerestartable restore sessions that you want to restart.

The restarted restore uses the same options you used in the failedrestore. The restarted restore continues from the point at which therestore previously failed.

To cancel restartable restore sessions, use thecancel restorecommand. Use therestart restore command when:

¶ Restartable restore sessions lock the file space so that filescannot be moved off sequential volumes.

¶ You cannot back up files affected by the restartable restore.

Options from the failed session supersede new or changed optionsfor the restarted session.

SyntaxÊÊ RESTArt Restore

optionsÊÍ

Parametersoptions

For information about common options you can use with therestart restore command, see “Setting Common Options” onpage 127.

ExamplesTask Restart a restore.

Command: restart restore


10.U

singC

omm

ands

RestoreThe restore command obtains copies of backup versions of yourfiles from a server. To restore files, specify the directories or selectedfiles, or select the files from a list. Restore files to the directory fromwhich you backed them up or to a different directory. Tivoli StorageManager uses thepreservepathoption with thesubtreevalue as thedefault for restoring files. For more information, see “Preservepath”on page 302.

Note: An error will occur if you attempt to restore a file whosename is the same as an existing file’s short name. Forexample, if you attempt to restore a file you specificallynamedABCDEF˜1.DOC into the same directory where a filenamedabcdefghijk.doc exists, the restore will fail becausethe Windows operating system equates the file namedabcdefghijk.doc to a short name ofABCDEF˜1.DOC. Therestore function treats this as a duplicate file.

If this error should occur, perform any of the followingactions to correct it:¶ Restore the file with the short file name to a different

location.¶ Stop the restore and change the name of the existing file.¶ Disable the short file name support on Windows.¶ Do not use file names that would conflict with the short

file naming convention; for example, do not useABCDEF˜1.DOC.

See the Microsoft Knowledge Base article Q121007,How to Disablethe 8.3 Name Creation on NTFS Partitions, for more information.

If the restore command is retried because of a communicationfailure or session loss, the transfer statistics display the bytes TivoliStorage Manager attempted to transfer acrossall command attempts.Therefore, the statistics for bytes transferred may not match filestatistics, such as those for file size.


Virtual Volume and Virtual Mount Point (Windows 2000NTFS)

When restoring all file system data, including virtual volumes andmount points, restore the virtual mount point before restoring anydata inside the virtual volume. Otherwise, all data in the virtualvolume is restored to the parent directory of the virtual volume.

Attention: When the client is instructed to restore the files on themount volume, it first determines whether a mount point exists forthe specified mount volume. If a mount volume exists in thespecified location, the following error message appears:

ANS5179E Restoring a volume mount point to a non-empty directory

and Tivoli Storage Manager will not overwrite the mount volume toavoid potential data loss. To restore the mount volume, first deletethe mount point associated with it.

You can restore a virtual mount point to a network drive; however,the restored mount point indicates the virtual volume in the networkworkstation, not the local client virtual volume. For best results, onlyrestore a virtual mount point to a network drive when the networkworkstation already has the identical virtual mount point defined. Torestore the mount volume, first delete the mount point associatedwith it.

To restore a mount point using the GUI or Web client, you mustrestore the root of the drive where the mount point is defined. If youselect the mount point itself, Tivoli Storage Manager restores allmounted data, but not the mount junction.

If you use the command line client to restore mounted data, back upthe mount point in addition to backing up the mounted data. If themount point is not backed up, you cannot use the command lineclient to restore any data inside the mounted volume. For bestresults, back up at least one mount point for any virtual volume youwant to restore.


10.U

singC

omm

ands

Restoring Microsoft DFS JunctionsTo restore Microsoft DFS junctions, you must restore Microsoft DFSroot. If you select the junction point itself, Tivoli Storage Managerrestores data under junction, but not the junction itself. If you selecta junction point that no longer exists under DFS root, Tivoli StorageManager creates a local directory under DFS root with the samename as the junction before restoring data.

Restoring Active FilesWhen restoring active and inactive versions of the same file usingthe replaceoption, only the most recently restored file is replaced.

Performing Restores with version 3.1.0.5 or LaterIf you are using client version 3.1.0.5 or later, the workstation nameis part of the file name. Therefore, if you back up files on oneworkstation and you want to restore them to another workstation,you must specify a destination. This is true even if you are restoringto the same physical workstation, but the workstation has a newname. For example, to restore thec:\doc\h2.doc file to its originaldirectory on the workstation, namedstar, you would enter:

dsmc restore c:\doc\h2.doc \\star\c$\

To restore the file tostar which has now been renamedmeteor, youwould enter:

dsmc restore c:\doc\h2.doc \\meteor\c$\

You could also enter:dsmc restore c:\doc\h2.doc \\star\c$\

This example is valid because the workstation name is not includedin the specification, so the local workstation is assumed (meteor, inthis case).

Restoring from File Spaces that are not Unicode EnabledFor Windows NT and Windows 2000 clients: If you want to restorefrom file spaces that are not Unicode enabled, you must specify thesource on the server and a destination on the client. For example,you backed up your H-disk, named\\your-node\h$, prior to


installing the Unicode-enabled client. After the installation, you issuethe following command for a selective backup:

sel h:\logs\*.log

Before the backup takes place, the server renames the file space to\\your-node\h$_OLD. The backup continues placing the dataspecified in the current operation into the Unicode-enabled file spacenamed\\your-node\h$. That file space now contains only the\logs directory and the*.log files. If you want to restore a filefrom the (old)renamedfile space to its original location, you mustenter both the source and destination as follows:

restore \\your-node\h$_OLD\docs\myresume.doc h:\docs\

Windows 2000 ConsiderationsTivoli Storage Manager restores named streams on a file basis only.Directories in Windows 2000 can contain named streams. Namedstreams attached to a directory will always be overwritten (regardlessof the value of the prompt option) during a restore operation.

When restoring sparse files to a non-NTFS file system, set the TivoliStorage Manager server communication time out value (idletimeout)to the maximum value of 255 to avoid client session timeout. TivoliStorage Manager is restricted to restoring sparse files that are lessthen 4 gigabytes in size.

The following issues apply if more data is restored than theMicrosoft disk quota allows:

¶ If the user performing the restore has a disk quota (e.g., belongsto the Backup Operator Group), Tivoli Storage Manager will notrestore any data that exceeds the restore user’s disk quota andwill display a ″Disk Full″ message.

¶ If the user performing the restore does not have a disk quota(e.g., belongs to the Administrator Group), Tivoli StorageManager will restore all data and transfer ownership of thosefiles which exceed the original owner’s disk quota to the userperforming the restore (in this case, the Administrator).


10.U

singC

omm

ands

Syntax

ÊÊ REStoreFILE

optionsÊ

Ê sourcefilespec{filespacename}sourcefilespec

Ê

Êdestinationfilespec

ÊÍ

Parametersfile

This parameter specifies that the source file specification is anexplicit filename. This parameter is required when you restore afile name from the current path, when you do not specify arelative or absolute path, and when the file name conflicts withone of the reservedrestore command keywords, such asrestorebackupset. See “Maximum File Size for Operations” on page 320for the maximum file size for restore processing.

optionsYou can use these command line options with therestorecommand:dirsonly, filelist, filesonly, fromdate, fromnode,fromtime, ifnewer, inactive, latest, pick, pitdate, pittime,preservepath, todate, totime. For more information, see “UsingOptions with Commands” on page 269.

You can use these common options with therestore command:replace, subdir. See “Setting Common Options” on page 127 forinformation about common options.

sourcefilespecSpecifies the path and file name in storage that you want torestore. Use wildcard characters to specify a group of files or allthe files in a directory.


Note: If you include filespacename, do not include a drive letterin the file specification.

{filespacename}Specifies the file space (enclosed in braces) on the server thatcontains the files you want to restore. This is the name on theworkstation drive from which the files were backed up.

Use thefilespacenameif the drive label name has changed or ifyou are restoring files backed up from another node with drivelabels that are different from yours. This is the drive label nameor UNC name on the workstation drive from which the file wasbacked up. The following example is valid for specifying a UNCname:{'\\machine\C$'}.


destinationfilespecSpecifies the path and file name where you want to place theretrieved files. If you do not specify a destination, Tivoli StorageManager restores the files to the original source path.

When entering thedestinationfilespec, please consider thefollowing:¶ If the sourcefilespecnames a single file, the

destinationfilespeccan be a file or a directory. If you arerestoring a single file, you can optionally end thespecification with a file name if you want to give therestored file a new name.

¶ If the sourcefilespecis wildcarded orsubdir=yesis specified,the destinationfilespecmust be a directory and end with adirectory delimiter (\).

Note: If the destination path or any part of it does not exist,Tivoli Storage Manager will create it.


10.U

singC

omm

ands

ExamplesTask Restore a single file namedbudget.fin.

Command: restore c:\devel\projecta\budget.fin

Task Restore a single file namedbudget.fin which resides in thecurrent directory.

Command: restore file budget.fin

Task Restore files from theabc NTFS file spaceproj directory.

Command: rest {"abc"}\proj\*.*

Task Restore all files with a file extension of.c from thec:\devel\projecta directory.

Command: rest c:\devel\projecta\*.c

Task Restore all files with an extension of.c from the\devel\projecta directory located in thewinnt file space.

Command: rest {winnt}\devel\projecta\*.c

Task Restore all files with a file extension of.c from thec:\devel\projecta directory to thec:\newdevel\projectn\projecta directory. If theprojectn or projectn\projecta directory does not exist, itis created.

Command: restore c:\devel\projecta\*.cc:\newdevel\projectn

Task Restore files in thec:\project directory. Use thepick andinactive options to select active and inactive backupversions.

Command: restore c:\project\* -pi -ina

Task Restore a file from the renamed file space\\your-node\h$_OLD to its original location. Enter both thesource and destination as follows:

Command: res \\your-node\h$_OLD\docs\myresume.doch:\docs\

Task Restore files specified in the filelist to a different location.


Command: res -filelist=c:\avi\restorelist.txtc:\NewRestoreLocation\


10.U

singC

omm

ands

Restore ActivedirectoryThe restore activedirectory command restores a Windows 2000Active Directory database and associated logs from the server. TheActive Directory must be offline before you begin the restore. Tobegin the restore, reboot the system in the inactive directory restoremode. While the directory is offline, all user validation occurs usingthe Security Accounts Manager (SAM) in the registry.Forinformation on system objects that must be restored together, see“Backing Up System Objects” on page 49.

SyntaxÊÊ REStore ACTIVEDirectory

optionsÊÍ

Parametersoptions

Windows 2000: You can use these command line options withthe restore activedirectory command:inactive, pittime, pitdate,pick. For more information about command line options, see“Using Options with Commands” on page 269.

ExamplesTask Restore the Active Directory on the local server.

Command: res actived


Restore BackupsetThe restore backupsetcommand restores a backup set from theserver, a local file, or a local tape device.

If you are restoring a file space from a backup set to a system thatdid not perform the original backup, you may need to:¶ Specify a destination¶ Use the syntax below to specify the source file¶ Do both of the abovedsmc restore backupset backupsetname {\\machinename\c$}\* c:\destdir-subdir=yes

You can restore one or all system objects from a backup set usingthe systemobjectnameparameter. On the GUI you can only restorethe entire backup set, which may contain system objects.

A backup set can also be restored from a tape device on theWindows NT and Windows 2000 clients. See “Location” on page293 for information on supported tape devices and how to specifythese devices.

If you are unable to restore a backup set from portable media, checkwith your Tivoli Storage Manager administrator to ensure that theportable media was created on a device using a compatible format.

Note: There is no support in the API for the backup set format.Therefore, backup set data that was backed up via the APIcannot be restored or used.

Attention: If the object you want to restore is part of a backup setgenerated on a node, and the node name is changed on the server,any backup set objects that were generated prior to the name changewill not match the new node name. Ensure that the node name is thesame as the node for which the backup set was generated.


10.U

singC

omm

ands

Restoring Backup Sets in a SAN EnvironmentYou can restore backup sets in a storage area network (SAN) in thefollowing ways:¶ If the backup set is on a SAN-attached storage device, specify

the device using thefilenameparameter and use thelocation=tapeoption. Tivoli Storage Manager restores thebackup set directly from the SAN-attached storage device,gaining high-speed restore performance.

Note: You must ensure that the correct tape is mounted in theSAN-attached tape drive prior to issuing therestorecommand. The backup-archive client will not initiate aSCSI autochanger to mount the tape automatically.

¶ If the backup set is not on local media or a SAN-attachedstorage device, you can specify the backup set using thebackupsetnameparameter. Use thelocation=serveroption torestore the backup set directly from the server via the LAN.

SyntaxÊÊ REStore BACKUPSET

optionsbackupsetnamefilename

Ê

Ê sourcefilespec{filespacename}sourcefilespecSYSTEMObject

Ê


ÊÍ

Parametersoptions

You can use these command line options with therestorebackupsetcommand:location, ifnewer, preservepath. See“Using Options with Commands” on page 269 for informationabout these command line options.


You can use these common options with therestore backupsetcommand:quiet, replace, subdir. See “Setting CommonOptions” on page 127 for information about these commonoptions.

backupsetnameSpecifies the name of the backup set on the server from whichto perform a restore operation. Wildcard characters cannot beused to specify the backup set name. Tivoli Storage Managerrestores the backup set from the server via LAN.

filenameSpecifies the name of a local file or device from which toperform a restore operation.

sourcefilespecSpecifies the source path which can be a portion of the backupset. The default is to restore the entire backup set.

{filespacename}Specifies the file space name that contains the files you want torestore.

SYSTEMObjectSpecifies that you want to restore all Windows 2000 systemobjects from the backup set.

destinationfilespecSpecifies the destination path for the restored files. If you do notspecify a destination, Tivoli Storage Manager restores the files tothe original source path. Windows 2000 system objects can onlybe restored to the original source path.If you are restoring morethan one file, you must end the specification with a directorydelimiter (\), otherwise, Tivoli Storage Manager assumes the lastname is a file name and reports an error. If you are restoring asingle file, you can optionally end the specification with a filename if you want to give the restored file a new name.

ExamplesTask Restore a backup set calledmybackupsetnamefrom the

server.


10.U

singC

omm

ands

Command: restore backupset mybackupsetname-loc=server

Task Restore the backup set contained in thebackupsetfile.name file in the budget directory.

Command: restore backupsetc:\budget\backupsetfile.name -loc=file

Task Restore a backup set from the\\.\tape0 device.

Command: dsmc restore backupset \\.\tape0-loc=tape

Task Restore the system objects contained in backup setbackupsetfile.name file in the recovery directory.

Command: dsmc restore backupsetc:\recovery\backupsetfile.name systemobject


Restore CertserverdbThe restore certserverdbcommand restores a Windows 2000certificate server database. For information on system objects thatmust be restored together, see “Backing Up System Objects” on page49.

SyntaxÊÊ REStore CERTServerdb

optionsÊÍ

Parametersoptions

Windows 2000: You can use these command line options withthe restore certserverdbcommand:inactive, pittime, pitdate,pick. For more information about command line options, see“Using Options with Commands” on page 269.

ExamplesTask Restore the certificate server database.

Command: res certs


10.U

singC

omm

ands

Restore ClusterdbThe restore clusterdb command restores a Windows 2000 MicrosoftCluster Services cluster database for the local cluster. Forinformation on system objects that must be restored together, see“Backing Up System Objects” on page 49.

SyntaxÊÊ REStore CLUSTERDB

optionsÊÍ

Parametersoptions

Windows 2000: You can use these command line options withthe restore clusterdb command:inactive, pittime, pitdate, pick.For more information about command line options, see “UsingOptions with Commands” on page 269.

ExamplesTask Restore the Microsoft Cluster Services cluster database.

Command: res clusterdb


Restore ComplusdbThe restore complusdbcommand restores a Windows 2000 COM+database. For information on system objects that must be restoredtogether, see “Backing Up System Objects” on page 49.

SyntaxÊÊ REStore COMPlusdb

optionsÊÍ

Parametersoptions

Windows 2000: You can use these command line options withthe restore complusdbcommand:inactive, pittime, pitdate,pick. For more information about command line options, see“Using Options with Commands” on page 269.

ExamplesTask Restore the COM+ database.

Command: restore compl


10.U

singC

omm

ands

Restore EventlogThe restore eventlogcommand restores the active Windows NT andWindows 2000 event logs previously stored on the server.

Event logs are restored to theadsm.sys\eventlog.res directoryunder the root directory of the system drive or to a destination youspecify.


ÊÊ REStore Eventlogoptions

ÊÍ

For Windows NT

ÊÊ REStore EventlogENTIRE

LOG APPLICATIONSECURITYSYSTEM

Ê

Ê destinationfilespecoptions

ÊÍ

ParametersThe following parameters are for Windows NT.

ENTIRERestores all event logs stored on the server.

LOGRestores one of the following event logs:

APPLICATIONRestores the application event log.


SECURITYRestores the security event log.

SYSTEMRestores the system event log.

destinationfilespecIdentifies the path where you want to place the restored files. Ifyou do not specify a destination, Tivoli Storage Manager restoresthe files to theadsm.sys\eventlog.res directory on the systemdrive root directory.

optionsWindows 2000: You can use these command line options withthe restore eventlogcommand:inactive, pittime, pitdate, pick.See “Setting Common Options” on page 127 for moreinformation.

ExamplesTask Restore the entire event log.

Command: rest event entire

Task Restore the security event log.

Command: rest event log security

Task Restore the system event log.

Command: rest event log system c:\tempdir


10.U

singC

omm

ands

Restore FRSThe restore frs command restores Windows 2000 replicated files.Replicated file systems are part of system state data and must berestored along with the other components of that data such as theregistry, system volumes, and the certificate server database.

SyntaxÊÊ REStore FRS

optionsÊÍ

Parametersoptions

Windows 2000: You can use these command line options withthe restore frs command:inactive, pittime, pitdate, pick. Formore information about command line options, see “UsingOptions with Commands” on page 269.

ExamplesTask Restore replicated file systems..

Command: res frs


Restore NASThe restore nascommand restores the image of a file systembelonging to a Network Attached Storage (NAS) file server. TheNAS file server performs the outboard data movement. A serverprocess performs the restore.

Use thenasnodenameoption to specify the node name for the NASfile server. When using an interactive command line session with anon-administrative ID, Tivoli Storage Manager prompts for anadministrator ID. The NAS node name identifies the NAS file serverto the Tivoli Storage Manager server. You must register the NASnode name at the server. Place thenasnodenameoption in yourclient options filedsm.opt. The value in the client options file is thedefault, but this value can be overridden on the command line. See“Nasnodename” on page 209 for more information.

You can use thepick option to display a list of NAS images ownedby the NAS node you specify. From this list you can select one ormore images to restore. If you select multiple images to restoreusing thepick option, do not use themonitor option or you willserialize the restores. To start multiple restore processessimultaneously when restoring multiple images, do not specifymonitor=yes.

Use themonitor option to specify whether you want to monitor aNAS file system image restore and display processing informationon your screen. See “Monitor” on page 296.

Use themonitor processcommand to display a list of currentrestore processes for all NAS nodes for which your administrativeuser ID has authority. The authorized administrative user ID shouldhave at least client owner authority over both the NAS node and theclient workstation node they are using either from command line orfrom the web.

Use thecancel processcommand to stop NAS restore processing.For more information, see “Cancel Process” on page 346.


10.U

singC

omm

ands

The restore nascommand is valid for Windows NT and Windows2000 clientsonly.

A NAS file system specification uses the following conventions:

¶ Regardless of client platform, NAS file system specifications usethe forward slash (/) separator, as in this example:/vol/vol0.

¶ NAS file system designations on the command line require bracedelimiters {} around the file system names, such as:{/vol/vol0}.

SyntaxÊÊ REStore NAS

optionssourcefilespec Ê


ÊÍ

Parametersoptions

You can use these common options with therestore nascommand:monitor, nasnodename, quiet, verbose. For moreinformation, see “Setting Common Options” on page 127.

You can use these command line options with therestore nascommand:inactive, pick, pitdate, pittime. For more information,see“Using Options with Commands” on page 269.

sourcefilespecSpecifies the name of the NAS file system image you want torestore. This parameter is required This parameter is requiredunless you use thepick option to display a list of NAS imagesfrom which to choose. You cannot use wildcard characters whenspecifying thesourcefilespec.

destinationfilespecSpecifies the name of an existing mounted file system on the


NAS device over which you want to restore the image. Thisparameter is optional. The default is the original location of thefile system on the NAS device.

ExamplesTask Restore the NAS file system image/vol/vol1 to the

/vol/vol2 file system on the NAS file server callednas1.

Command: restore nas -nasnodename=nas1{/vol/vol1} {/vol/vol2}

Task Restore inactive NAS images.

Command: restore nas -nasnodename=nas2 -pick-inactive


10.U

singC

omm

ands

Restore RegistryThe restore registry command restores the Windows registry. Forinformation on system objects that must be restored together, see“Backing Up System Objects” on page 49.

When you restore a registry key, you have a choice of whether ornot to activate the key. A backup copy of the active registry andregistry key is made in theadsm.sys\registry.sav file on thesystem drive root directory before the registry is restored. IfWindows does not boot with the newly restored registry, you canused this saved copy to reboot. If you are using Windows 98 orWindows Me, the file will beadsm98.sys\registry.sav. Thedirectory structure is the same asc:\adsm.sys\registry, which isdescribed below.

If you cannot boot Windows, you might be able to manually restorethe registry if you can boot another operating system that does notuse the registry. During backup and restore, copies of the registry aresaved on the workstation in the following directories (assuming thatyour system drive isc:):

c:\adsm.sys\registryThis directory contains subdirectories that are named afterthe Windows workstation name. For example, if theworkstation name istanenhaus, the directory would be:c:\adsm.sys\registry\tanenhaus

Note: For Windows 98 or Windows Me, the directory nameis adsm98.sys\registry.

Attention: Restore the registry to the same workstation fromwhich it was backed up, since the registry contains specifichardware and software information. If you try to restore to anotherworkstation, you may not be able to boot the computer after therestore.

If you have theNT Server Resource Kitinstalled, you can use theregrest standalone utility to restore the registry file created with thebackup registry command. For example, assume that a user profileis backed up to a file namedguest and you want to save the active


copy of the registry to a file namedguest.sav. The hive type youwant to save to isusers, and the hive name is the user SID, which isfound in hk_users. You would enter the following statement:restore registry c:\adsm.sys\registry\machine\users\guestc:\guest.sav users S-1-5-21-8533442-1654749355-78804774-1152

For Windows 2000, registry backup will enumerate and process allhives listed in:HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Eventlog

For the restore to take effect, you must reboot your machine.

For complete information on therestore registry command, see thedocumentation for yourNT Server Resource Kit.


ÊÊ REStore REgistryYes

ACTIVATEkeyNo options

ÊÍ

For Windows NT

ÊÊ REStore REgistryENTIRE

MACHINE SAMSECURITYSOFTWARESYSTEM

USER CURUSERDEFAULT

Ê


10.U

singC

omm

ands

ÊYes

ACTIVATEkeyNo

ÊÍ

For Windows 98, Me

ÊÊ REStore REgistryENTIRE

MACHINE CONFIGENUMHARDWARENETWORKSAMSECURITYSOFTWARESYSTEM

USERDEFAULT

Ê

ÊYes

ACTIVATEkeyNo

ÊÍ

ParametersThe following parameters are for Windows 98, Me, and NT.

ENTIRERestores the registry keys previously backed up. This is thedefault.

MACHINERestores one of the following machine root key hives (registrysubkeys):

CONFIGValid for Windows 98 and Me only. Restores the localworkstation config hive (hkey_local_machine\configsubkey).


ENUMValid for Windows 98 and Me only. Restores the localmachine enumerate hive (hkey_local_machine\enumsubkey).

HARDWAREValid for Windows 98 and Me only. Restores the localmachine hardware hive (hkey_local_machine\hardwaresubkey).

NETWORKValid for Windows 98 and Me only. Restores the localmachine network hive (hkey_local_machine\networksubkey).

SAMValid for Windows NT only. Restores the Security AccountsManager (SAM) hive (hkey_local_machine\sam subkey).

SECURITYRestores the security policy hive(hkey_local_machine\security subkey).

SOFTWARERestores the local machine software configuration hive(hkey_local_machine\software subkey).

SYSTEMRestores the local machine system configuration hive(hkey_local_machine\system subkey).

USERRestores one of the following user root key hives (registrysubkeys):

CURUSERValid for Windows NT only. Restores the current (logged on)user profile.

DEFAULTRestores the default user profile hive (hkey_users\defaultsubkey).


10.U

singC

omm

ands

ACTIVATEkeySpecifies whether to activate the registry key after restoring thefiles. You may specify this option on the command line or in thedsm.opt file. See “Activatekey” on page 147 for moreinformation.

YesUpdate the registry. You must reboot for the changes to takeeffect. This is the default.

NoTivoli Storage Manager restores the files, but does notupdate the registry.

optionsWindows 2000: You can use these command line options withthe restore registry command:inactive, pittime, pitdate, pick.See “Setting Common Options” on page 127 for moreinformation.

ExamplesTask Restore the entire directory.

Command: rest reg entire

Task Restore the Security Accounts Manager (SAM).

Command: rest reg machine sam

Task Update the registry.

Command: rest reg machine same –activate=y


Restore RSMRemovable Storage Manager (RSM) runs on Windows NT Serverand Windows 2000 Server operating systems. Therestore rsmcommand restores backups of RSM database files on the server.Changes are effective after the server is restarted.

Note: Although thebackup rsm command backs up the RSMdatabase, the command does not back up the data managed byWindows 2000 Remote Storage Service (RSS). To back upand restore offline data managed by RSS, you must use theMicrosoft Backup Utility. Following are somerecommendations for working with offline RSS-managed data:

¶ Restore the RSM database before using Microsoft BackupUtility to restore the offline data managed by RSS.

¶ Retrieve all offline data from RSS via the MicrosoftBackup Utility before using the Tivoli Storage Managerclient.

¶ Due to a Windows 2000 issue, you must reboot theWindows 2000 Server to complete the restore of the RSMdatabase.

Windows 2000 Servers (Server, Advanced Server, and DatacenterServer) may allow many applications to share a bulk storage device.On these servers, RSM manages data on removable storage mediathat exists in a media pool. This data is accessible by mediaapplication and media management programs and can be shared andtraced across applications. Tivoli Storage Manager servers supportRSM by creating application pools for backup media. Tivoli StorageManager clients support RSM recovery by creating a backup of theRSM database when running on a Windows 2000 Server.

SyntaxÊÊ REStore RSM

optionsÊÍ


10.U

singC

omm

ands

Parametersoptions

Windows 2000: You can use these command line options withthe restore rsm command:inactive, pittime, pitdate, pick. See“Setting Common Options” on page 127 for more information.

ExamplesTask Restore the RSM database.

Command: res rsm


Restore SysfilesThe restore sysfilescommand restores Windows 2000 system andboot files. These files make changes to the registry and shouldnotbe restored at the same time as the registry. If you are restoring boththe registry and the system and boot files, restore the registry first.System and boot files are part of the system state data and must berestored along with the other components of that data such as theregistry, cluster service information and the certificate serverdatabase.

SyntaxÊÊ REStore SYSFiles

optionsÊÍ

Parametersoptions

Windows 2000: You can use these command line options withthe restore sysfilescommand:inactive, pittime, pitdate, pick.See “Setting Common Options” on page 127 for moreinformation.

ExamplesTask Restore system and boot files.

Command: res sysf


10.U

singC

omm

ands

Restore SystemobjectThe restore systemobjectcommand restores all of the followingactive and inactive Windows 2000 system objects stored on theserver:¶ Active Directory (domain controller only)¶ Certificate Server Database¶ Cluster Database (cluster node only)¶ COM+ database¶ Registry¶ System and boot files¶ System volume¶ Event logs (system, security and application)¶ Removable Storage Management Database (RSM)¶ Replicated file systems

The restore systemobjectcommand isonly valid for Windows 2000.To restore the active Windows NT registry system object stored onthe server, use therestore registry command. To restore the activeWindows NT eventlog stored on the server, use therestore eventlogcommand.

SyntaxÊÊ REStore SYSTEMObject

optionsÊÍ

Parametersoptions

Windows 2000: You can use these command line options withthe restore systemobjectcommand:pittime andpitdate. See“Setting Common Options” on page 127 for more information.

ExamplesTask Restore all active system objects.

Command: restore systemobject


Restore SysvolThe restore sysvolcommand restores a Windows 2000 systemvolume. This system object is part of system state data and must berestored with other components of that data such as the registry,system files, and the certificate server database.

SyntaxÊÊ REStore SYSVol

optionsÊÍ

Parametersoptions

Windows 2000: You can use these command line options withthe restore sysvolcommand:inactive, pittime, pitdate, pick. See“Setting Common Options” on page 127 for more information.

ExamplesTask Restore a system volume.

Command: res sysv


10.U

singC

omm

ands

RetrieveThe retrieve command obtains copies of archived files from theserver. You can retrieve specific files or entire directories. Use thedescriptionoption to specify the descriptions assigned to the filesyou want to retrieve.

You can also use thepick option on the command line to display alist of your archives. From this list, you can select the desiredarchive to retrieve.

Place the retrieved files in the same directory from which they werearchived, or in a different directory. Tivoli Storage Manager uses thepreservepathoption with thesubtreevalue as the default forrestoring files. For more information, see “Using Options withCommands” on page 269.

Note: An error will occur if you attempt to retrieve a file whosename is the same as the short name of an existing file. Forexample, if you attempt to retrieve a file you specificallynamedABCDEF˜1.DOC into the same directory where a filenamedabcdefghijk.doc exists, the retrieve will fail becausethe Windows operating system equates the file namedabcdefghijk.doc to a short name ofABCDEF˜1.DOC. Theretrieve function treats this as a duplicate file.

If this error should occur, perform any of the followingactions to correct it:

¶ Retrieve the file with the short file name you specified, toa different location.

¶ Stop the retrieve, and change the name of the existingfile.

¶ Disable the short file name support on Windows.

¶ Do not use file names that would conflict with the shortfile naming convention; for example, do not useABCDEF˜1.DOC.


If you are using client version 3.1.0.5 or later, the workstation nameis part of the file name. Therefore, if you archive files on oneworkstation and you want to retrieve them to another workstation,you must specify a destination. This is true even if you are retrievingto the same physical workstation, but the workstation has a newname. For example, to retrieve thec:\doc\h2.doc file to its originaldirectory on the workstation, namedstar, you would enter:

dsmc retrieve c:\doc\h2.doc \\star\c$\

To retrieve the file tostar which has now been renamedmeteor, youwould enter:

dsmc retrieve c:\doc\h2.doc \\meteor\c$\

You could also enter:dsmc retrieve c:\doc\h2.doc \\star\c$\

This example is valid because if the workstation name is notincluded in the specification, the local workstation is assumed(meteor, in this case).

Retrieving from File Spaces that are not Unicode EnabledFor Windows NT and Windows 2000 clients: If you want to retrievearchives from file spaces that were renamed by the Unicode-enabledclient, you must specify the source on the server and a destinationon the client. For example, you archived files from your H-disk,named\\your-node\h$ prior to installing the Windows NT orWindows 2000 client. After the installation, you issue the followingarchive command:

arc h:\logs\*.log

Before the archive takes place, the server renames the file space to\\your-node\h$_OLD. The archive continues placing the dataspecified in the current operation into the Unicode-enabled file spacenamed\\your-node\h$. That file space now contains only the\logs directory and the*.log files. If you want to retrieve a filefrom the (old)renamedfile space to its original location, you mustenter both the source and destination as follows:

retrieve \\your-node\h$_OLD\docs\myresume.doc h:\docs\


10.U

singC

omm

ands

Windows 2000 ConsiderationsTivoli Storage Manager retrieves named streams on a file basis only.Directories in Windows 2000 can contain named streams. Namedstreams attached to a directory will always be overwritten (regardlessof the value of theprompt option) during the retrieve.

When retrieving sparse files to a non-NTFS file system, set theServer communication time out value (idletimeout) to the maximumvalue of 255 to avoid client session timeout.

The following issues apply if more data is restored than theMicrosoft disk quota allows:

¶ If the user performing the retrieve does not have a disk quota(e.g., belongs to the Backup Operator Group), Tivoli StorageManager will not retrieve any data that exceeds the retrieveuser’s disk quota and will display a″Disk Full″ message.

¶ If the user performing the retrieve does not have a disk quota(e.g., belongs to the Administrator Group), Tivoli StorageManager will retrieve all data and transfer ownership of thosefiles which exceed the original owner’s disk quota to the userperforming the retrieve (in this case, the Administrator).

SyntaxÊÊ RETrieve

optionsÊ

Ê sourcefilespec{filespacename}sourcefilespec

Ê


ÊÍ


Parametersoptions

You can use these command line options with theretrievecommand:description, dirsonly, filelist, filesonly, fromdate,fromnode, fromtime, ifnewer, pick, preservepath, todate, totime.For more information, see “Using Options with Commands” onpage 269.

For information about common options you can use with theretrieve command, see “Setting Common Options” on page 127.

sourcefilespecSpecifies the path and file name that you want to retrieve. Usewildcard characters to specify a group of files or all the files in adirectory. See “Maximum File Size for Operations” on page 320for the maximum file size for retrieve processing.


{filespacename}Specifies the file space (enclosed in braces) on the server thatcontains the files you want to retrieve. This name is the drivelabel on the workstation drive from which the files werearchived.

Use the file space name if the drive label name has changed, orif you are retrieving files archived from another node with drivelabel names that are different from yours.


destinationfilespecSpecifies the path and file name where you want to place the


10.U

singC

omm

ands

retrieved files. If you do not specify a destination, Tivoli StorageManager restores the files to the original source path.

When entering thedestinationfilespecplease consider thefollowing:¶ If the sourcefilespecnames a single file, the

destinationfilespeccan be a file or a directory.¶ If the sourcefilespecis wildcarded orsubdir=yesis specified,

the destinationfilespecmust be a directory and end with adirectory delimiter (\).

Note: If the destination path or any part of it does not exist,Tivoli Storage Manager will create it.

ExamplesTask Retrieve a single file namedbudget.fin.

Command: ret c:\devel\projecta\budget.fin

Task Retrieve all files with an extension of.c from thec:\devel\projecta directory.

Command: ret c:\devel\projecta\*.c

Task Retrieve all files with a file extension of.c from the\devel\projecta directory on thewinnt file space.

Command: ret {winnt}\devel\projecta\*.c

Task Retrieve all files in thec:\devel directory.

Command: ret c:\devel\*

Task Retrieve files from theabc file spaceproj directory.

Command: ret {abc}\proj\*.*

Task Retrieve all files with a file extension of.c from thec:\devel\projecta directory to thec:\newdevel\projectn\projecta directory. If the\projectn or the\projectn\projecta directory does notexist, it is created.

Command: ret c:\devel\projecta\*.cc:\newdevel\projectn\


Task Retrieve files in thec:\project directory. Use thepickoption.

Command: ret c:\project\* -pick

Task Retrieve a file from the renamed file space\\your-node\h$_OLD to its original location. Enter both thesource and destination as follows:

Command: ret \\your-node\h$_OLD\docs\myresume.doch:\docs\


10.U

singC

omm

ands

ScheduleThe schedulecommand starts the client scheduler on yourworkstation. The client scheduler must be running before scheduledwork can start.

If the schedmodeoption is set to polling, when you start the clientscheduler it continuously contacts the server for scheduled eventsbased on the time you specified with thequeryschedperiodoption inyour client options filedsm.opt. If your administrator sets thequeryschedperiodoption for all nodes, that setting overrides yoursetting.

If you are using TCP/IP communications, the server can prompt yourworkstation when it is time to run a scheduled event. To do so, setthe schedmodeoption topromptedin the client options filedsm.optor on theschedulecommand.

Note: Tivoli Storage Manager does not support the client schedulerrunning inpromptedmode across a firewall. Use the clientscheduler inpolling mode across a firewall.

After you start the client scheduler, it continues to run and to startscheduled events until you pressCtrl+Break , restart the workstation,or turn off the workstation to end it.

Note: You cannotenter this command in interactive mode.

SyntaxÊÊ SCHedule

optionsÊÍ

Parametersoptions

You can use these common options:maxcmdretries, password,


queryschedperiod, retryperiod, schedlogname, schedmode, andtcpclientport. See “Setting Common Options” on page 127 formore information.

ExamplesTask Start the client scheduler.

Command: dsmc sch –password=notell


10.U

singC

omm

ands

SelectiveThe selectivecommand backs up files that you specify. If these filesbecome damaged or lost, you can replace them with backup versionsfrom the server. When you run a selective backup, all the files arecandidates for back up unless they are excluded from backup in yourinclude-exclude list, or they do not meet management classrequirements for serialization.

During a selective backup, copies of the files are sent to the servereven if they did not change since the last backup. This might resultin more than one copy of the same file on the server. If this occurs,you might not have as many different down-level versions of the fileon the server as you intended. Your version limit might consist ofidentical files. To avoid this, use theincremental command to backup only new and changed files.

You can selectively back up single filesor directories. You can alsouse wildcard characters to back up groups of related files.

During a selective backup, a directory path may be backed up, evenif the specific file that was targeted for backup is not found. Forexample:

selective c:\dir1\dir2\bogus.txt

still backs up dir1 and dir2 even if the filebogus.txt does notexist.

If the selectivecommand is retried because of a communicationfailure or session loss, the transfer statistics will display the numberof bytes Tivoli Storage Manager attempts to transfer duringallcommand attempts. Therefore, the statistics for bytes transferred maynot match the file statistics, such as those for file size.

Adaptive Subfile BackupsIf you perform a backup over a network device with limitedbandwidth, such as with a modem, you can reduce network traffic byusing thesubfilebackupoption. In order to use this feature, youmust first specify the adaptive subfile backup options during anormal backup. For information about adaptive subfile backups, see


“Performing a Backup with Limited Bandwidth” on page 44. Formore information about using thesubfilebackupoption, see“Subfilebackup” on page 245.


Windows 2000 ConsiderationsTivoli Storage Manager backs up named streams on a file basis only.Backup of a named stream containing sparse file data is notsupported. A sparse file is backed up as a regular file if Clientcompression is off. Enable file compression (compression=on) whenbacking up sparse files to minimize network transaction time and tomaximize server storage space.

Microsoft disk quotas do not affect the amount of data you can backup.

Syntax

ÊÊ SELectiveoptions

» filespec ÊÍ

Parametersoptions

You can use these command line options with theselectivecommand:dirsonly, filesonly, filelist. For more information, see“Using Options with Commands” on page 269.

You can use these common options with theselectivecommand:changingretries, quiet, tapeprompt, subdir, subfilebackup. See“Setting Common Options” on page 127 for information aboutthese common options.

filespecSpecifies the path and file name that you want to back up. Usewildcard characters to select a group of files or all the files in a


10.U

singC

omm

ands

directory. You can also enter up to 20 file specifications in acommand by separating the file specifications with a space.When backing up a file system, specify the file system with atrailing slash.

ExamplesTask Back up theproja.dev file in the c:\devel directory.

Command: sel c:\devel\proja.dev

Task Back up all files in thec:\devel directory whose file namesbegin withproj.

Command: sel c:\devel\proj*.*

Task Back up all files in thec:\devel directory whose file namesbegin withproj. Back up all files with a file extension of.fin in the c:\planning directory.

Command: sel c:\devel\proj* c:\planning\*.fin


Set AccessThe set accesscommand gives users at other nodes access to yourbackup versions or archived copies. You can give another user accessto a specific file, multiple files, or all files in a directory. When yougive access to another user, that user can restore or retrieve yourobjects. Specify in the command whether you are giving access toarchives or backups.

Note: You cannot give access to both archives and backups using asingle command.

SyntaxÊÊ SET Access Archive

BackupÊ


nodeuser

Ê

Ê

» options

ÊÍ

ParametersArchive

Permits access to archived files.

BackupPermits access to backup versions of files.

filespecSpecifies the path, file or directory to which you are givingaccess to another node or user. Use wildcard characters tospecify a group of files, or all files in a directory; all objects in adirectory branch; or all objects in a drive. However, you cannotuse a wildcard to specify all drives. Use a single asterisk″*″ for


10.U

singC

omm

ands

the file spec to give access to all files owned by you and backedup on the server. When the commandset access backup″*″node is entered, no check is made with the server; it is assumedyou have at least one object backed up.

If you give access to a branch of the current working directory,you only need to specify the branch. If you give access toobjects that are not in a branch of the current working directory,you must specify the drive and directory. The file spec to whichyou gave access must have at least one backup version orarchive copy object (file or directory) on the server.

To give access to all objects below a certain level, use anasterisk, directory delimiter, and an asterisk at the end of yourfile spec. For example, to give access to all objects belowd:\test\, use file specd:\test\*\*.

To specify all files in a named directory, enterc:\proj\* on thecommand line. To specify all files in all directories off of theroot directory, enterd:\*\* on the command line. Enterd:\* ononeset accesscommand andd:\*\* on another if you wantanother user to have complete access to your file space. The firstd:\* gives access to all subdirectories and all files off of theroot directory.

Use the file space name if the drive label name has changed.


{filespacename}Specifies the file space name (enclosed in braces) on the serverthat contains the files to which you are giving access. This nameis the drive label name on the workstation drive from which thefile was backed up or archived. Use the file space name if thedrive label name has changed.

nodeSpecifies the client node of the user to whom you are givingaccess. Use wildcards to give access to more than one node withsimilar node names. Use an asterisk (*) to give access to allnodes.


userThis is an optional keyword command modifier that restrictsaccess to the user at the specified node.

optionsSee “Setting Common Options” on page 127 for informationabout common options that you can use with this command.

ExamplesTask Give the user at node_2 authority to restore all files with an

extension of.c from thec:\devel\proja directory.

Command: set access backup c:\devel\proja\*.cnode_2

Task Give the user at node_3 authority to retrieve all files in thec:\devel directory, but do not permit access to files insubdirectories ofc:\devel, such asc:\devel\proj.

Command: set access archive c:\devel\* node_3

Task Give all nodes whose names end withbldgb the authority torestore all backup versions from all directories on thed:drive. Thed: drive has the file space name ofproject.

Command: set ac b {project}\*\* *bldgb


10.U

singC

omm

ands

Set PasswordThe set passwordcommand changes the Tivoli Storage Managerpassword for your workstation. You are prompted twice for your newpassword.

A password isnot case-sensitive, and it can be as many as 64characters. Valid characters are:a–z Any letter, a through z, upper or lower-case0–9 Any number, 0 through 9+ Plus. Period_ Underscore- Hyphen& Ampersand

SyntaxÊÊ SET Password

oldpw newpw optionsÊÍ

Parametersoldpw

Specifies the current password for your workstation.

newpwSpecifies the new password for your workstation.

optionsSelect any valid common option. For more information, see“Setting Common Options” on page 127.

ExamplesThe following is an example of using theset passwordcommand.

Task Change your password fromosecretto nsecret.

Command: set password osecret nsecret


Backing Up NAS File Systems

Tivoli Storage Manager supports backup and restore of networkattached storage (NAS) file system images to tape drives or librariesthat are locally attached to NAS file servers. Tivoli Data Protectionfor NDMP enables backup and restore support on the Tivoli StorageManager Windows NT and Windows 2000 servers for NAS fileservers from Network Appliance.Tivoli Data Protection for NDMPis a separately priced and licensed product.

For information on how to configure Tivoli Data Protection forNDMP on the Tivoli Storage Manager server, seeTivoli StorageManager for Windows Administrator’s Guide, GC35-0410.

See “Tivoli Data Protection for NDMP Version 4.2.1 Requirements”on page 8 for client and server hardware and software requirements.

After configuring Tivoli Data Protection for NDMP, the serverconnects to the NAS device and uses NDMP to initiate, control, andmonitor each backup and restore operation. The NAS deviceperforms outboard data transfer to and from the NAS file system toa locally attached tape drive or library.

It is not necessary for a client node to mount a NAS file system toperform backup or restore operations on that file system.

The benefits of performing backups using Tivoli Data Protection forNDMP include the following:¶ LAN-free data transfer.

A


A.

Backing

Up

NA

SF

ileS

ystems

¶ High performance and scalable backups and restores.¶ Backup to local tape devices without network traffic.

The following support is provided:¶ Full file system image backup of all files within a NAS file

system.¶ Differential file system image backup of all files that have

changed since the last full image backup.¶ Parallel backup and restore operations when processing multiple

NAS file systems.¶ Choice of interfaces to initiate, monitor, or cancel backup and

restore operations:v Web clientv Backup-archive command line clientv Administrative command line client (backup and restore

operations can be scheduled using the administrativecommand scheduler)

v Administrative Web client

The following functions arenot supported:¶ Archive and retrieve¶ Restoring or tracking of individual files within a file system

image.¶ Client scheduling. Use server commands to schedule a NAS

backup.¶ Detection of damaged files.¶ Data-transfer operations for NAS data stored by Tivoli Storage

Manager:v Migrationv Reclamationv Storage pool backup and restorev Move datav Exportv Backup set generation

Performing a Web Client GUI BackupFor information on how to install and configure the Web client, see“Installing and Using the Web Client” on page 25.


For both the Web GUI and the command line client, you mustspecifypasswordaccess=generate(which is a current web clientrestriction for the client node) and theauthentication=on must bespecified at the server. You are always prompted for a user ID andpassword. To display NAS nodes and perform NAS functions, youmust enter an authorized administrative user ID and password. Theauthorized administrative user ID should have at least client ownerauthority over both the NAS node and the client workstation nodethey are using either from command line or from the web.

To back up NAS file systems using the Web client GUI:1. Click Backup from the main window. The Backup window

displays.2. Expand the directory tree if necessary.

Notes:a. The root node calledNodesis not selectable. This node only

appears if Tivoli Data Protection for NDMP is enabled on theserver.

b. NAS nodes display on the same level as the clientworkstation node. Only nodes for which the administrator hasauthority will display.

c. NAS nodes are expandable to reveal file spaces, but nofurther expansion is available (no file names).

3. Click the selection boxes next to the nodes or file systems youwant to back up.

4. Click the type of backup you want to perform in the backup typepull-down menu. The NAS backup type list is active only whenyou first select NAS backup objects.

5. Click Backup. The NAS BackupTask List window displays thebackup processing status and progress bar. The number next tothe progress bar indicates the estimated size of the backup, whichis the occupancy of the file system. After the backup completes,the NAS Backup Report window displays processing details,including theactual size of the backup.

Note: If it is necessary to close the Web browser session, currentNAS operations will continue after disconnect. You can


A.

Backing

Up

NA

SF

ileS

ystems

use theDismissbutton on the NAS BackupTask Listwindow to quit monitoring processing without ending thecurrent operation.

6. (Optional) To monitor processing of an operation, select theActions → Monitor TSM Activities from the GUI main window.During a differential backup, the status bar indicates processingstatus. A percentage estimate does not display.

To restore NAS file system images using the Web client GUI, see“Restoring NAS File Systems” on page 450.

Performing a Command Line BackupTable 32 lists the commands and options you can use to back upNAS file system images from the command line.

Table 32. NAS Options and CommandsOption orCommand

Definition Page

domain.nas Specifies the volumes to include in your defaultdomain for NAS backups.

168

exclude.fs.nas Excludes file systems on the NAS file serverfrom an image backup when used with thebackup nascommand. This option is forWindows NT and Windows 2000 clientsonly.

177

include.fs.nas Includes a file system or assigns a managementclass when used with thebackup nascommand.This option is for Windows NT and Windows2000 clientsonly.

189

query node Displays all the nodes for which a particularadministrative user ID has authority to performoperations. The authorized administrative user IDshould have at least client owner authority overboth the NAS node and the client workstationnode they are using either from command line orfrom the web.

387

backup nas Creates an image backup of one or more filesystems that belong to a Network AttachedStorage (NAS) file server.

333


Table 32. NAS Options and Commands (continued)Option orCommand

Definition Page

monitor process Displays current back up and restore processesfor all NAS nodes for which an administrativeuser has authority. The administrative user canthen select one process to monitor.

367

cancel process Displays current back up and restore processesfor all NAS nodes for which an administrativeuser has authority. From the display, theadministrative user can select one process tocancel.

346

query backup Use thequery backup command with theclassoption to display information about file systemimages backed up for a NAS file server.

373

query filespace Use thequery filespacecommand with theclassoption to display a list of file spaces belongingto a NAS node.

382

delete filespace Use thedelete filespacewith the classoption todisplay a list of file spaces belonging to a NASnode so that you may choose one to delete.

351



delimiters {} around the file system names, such as:{/vol/vol0}. Do not use brace delimiters in the option file.

Note: When you initiate a NAS backup operation using thecommand line client, the server starts a process to initiate,control, and monitor the operation. It may take severalmoments before you notice progress at the command lineclient interface because the server must perform mount andother necessary tasks before data movement occurs.


A.

Backing

Up

NA

SF

ileS

ystems

Restoring NAS File SystemsYou can restore full or differential NAS file system images that werebacked up previously. If you restore a differential image, TivoliStorage Manager automatically restores the full backup image first,followed by the differential image. It is not necessary for a clientnode to mount a NAS file system to perform backup or restoreoperations on that file system.

For information on how to install and configure the Web client, see“Installing and Using the Web Client” on page 25.

To restore NAS file systems using the Web client GUI:1. Click theRestore from the main window. The Restore window

appears.¶ To restore to earlier backup versions of NAS filesystem

images selectView →Display active/inactive filesfrom themain window.

¶ To restore NAS file system images to the state that existed ata specific date and time, click thePoint In Time button onthe Restore window and enter the appropriate information.

2. Expand the directory tree if necessary. To expand a node in thetree, click the plus sign (+) next to an object in the tree.

Notes:a. The root node calledNodesis not selectable. This node only

appears if Tivoli Data Protection for NDMP is enabled on theserver.

b. NAS nodes display on the same level as the clientworkstation’s node. Only nodes to which the administratorhas authority appear.

c. NAS nodes will expand to reveal file systems. Under eachfile system are images which you can select to restore.

3. Click the selection boxes next to the nodes, file systems orimages you want to restore.

4. Click Restore. The Restore Destination window appears. Enterthe information in the Restore Destination window.


Note: You can restore NAS file system images to any volumeon the NAS file server from which they were backed up.You cannot restore images to another NAS file server.

5. Click Restore. The NAS RestoreTask List window displays therestore processing status and progress bar. The number next tothe progress bar indicates the estimated size of the restore. Afterthe restore completes, the NAS Restore Report window displaysprocessing details, including the actual size of the restore.

Note: If it is necessary to close the Web browser session, currentNAS operations will continue after disconnect. You canuse theDismissbutton on the NAS RestoreTask Listwindow to quit monitoring processes without ending thecurrent operation.

6. (Optional) To monitor processing of an operation, select theActions → Monitor TSM Activities from the main window.

Table 33 lists the commands and options you can use to restore NASfile system images from the command line.

Table 33. NAS Options and CommandsOption orCommand

Definition Page

query node Displays all the nodes for which a particularadministrative user ID has authority to performoperations. The authorized administrative user IDshould have at least client owner authority overboth the NAS node and the client workstationnode they are using either from command line orfrom the web.

387

query backup Use thequery backup command with theclassoption to display information about file systemimages backed up for a NAS file server.

373

query filespace Use thequery filespacecommand with theclassoption to display a list of file spaces belongingto a NAS node.

382

restore nas Restores the image of a file system belonging toa Network Attached Storage (NAS) file server.

417


A.

Backing

Up

NA

SF

ileS

ystems

Table 33. NAS Options and Commands (continued)Option orCommand

Definition Page

monitor process Displays current backup and restore processesfor all NAS nodes for which an administrativeuser has authority. The administrative user canthen select one process to monitor.

367

cancel process Displays current back up and restore processesfor all NAS nodes for which an administrativeuser has authority. From the display, theadministrative user can select one process tocancel.

346

delete filespace Use thedelete filespacewith the classoption todisplay a list of file spaces belonging to a NASnode so that you may choose one to delete.

351



delimiters {} around the file system names, such as:{/vol/vol0}.

Note: When you initiate a NAS restore operation using thecommand line client, the server starts a process to initiate,control, and monitor the operation. It may take severalmoments before you notice progress at the command lineclient interface because the server must perform mount andother necessary tasks before data movement occurs. TivoliStorage Manager may display anInterrupted ... messagewhen the mount occurs. You can gnore this message.


Glossary

Term definitions in this glossary pertain to the Tivoli StorageManager library. If you do not find a term you are looking for, youcan refer to the following publications:

¶ IBM Dictionary of Computing, at URL:http://www.ibm.com/networking/nsg/nsgmain.htm

¶ Tivoli Software Glossary, at URL:http://www.tivoli.com/support/documents/glossary/termsm03.htm

This glossary may include terms and definitions from:

¶ The American National Standard Dictionary for InformationSystems, ANSI X3.172-1990, copyright (ANSI). You canpurchase copies from the American National Standards Institute,11 West 42nd Street, New York, New York 10036.

¶ The Information Technology Vocabulary, developed bySubcommittee 1, Joint Technical Committee 1, of theInternational Organization for Standardization and theInternational Electrotechnical Commission (ISO/IEC JTC2/SC1).

A

absoluteA copy group mode value that indicates a file is considered for incremental backupeven though the file has not changed since the last time it was backed up. Seemode. Contrast withmodified.

active policy setThe policy set within a policy domain that contains the most recently activatedpolicy. All client nodes assigned to the current policy domain use this policy set.Seepolicy set.

active versionThe most recent backup copy of a file stored in Tivoli Storage Manager storage fora file that currently exists on a file server or workstation. An active version remainsactive and exempt from deletion until:¶ Replaced by a new backup version.¶ Tivoli Storage Manager detects, during an incremental backup, that the user has

deleted the original file from a file server or workstation.


Glossary

adaptive subfile backupPermits user to perform a backup over a network device with limited bandwidth,such as a modem. Adaptive subfile backup reduces network traffic and increases thespeed of your backup. An adaptive subfile backup sends only changed portions of afile to the server during successive backup operations instead of sending the entirefile.

administrative clientA program that runs on a file server, workstation, or mainframe. This program letsadministrators monitor and control Tivoli Storage Manager servers usingadministrator commands. Contrast withbackup-archive client.

administratorA user who is registered to the server as an administrator. Administrators maypossess one or more privilege classes. Administrators can use the administrativeclient to enter Tivoli Storage Manager server commands and queries according totheir privileges.

aggregate data transfer rateDividing the total number of bytes transferred by the elapsed processing timecalculates the data transfer rate.

archiveA function permitting users to copy one or more files to a long-term storage device.Archive copies can:¶ Accompany descriptive information¶ Imply data compression software usage¶ Be retrieved by archive date, file name, or description

Contrast withretrieve.

archive copyA file or group of files residing in an archive storage pool in Tivoli StorageManager storage.

archive copy groupA policy object containing attributes that control the generation, destination, andexpiration of archived files. The archive copy group belongs to a management class.

archive retention grace periodThe number of days Tivoli Storage Manager retains an archived copy when theserver is unable to rebind the file to an appropriate management class.

authenticationThe process of checking and authorizing a user’s password before permitting useraccess to the Tivoli Storage Manager server. An administrator with system privilegecan enable or disable authentication.


authorization ruleA specification permitting another user to either restore or retrieve a user’s filesfrom Tivoli Storage Manager storage.

B

backupA function permitting users to copy one or more files to a storage pool to protectagainst data loss. Contrast withrestore.

backup-archive clientA program that runs on a file server, PC, or workstation and provides a means forusers to back up, archive, restore, and retrieve files. Contrast withadministrativeclient.

backup copy groupA policy object that contains attributes controlling the generation, destination, andexpiration of backup files. The backup copy group belongs to a management class.

backup retention grace periodThe number of days Tivoli Storage Manager retains a backup version when theserver is unable to rebind the file to an appropriate management class.

backup setA collection of active files in your file spaces that reside on the Tivoli StorageManager server. The Tivoli Storage Manager administrator creates the backup setand copies it onto portable media device that is supported by the Tivoli StorageManager server and client.

backup versionA backed up file, directory, or file space that resides in a backup storage pool inTivoli Storage Manager storage. Theactiveversion is the most recent backupversion. Seeactive versionand inactive version.

bindingThe process of associating a file with a management class name.

C

central schedulingA function permitting an administrator to schedule backup and archive operationsfrom a central location. Schedule operations on a periodic basis or on an explicitdate.


Glossary

clientA program running on a file server, PC, workstation, or terminal that requestsservices of another program called the server. There are two types of Tivoli StorageManager clients: administrative and backup-archive. Seeadministrative clientandbackup-archive client.

client domainThe set of drives, file systems, or volumes selected by a user for processing duringa backup or archive operation.

client nodeA file server or workstation registered with the server on which the backup-archiveclient program is installed.

client pollingA client and server communication technique where the client node queries theserver for scheduled work.

client/serverA communications network architecture in which one or more programs (clients)request computing or data services from another program (the server).

closed registrationA registration process in which an Tivoli Storage Manager administrator mustregister workstations as client nodes with the server. Contrast withopen registration.

command line interfaceA type of user interface where commands are specified on the command line.Contrast withgraphical user interface.

communication methodThe method by which a client and server exchange information. For Tivoli StorageManager backup-archive clients, the method can be SNA LU6.2, or TCP/IP. SeeSystems Network Architecture Logical Unit 6.2, andTransmission ControlProtocol/Internet Protocol.

communication protocolA set of defined interfaces that permits computers to communicate with each other.

copy groupA policy object that contains attributes that control backup and archive file:¶ Generation¶ Destination¶ Expiration.

Backup and archive copy groups belong to management classes. Seefrequency,destination, mode, retention, serialization, andversion.


CPICCommon Programming Interface Communications.

D

default management classA management class assigned to a policy set. This class is used to govern backed upor archived files when a user does not explicitly associate a file with a specificmanagement class through the include-exclude list.

destinationA copy group attribute that specifies the storage pool in which to back up or archivea file. At installation, Tivoli Storage Manager provides two storage destinationsnamedbackuppool andarchivepool.

domainSeepolicy domainor client domain.

dragMove the mouse while holding down the mouse button, thus moving the selectedobject.

drag-and-dropMove (drag) an object on top of another object and release the mouse button, thusrelocating the object.

dsm.opt fileSeeoptions file. . Also called client options file.

dynamicA copy group serialization value that specifies Tivoli Storage Manager accept thefirst attempt to back up or archive an object, regardless of any changes made duringbackup or archive processing. Seeserialization. Contrast withshared dynamic,shared static, andstatic.

E

error logA text file written on disk that contains Tivoli Storage Manager processing errormessages. The Tivoli Storage Manager server detects and saves these errors.

excludeThe process of identifying files in an include-exclude list. This process excludesfiles from back up or migratation whenever an incremental or selective backupoperation runs. You can exclude a file from backup and space management, backuponly, or space management only.


Glossary

expirationThe process in which files are identified for deletion because their expiration date orretention period is passed. Backups or archives are marked for deletion based on thecriteria defined in the backup or archive copy group.

expiring fileA migrated or premigrated file that is marked for expiration and removal fromTivoli Storage Manager storage. If a stub file or an original copy of a premigratedfile is deleted from a local file system, or if the original copy of a premigrated fileis updated, the corresponding migrated or premigrated file is marked for expirationthe next time reconciliation is run. It expires and is removed from Tivoli StorageManager storage after the number of days specified with themigfileexpirationoption have elapsed.

F

file serverA dedicated computer and its peripheral storage devices connected to a local areanetwork that stores both programs and files shared by users on the network.

file spaceA logical space on the Tivoli Storage Manager server that contains a group of files.In Tivoli Storage Manager, users can restore, retrieve, or delete file spaces fromTivoli Storage Manager storage. A file space for systems:¶ Windows— Logical partition identified by a volume label.¶ UNIX — Logical space that contains a group of files backed up or archived

from the same file system, or part of a file system defined with thevirtualmountpoint option in the client system options file.

frequencyA copy group attribute that specifies the minimum interval, in days, betweenincremental backups.

fuzzy backupA backup version of a file that might not accurately reflect what is currently in thefile because the file was backed up at the same time as it was being modified.

fuzzy copyAn archive copy of a file that might not accurately reflect what is currently in thefile because Tivoli Storage Manager archived the file while the file was beingmodified.


G

generate passwordProcessing that stores a new password in an encrypted password file when the oldpassword expires. Automatic generation of a password prevents passwordprompting. Password generation can be set in the options file (passwordaccessoption). Seeoptions file.

gigabyte (GB)(1) One billion (109) bytes. (2) When referring to memory capacity, 1 073 741 824in decimal notation.

graphical user interface (GUI)A graphical user interface offers pictoral rather than text-based access to a computer.A graphical user interface includes:¶ A combination of graphics and icons¶ Use of a mouse or pointing device¶ Menu bars, dropdown lists, and overlapping windows

Contrast withcommand line interface. Seewindowed interface.

GUIGraphical user interface.

H

hierarchical storage management clientA program that runs on a workstation or file server to provide space managementservices. The hierarchical storage management client automatically migrates eligiblefiles to Tivoli Storage Manager storage to maintain specific levels of free space onlocal file systems. Automatic recalls are made for migrated files when they areaccessed. Users are also permitted to migrate and recall specific files.

hiveOn Microsoft Windows, a registry subkey that corresponds to a set of files in the\system32\configdirectory.

HSMHierarchical Storage Management.


Glossary

I

inactive versionA copy of a backup file in Tivoli Storage Manager storage that either is not themost recent version, or the corresponding original file was deleted from the clientfile system. Inactive backup versions are eligible for expiration according to themanagement class assigned to the file.

include-exclude fileA file containing statements to determine the files to back up and the associatedmanagement classes to use for backup or archive. Seeinclude-exclude list.

include-exclude listA list of include and exclude options that include or exclude selected files forbackup. An exclude option identifies files that should not be backed up. An includeoption identifies files that are exempt from the exclusion rules or assigns amanagement class to a file or a group of files for backup or archive services. Theinclude-exclude list is defined in one or more include-exclude files or in the clientoptions file. The include-exclude list may contain entries from any or all of thefollowing sources: the client options file (Windows), the client system options file(Unix), separate include-exclude files, or the Tivoli Storage Manager server. Seeoptions file.

incremental backupA function that permits user to back up new or changed files or directories from aclient domain or from specified directories or files. These directories or files are notexcluded in the include-exclude list and meet the requirements for frequency, mode,and serialization as defined by a backup copy group of the management classassigned to each file. Contrast withselective backup.

IPLInitial Program Load.

J

journal-based backupFor Windows NT, 2000only: By default, theincremental command performs ajournal-based incremental backup on any journaled file systems. Theincrementalcommand performs the traditional full incremental backup on any non-journaled filesystems. Thejournal engine servicerecords changes to an object or its attributes ina journal database. With journal-based backup, the client does not scan the local filesystem or obtain information from the server to determine which files to process.

journal engine serviceFor Windows NT, 2000only: When enabled, thejournal engine servicerecordschanges to any journaled file systems that you specify. These changes are recorded


in a journal database on the client. During a journal-based backup, Tivoli StorageManager obtains a list of files that are eligible for backup from the journal database.

L

LANLocal area network.

LAN-free data transferThe movement of client data between the client and a storage device over a SAN,bypassing the LAN.

Local Area Network (LAN)A variable-sized communications network placed in one location. LAN connectsservers, PCs, workstations, a network operating system, access methods, andcommunications software and links.

M

management classA policy object that is a named collection of copy groups. A management class isassociated with a file to specify how the server should manage backup versions orarchive copies of workstation files. Seebinding andcopy group.

modeA copy group attribute that specifies whether a backup file should be created for afile that was not modified since the last time the file was backed up. Seeabsoluteandmodified.

modifiedA backup copy group attribute indicating a file is considered for backup only if thefile has been changed since the last backup. A file is considered changed if the date,size, owner, or permissions have changed. Seeabsoluteandmode.

N

Named PipeA type of interprocess communication that permits message data streams to passbetween peer processes, such as between a client and a server.

NAS nodeA type of node that is a NAS file server. The NAS node name uniquely identifiesthe NAS file server and its data to Tivoli Storage Manager. Through support ofNetwork Data Management Protocol (NDMP), Tivoli Storage Manager canefficiently back up and restore NAS file systems to tape drives or libraries that arelocally attached to the NAS file servers.


Glossary

NDMPNetwork Data Management Protocol.

Network Attached Storage (NAS) file serverA network attached storage (NAS) device is a specialized file-serving box whoseoperating system is streamlined and optimized for file-serving functions. Throughsupport of Network Data Management Protocol (NDMP), Tivoli Storage Managercan efficiently back up and restore NAS file systems to tape drives or libraries thatare locally attached to the NAS file servers.

Network Data Management ProtocolOpen standard network protocol. Enables efficient back up and restore of NetworkAttached Storage (NAS) file systems to tape drives or libraries that are locallyattached to the NAS file servers.

network data transfer rateThe data transfer rate calculated by dividing the total number of bytes transferred bythe data transfer time. For example, the time spent transferring data over thenetwork.

nodeSeeclient node.

node nameA unique name used to identify a workstation, file server, or PC to the server.

non-Unicode file spaceNon-Unicode file spaces and file names are limited to the character set of thecurrent locale when the files were backed up.

NTFSThe NT file system on Windows NT. A method for managing disk storage on theWindows NT operating system.

O

open registrationA registration process in which users can register their own workstations or PCs asclient nodes with the server. Contrast withclosed registration.

options fileA file that contains processing options.

¶ dsm.opt

Non-UNIX — Identifies Tivoli Storage Manager servers, specifiescommunication methods, defines scheduling options, selects backup, archive,restore, and retrieve options. Also called the client options file.


UNIX — Identifies the Tivoli Storage Manager server to contact, specifiesbackup, archive, restore, and retrieve options. Also called the client usersoptions file.

¶ dsm.sys

UNIX — Contains stanzas describing Tivoli Storage Manager servers to contactfor services. These stanzas also specify communication methods, backup andarchive options, and select scheduling options. Also called the client systemoptions file.

ownerThe owner of backup-archive files sent from a multi-user client node, such as AIX.

P

pattern-matching characterSeewildcard character.

policy domainA policy object that contains one or more policy sets. Client nodes are associatedwith a policy domain. Seepolicy set, management class, andcopy group.

policy setA policy object that contains a group of management class definitions that exist fora policy domain. At any one time, there can be many policy sets within a policydomain, but only one policy set can be active. Seeactive policy setandmanagement class.

progress indicatorA control used to inform a user about the progress of a process.

R

registrationThe process of identifying a client node or administrator to the server by specifyinga user ID, password, and contact information. For client nodes, a policy domain,compression status, and deletion privileges are also specified.

registryA central database in Windows that contains information about hardware,applications, and operating system settings for each machine on the network.Provides security and control over system, security, and account settings.


Glossary

restoreA function that permits users to copy a version of a backup file from the storagepool to a workstation or file server. The backup copy in the storage pool is notaffected. Contrast withbackup.

retentionThe amount of time, in days, that inactive backed up or archived files are retainedin the storage pool before they are deleted. The following copy group attributesdefine retention: retain extra versions, retain only version, retain version.

retrieveA function permitting users to copy an archived file from the storage pool to theworkstation or file server. The archive copy in the storage pool is not affected.Contrast witharchive.

S

SANStorage area network.

scheduling modeThe type of scheduling operation for the client-server node. Tivoli Storage Managersupports two scheduling modes: client-polling and server-prompted.

scrollMove through a list of items in a window by operating the scrollbars with themouse cursor.

selectChoose an item from a list or group of items.

selective backupA function permitting users to back up specified files. These files are not excludedin the include-exclude list and meet the requirement for serialization in the backupcopy group of the management class assigned to each file. Contrast withincremental backup.

serializationA copy group attribute that specifies whether a file can be modified during a backupor archive operation. Seestatic, dynamic, shared static, andshared dynamic.

serverA program running on a mainframe, workstation, or file server that provides sharedservices such as backup and archive to other various (often remote) programs(called clients).


server-prompted schedulingA client-server communication technique where the server contacts the client nodewhen tasks need to be done.

sessionA period of time in which a user can communicate with a server to perform backup,archive, restore, or retrieve requests.

shared dynamicA Tivoli Storage Manager copy group serialization mode. This mode specifies if afile changes during backup or archive and continues to change after a number ofretries. The last retry commits the file to the Tivoli Storage Manager server whetheror not the file changed during backup or archive. Contrast withdynamic, sharedstatic, andstatic.

shared staticA copy group serialization value specifying that a file must not be modified duringa backup or archive operation. Tivoli Storage Manager attempts to retry theoperation a number of times. If the file is in use during each attempt, the file is notbacked up or archived. Seeserialization. Contrast withdynamic, shared dynamic,andstatic.

share pointA drive or directory on Windows NT, 98, or Windows Me whose files are availablefor shared access across a network. The share point name is part of a UNC name.SeeUniversal Naming Convention (UNC)name.

shift-clickClick on an item while pressing the Shift key.

space managementThe process of keeping sufficient free storage space available on a local file systemfor new data and making the most efficient and economical use of distributedstorage resources.

stabilized file spaceA file space that exists on the server but not on the client. This situation can arise inat least two instances:1. A drive is removed from a client workstation2. A file space is renamed on the server

Stabilized file spaces remain on the server until deleted by the user or administrator.Files and directories can be restored and retrieved from a stabilized file space.However, it is not possible to back up or archive data to a stabilized file space.

staticA copy group serialization value specifying that a file must not be modified duringa backup or archive operation. If the file is in use during the first attempt, Tivoli


Glossary

Storage Manager will not back up or archive the file. Seeserialization. Contrastwith dynamic, shared dynamic, andshared static.

storage area network (SAN)A high-speed communications network optimized for storage.

storage agentA program that enables Tivoli Storage Manager to back up and restore client datadirectly to and from SAN-attached storage.

storage poolA named set of storage volumes used as the destination of backup, archive, ormigrated copies.

system drive or partitionOn Windows NT, the drive or partition on which Windows NT is installed.

T

TCATrusted Communications Agent

TCP/IPTransmission Control Protocol/Internet Protocol.

timeoutA time event involving:¶ An event that happens at the end of a predetermined period of time that began

at the happening of another specified event.¶ A time interval allotted for certain operations to happen. For example, response

to polling or addressing before system operation is interrupted and must berestarted.

¶ A terminal feature that logs off a user if an entry is not made within a specifiedperiod of time.

Tivoli Storage ManagerA client-server licensed program product that provides storage management and dataaccess services to customers in a multivendor computer environment.

Transmission Control Protocol/Internet Protocol (TCP/IP)A standard set of communication protocols that supports peer-to-peer connectivity offunctions for both local and wide-area networks.

Trusted Communications Agent (TCA) (UNIX)A program that can handle the sign-on password protocol when password access isgenerated. The main process (for example,dsm, dsmc) makes a run time decisionbased on the password access option setting, the user ID, and the executables’


access privileges to run this program. The file that contains this program must havethe ’s’ bit set in its mode field and the owner must be root.

U

UnicodeUnicode is a universal character encoding standard that supports the interchange,processing, and display of text that is written in any of the languages of the modernworld.

Unicode-enabled file spaceUnicode file space names provide support for multi-lingual workstations withoutregard for the current locale.

Universal Naming Convention (UNC) nameA name used on Windows to access a drive or directory containing files sharedacross a network. The UNC name includes the machine name and a share pointname that represents the shared drive or directory. Seeshare point.

V

versionStorage management policy may allow back-level copies of backed up objects to bekept at the server whenever an object is newly backed up. The most recent backedup copy is called the″active″ version. Earlier copies are″inactive″ versions. Thefollowing backup copy group attributes define version criteria: versions data exists,and versions data deleted.

W

wildcard characterAn asterisk (*) or question mark (?) character used to represent multiple (*) orsingle (?) characters when searching for various combinations of characters inalphanumeric and symbolic names.

windowed interfaceA type of user interface that is either a graphical user interface or a text-basedinterface. The text-based interface maintains a close affinity to the graphical userinterface, including action bars and their associated pull-down menus and windows.Seegraphical user interface.


Glossary

workstationA programmable high-level workstation (usually on a network) with its ownprocessing hardware such as a high-performance personal computer. In a local areanetwork, a personal computer that acts as a single user or client. A workstation canalso be used as a server.


Index

Aabsolute mode 104access

deleting 348querying 368

ACLfile systems supported 11

activatekey option 147active directory

system object, back up 326system object, query 369system object, restore 406

active filesdisplaying 31, 373restoring 62

adaptive subfile backupexcluding files 177including files 189specifying 245specifying client cache path 246specifying client cache size 247

adsm.sys directory, adsm98.sys directory 420archive

binding management classes to files 108command 324copy mode 104deleting 84, 349deleting file spaces 79description 12directory tree 83grace period retention 100how managed 97maximum file size 320overriding managment class during 107purpose 37sorting file list 30systems provided 10using commands 83using the Web client 12, 24

archive commandoverview 83

archive copy group 99attributes 100

archive descriptions, assigning 82archive packages 82archived files

display 370summary of options 132

archmc option 275authorization

summary of options 140authorization rule

deleting 348querying 368

authorizations 75authorizing

user for restore or retrieve 75autofsrename option 148automatically starting Tivoli Storage Manager

Windows clients 89automating backup-archive services

central scheduling 87description 13using central scheduling 13using client scheduler 13, 87

Bba_dsm.opt file

creating client options file 127back up

using LAN-Free Data Movement 54using universal naming convention 58

backing upfiles 35open file 55


Index

backing up (continued)summary of options 132system objects 49

backupactive directory system object 326active version 62adaptive subfile

specifying client cache path 246specifying client cache size 247

adaptive subfile, specifying 245binding management classes to files 108certificate server database system object 327cluster database system object 328COM+ database system object 329copy mode 104deleting file spaces 79description 10displaying processing status 51enabling communications for LAN-Free Data

Movement 197, 198estimating processing time 46event log system object 330files, management class 106filtering files for 47full incremental

using GUI 47fuzzy 104GPFS, multi-node cluster environment 167grace period retention 100inactivate a list of files 353inactive version 62include-exclude list 45incremental backup by date

using GUI 47journal-based 40, 357managing 97maximum file size 320NAS file systems 55, 445overview 37performing traditional full incremental 40,

297, 357purpose 37registry system object 336removable media using label 56Removable Storage Manager (RSM) system

object 340

backup (continued)replicated file system system object 332restore 61saving encryption key password 173searching files for 47selective 50

using GUI 47sorting file list 30starting incremental 49system and boot files system object 342system objects 343system volume system object 345systems provided 10types 10using LAN-Free Data Movement 171using multiple sessions 51using the Web client 12, 24

backup activedirectory command 326backup-archive client

overview 1backup certserverdb command 327backup clusterdb command 328backup complusdb command 329backup copy group 99

attributes 100backup eventlog command 330backup frs command 332backup NAS command 333backup registry command 336backup rsm command 340backup set

enabling GUI for local restore 69enabling GUI for local restore of 202restore 61, 69

backup setsrestoring in a SAN environment 408

backup sysfiles command 342backup systemobject command 343backup sysvol command 345backupregistry option 152batch mode 316

starting a session 21bottom up processing

include-exclude list 121


Ccancel process command 346cancel restore command 347central scheduling

summary of options 137to automate backup-archive services 13

certificate server databasesystem object, back up 327system object, query 378system object, restore 411

changingauthorizations 75

changingretries option 153class option 276client

registering with server 15setting password 16

client acceptor daemonuse to manage scheduler 204use to manage scheduler and Web client 204use to manage Web client 204

client command options 318archmc 275class 276clusternode 154deletefiles 277description 278detail 279dfsbackupmntpnt 163dirsonly 280filelist 281filesonly 284fromdate 285fromnode 286fromtime 287ifnewer 288inactive 289incrbydate 290latest 292nojournal 297noprompt 298overriding the client options file 269pick 299pittime 301preservepath 302

client command options(continued)todate 305totime 306type 307using options with commands 269v2archive 308

client commandsoverriding client options file 144

client message language type 199client options 318

backupregistry 152changingretries 153commmethod 155commrestartduration 156commrestartinterval 157compressalways 158compression 159dateformat 161dirmc 165domain 166domain.nas 168editor 170enablelanfree 171errorlogname 174errorlogretention 175exclude

exclude.archive 113, 177exclude.backup 113, 177exclude.compression 113, 177exclude.dir 113, 177exclude.encrypt 177exclude.file 113, 177exclude.file.backup 113, 177exclude.fs.nas 177exclude.subfile 113, 177

guitreeviewafterbackup 183httpport 184httpsport 186inclexcl 187include 189include.compression 189include.encrypt 189include.file 189include.fs.nas 189include.subfile 189include.systemobject 189


Index

client options (continued)lanfreecommmethod 197lanfreetcpport 198language 199largecommbuffers 201localbackupset 202location 293managedservices 204maxcmdretries 206memoryefficientbackup 207mode 295monitor 296namedpipename 208nasnodename 209nodename 210numberformat 212optfile 213overriding using command line 144password 214passwordaccess 216pitdate 300postnschedulecmd 218postschedulecmd 218prenschedulecmd 220preschedulecmd 220queryschedperiod 222quiet 223replace 224resourceutilization 226retryperiod 228revokeremoteaccess 229runasservice 230schedcmddisabled 231schedlogname 233schedlogretention 234schedmode 236scrolllines 238scrollprompt 239setting in a file 143skipntpermissions 240skipntsecuritycrc 241subdir 243subfilebackup 245subfilecachepath 246subfilecachesize 247tapeprompt 248

client options (continued)tcpbuffsize 250tcpclientaddress 251tcpclientport 252tcpnodelay 253tcpport 254tcpserveraddress 256tcpwindowsize 257timeformat 258txnbytelimit 259usedirectory 261using with commands 144verbose 263virtualnodename 264webports 266

client options filecreating and modifying 127overview 9specifying include-exclude options 111

client schedulerautomatically starting

Windows clients 89displaying completed work 93displaying scheduled work 91starting 436starting automatically 29

client system optionshttpport 184httpsport 186largecommbuffers 201nodename 210passwordaccess 216postnschedulecmd 218postschedulecmd 218prenschedulecmd 220preschedulecmd 220queryschedperiod 222resourceutilization 226retryperiod 228schedlogname 233schedlogretention 234schedmode 236scrolllines 238tcpbuffsize 250tcpclientaddress 251tcpclientport 252


client system options(continued)tcpnodelay 253tcpport 254tcpserveraddress 256tcpwindowsize 257txnbytelimit 259usedirectory 261

closed registrationpermissions 16using 16

cluster databasesystem object, back up 328system object, query 379system object, restore 412

clusternode option 154COM+ database

system object, back up 329system object, restore 413

COM+ databasessystem object, query 380

command linedisplaying processing status 51displaying the Euro characters in prompt 22ending a session 31overriding managment class during

archive 107performing point-in-time restore 74restrictions for NAS file systems 445starting a session 21

command line promptdisplaying the Euro characters 22

command name 318command parameters

optional 318required 318

command processing, summary of options 139command rules 322commands

archive 324backup activedirectory 326backup certserverdb 327backup clusterdb 328backup complusdb 329backup eventlog 330backup frs 332backup NAS 333

commands(continued)backup registry 336backup rsm 340backup sysfiles 342backup system volume 345backup systemobject 343batch mode 316cancel process 346cancel restore 347delete access 348delete archive 349delete filespace 351dsm 23dsmc 23expire 353help 355incremental 356interactive (loop) mode 317loop 365macro 366monitor process 367query access 368query activedirectory 369query archive 370query backup 373query backupset 376query certserverdb 378query clusterdb 379query complusdb 380query eventlog 381query filespace 382query frs 384query inclexcl 385query mgmtclass 386query node 387query registry 388query restore 389query RSM 391query schedule 392query session 393query sysfiles 394query systemobject 395query sysvol 396recall previous 321restart restore 397restore 398


Index

commands(continued)restore active directory 406restore backupset 407restore certserverdb 411restore clusterdb 412restore complusdb 413restore eventlog 414restore frs 416restore NAS 417restore registry 420restore rsm 425restore sysfiles 427restore system volume 429restore systemobject 428retrieve 430schedule 436scheduled, enabling or disabling 94selective 438set access 441set password 444using in executables 89using options with 144

commmethod option 155commrestartduration option 156commrestartinterval option 157communication methods

summary 129V4.2 changes 2

compressalways option 158compression option 159compression processing 159, 178, 189console window

displaying the Euro characters 22copy destination attribute 105copy frequency attribute 101copy group name attribute 101copy groups 98

archive 99backup 99

copy mode attributeabsolute 104modified 104

copy serialization attribute 103copy type attribute 101

Ddata

archivedeleting 84

dateformat option 161default

management class 98policy domain 98

default domainspecifying drives 48

deleteaccess command 348file space 79

deletefiles option 277deleting

archives 84authorizations 75

description option 278detail option 279Dfs files

backing up Microsoft 60directories

adsm.sys 420adsm.sys\registry.sav 420adsm98.sys 420adsm98.sys\registry.sav 420restoring from GUI 63restrictions on excluding from incremental

backup 39directory

archiving 83management classes 165specifying 319

directory tree, restoresubdirectory branches window 63

dirmc option 165dirsonly option 280Discretionary access control list

(permissions) 57disk recovery 78display

inactive backups 62displaying

active backup versions 31archived files 370


displaying (continued)backed up files 373inactive backup versions 31messages 263messages, stopping 223online help 31restartable restore sessions 389scheduled events 392session information 393

domainback up using the GUI 48specifying drives in the default 48

domain listusing universal naming convention to

specify 57domain.nas option 168domain option 166dsm command

including options 23using options 22

dsm command, starting 20dsm.opt file

creating and modifying 127dsm.smp file

creating client options file 127dsmc command

including options 23dsmsched.log file 93duplicate file names

avoiding 61dynamic and shared serialization 103

EEA data 77editor option 170enablelanfree option 171encrypting file data 46encryption

excluding files 177saving encryption key password 173

encryptkey 46encryptkey option 173entering client commands 317

entering commands 322error log

pruning 175error processing, summary of options 141errorlogname option 174errorlogretention option 175estimate function

for backup/restore processing 46event log

system object, back up 330system object, query 381system object, restore 414

exclude.encrypt 177exclude.fs.nas option 177exclude option

exclude.archive 113exclude.backup 113exclude.compression 113exclude.dir 113exclude.file 113exclude.file.backup 113exclude.subfile 113processing 121to exclude system files 117wildcard characters 118, 120

exclude optionsexclude.archive 177exclude.backup 177exclude.compression 177exclude.dir 177exclude.encrypt 177exclude.file 177exclude.file.backup 177exclude.fs.nas 177exclude.subfile 177

exclude.subfile option 177excluding files

remotely accessed 118system files 117using wildcard characters 120wildcard characters 118

executablesreturn codes from 89

expire command 353extended attributes (EA data) 77


Index

Ffile

archivedirectory tree 83

backing up open 55restoring from another node 76restoring to another workstation 76retrieving from another node 76retrieving to another workstation 76

file attributebackup 57

file namesavoiding duplicate 61

File Replication Services (FRS)system object, query 384

file spacedelete 79, 351

file specification syntaxmaximum file specifications in

command 319specifying 319

file systemsACL support for 11GPFS, multi-node cluster environment 167supported 11

filelist option 281files

archived, overriding management class 107archiving 324backing up Microsoft Dfs 60binding management classes to 108encryption 46excluding groups 118, 120include-exclude

creating in Unicode format 112, 187include-exclude, creating 112, 187including groups 118, 120maximum file size for operations 320processing include-exclude 121renaming file spaces that are not Unicode to

Unicode enabled 148, 356, 438restore, point-in-time 72restoring from GUI 63sorting list 30

filesonly option 284

firewallestablishing communications through 27,

184, 254specifying TCP/IP ports for the Web

client 266using Web client through 266

fixed drivesbacking up 57

format and languagesummary of options 139

fromdate option 285fromnode option 286

restoring or retrieving files 76fromtime option 287full incremental

description 38versus partial incremental 42when to use 42

fuzzy backup 104

GGPFS file system

multi-node cluster environment 167graphical options editor 129graphical user interface

changing password 30displaying online help 31displaying processing status 51enabling for local backup set restore 202enabling local backup set 69ending a session 31restore objects using 63starting a session 20

GUIoverriding managment class during

archive 107performing point-in-time restore 73

guitreeviewafterbackup option 183


Hhelp

displaying online 31online forum 31service and technical support 31

help command 355httpport option 184https secure socket layer (SSL)

specifying TCP/IP port address for 186httpsport option 186

Iifnewer option 288inactive files

displaying 31, 373restoring 62

inactive option 289inclexcl option 187include-exclude list

creating 111query order of processing 385to control processing 45

include-exclude options filespecifying path and file name of 187Unicode-enabled file spaces 187

include optionmanagement class 106processing 121wildcard characters 118, 120

include optionsinclude 189include.compression 189include.encrypt 189include.file 189include.fs.nas 189include.subfile 189include.systemobject 189

include.subfile option 189incrbydate option 290incremental

optimizing memory during 44

incremental backupdescription 38GPFS, multi-node cluster environment 167GUI 47types 38

incremental by dateGUI 47

incremental-by-datedescription 41

incremental command 356journal-based backup 357starting with command or GUI 49

incrthreshold option 195interactive mode 317interactive session

ending 365starting 21, 365using 365

Jjournal-based backup 40, 357

performing traditional full incremental,instead of 297, 357

specifying how to respond to unsuccessfulexpire of object 195

journaled file spacespecifying directories with active files to

expire 195

Llabel

using to backup removable media 56LAN-Free Data Movement

enabling 54, 171enabling communications for 197, 198options 54prerequisites 54

lanfreecommmethod option 197lanfreetcpport option 198


Index

language option 199largecommbuffers option 201latest option 292local backup set

enabling GUI for local restore 69localbackupset option 202location option 293log

pruning error 175loop command 365

Mmacro command 366managedservices option 204management classes 386

assigning to directories 107, 165assigning to files 106binding to files 108default 98displaying 100overriding during archive processing 107overriding the default 106processing 106questions to consider 105selecting for files 105specifying with include option 106using management class, example 106

maxcmdretries option 206memory

optimizing when constrained 44memoryefficientbackup option 44, 207messages

displaying on screen 263stop displaying 223

Microsoft Dfs files 60migrating from earlier versions of the product 2migrating to Unicode 3migration 3mobile dial-up support 29, 88mode option 295modes

batch 316interactive (loop) 317

modified mode 104monitor option 296monitor process command 367multiple sessions

backup objects, using 51

NNamed Pipe communication method

options 131namedpipename option 208NAS

backing up file systems 55, 445backup file systems 333backup NAS command 333cancel process command 346class option 276deleting file spaces 79, 351domain.nas option 168exclude.fs.nas option 177include.fs.nas option 189include volumes in an image backup 168monitor process command 367monitoring backup or restore operations 296nasnodename option 209query node command 387restore file systems 417restore NAS command 417restoring file systems 450type option 307

nasnodename option 209Network Attached Storage (NAS) file server

backup file systems 55, 333, 445deleting file spaces 79, 351display backup and restore processes to

cancel 346display backup and restore processes to

monitor 367display file spaces on server 382display nodes for which admin ID has

authority 387monitoring backup or restore operations 296Querying file system images belonging

to 373


Network Attached Storage (NAS) file server(continued)

restore file systems 417, 450specifying the node name for 209

no query restore 67node option, summary 131nodename option 76, 210nojournal option 297noprompt option 298NTFS file spaces

backup 57numberformat option 212

Oonline help

displaying 31online forum 31service and technical support 31

open file, backing up 55open registration

permissions 16using 16

optfile option 213optional parameters 318options

activatekey 147archive, summary 132archmc 275authorization, summary 140autofsrename 148backup, summary 132backupregistry 152central scheduling, summary 137changingretries 153class 276clusternode 154command processing, summary 139commmethod 155commrestartduration 156commrestartinterval 157communication, summary 129compressalways 158compression 159

options (continued)dateformat 161deletefiles 277description 278detail 279dfsbackupmntpnt 163dirmc 165dirsonly 280domain 166domain.nas 168editor 170enablelanfree 171encryptkey 173errorlogname 174errorlogretention 175exclude

exclude.archive 113, 177exclude.backup 113, 177exclude.compression 113, 177exclude.dir 113, 177exclude.encrypt 177exclude.file 113, 177exclude.file.backup 113, 177exclude.fs.nas 177exclude.subfile 177wildcard characters 118, 120

filelist 281filesonly 284format and language, summary 139fromdate 285fromnode 286fromtime 287guitreeviewafterbackup 183httpport 184httpsport 186ifnewer 288inactive 289inclexcl 187include 189

management class, specifying 106wildcard characters 118, 120

include.compression 189include.encrypt 189include.file 189include.fs.nas 189include.subfile 189


Index

options (continued)include.systemobject 189incrbydate 290incrthreshold 195lanfreecommmethod 197lanfreetcpport 198language 199largecommbuffers 201latest 292localbackupset 202location 293managedservices 204maxcmdretries 206memoryefficientbackup 207mode 295monitor 296namedpipename 208nasnodename 209nodename 210nojournal 297noprompt 298numberformat 212optfile 213overriding the client options file 269password 214passwordaccess 216pick 299pitdate 300pittime 301postnschedulecmd 218postschedulecmd 218prenschedulecmd 220preschedulecmd 220preservepath 302queryschedperiod 222quiet 223replace 224resourceutilization 226restore and retrieve, summary 136retryperiod 228revokeremoteaccess 229runasservice 230schedcmddisabled 231schedlogname 233schedlogretention 234schedmode 236

options (continued)scrolllines 238scrollprompt 239skipntpermissions 240skipntsecuritycrc 241specifying in commands 144subdir 243subfilebackup 245subfilecachepath 246subfilecachesize 247tapeprompt 248tcpbuffsize 250tcpclientaddress 251tcpclientport 252tcpnodelay 253tcpport 254tcpserveraddress 256tcpwindowsize 257timeformat 258todate 305totime 306transaction processing, summary 141txnbytelimit 259type 307usedirectory 261using options with commands 269v2archive 308verbose 263virtualnodename 264Web client, summary 142webports 266

overriding the client options file 269Owner security information (SID) 57

Pparameters, command

optional 318required 318

partial incrementaloverview 41types 41versus full incremental 42when to use 42


passwordchanging 30, 444number of characters 30setting for client 16valid characters 30

password option 214passwordaccess option 216performance

restore operations 66transaction options 141transaction processing 259

permissionsdeleting 348

pick option 299pitdate 300pittime option 301point-in-time restore 72policies, storage management 97policy domains

default policy domain 98standard policy domain 98

policy setsactive policy set 98

portable mediarestoring backup sets 69

postnschedulecmd option 218postschedulecmd option 218prenschedulecmd option 220preschedulecmd option 220preservepath option 302Primary group SID 57processing options

authorization 140backup and archive 132central scheduling 137communication 129error processing 141format and language 139node option 131restore and retrieve 136setting 143setting, overview 9specifying in commands 144transaction processing 141understanding 127Web client 142

processing timeestimating 46

processing transactions 259pruning

error log 175schedule log 234

Qquery

active directory system object 369certificate server database system object 378cluster database system object 379COM+ database system object 380event log system object 381File Replication Services (FRS) system

object 384include-exclude list 385registry system object 388Removable Storage Manager (RSM) system

object 391system and boot files system object 394system objects 395Windows 2000 system volume system

object 396query access command 368query activedirectory command 369query archive command 370query backup command 373query backupset command 376query certserverdb command 378query clusterdb command 379query complusdb command 380query eventlog command 381query filespace command 382query frs command 384query inclexcl command 385query mgmtclass command 386query node command 387query registry command 388query restore command 389query RSM command 391query schedule command 392query session command 393


Index

query sysfiles command 394query systemobject command 395query sysvol command 396queryschedperiod option 222quiet option 223

Rrebinding files to a different management

class 109recall commands 321recover

disk 78registering

client with server 15using closed registration 16using open registration 16

registrybackupregistry option 152system object, back up 336system object, query 388system object, restore 420

remote network connectionestablishing 29, 88

remotely accessed filesexcluding 118UNC names 118

Removable Storage Manager (RSM)system object, back up 340system object, query 391system object, restore 425

replace option 224replicated file system

system object, back up 332system object, restore 416

required parameters 318resourceutilization option 226restart restore command 397restartable restore 67restartable restore sessions, display 389restore

active directory system object 406active version 62

restore (continued)backup sets

overview 69supported tape devices 407

by command 64certificate server database system object 411cluster database system object 412COM+ database system object 413description 10estimating processing time 46event log system object 414filtering files for 63filtering for files for 63from other workstation types 77from portable media

overview 69inactive version 62local backup set via GUI 69, 202maximum file size 320NAS file systems 450no query 67overview 61point-in-time 72point-in-time, using command line 74point-in-time, using GUI 73registry system object 420Removable Storage Manager (RSM) system

object 425replicated file system system object 416searching for files for 63sorting file list 30sparse files 401sparse files, size restriction for 401sparse files to a non-NTFS file system 401subdirectory branches 63summary of options 136system and boot files system object 427system objects 428system volume system object 429using source path 63using the GUI 63using the Web client 12, 24using universal naming convention

names 62restore activedirectory command 406restore backupset command 407


restore certserverdb command 411restore clusterdb command 412restore command 398

overview 64using multiple 66

restore complusdb command 413restore eventlog command 414restore frs command 416restore NAS command 417restore registry command 420restore rsm command 425restore sysfiles command 427restore systemobject command 428restore sysvol command 429restoring

authorizing another user 75files 35files from another node 76large number of files 66system objects 64workstation, to another 76

retain extra versions attribute 102retain only versions attribute 103retain versions attribute 105retention grace period

archive 100, 110backup 100, 110

retrievearchive files by name 85from other workstation types 77maximum file size 320sorting file list 30summary of options 136using commands 86using the Web client 12, 24

retrieve command 430overview 86

retrievingauthorizing another user 75files from another node 76workstation, to another 76

retrieving archive copies 85retry

backup 153retryperiod option 228revokeremoteaccess option 229

rules 97runasservice option 230

SSAN

restoring backup sets using 171, 408using for LAN-Free data movement 54, 171

schedcmddisabled option 231schedlogname option 233schedlogretention option 234schedmode option 236schedule command 436schedule log, pruning 234scheduled commands

enabling-disabling 94scheduled events, displaying 392scheduled services 87

accessing Windows NT network drives 94disabling scheduled commands 231displaying completed work 93displaying scheduled work 91restrictions for NAS file systems 445scheduling options 88

scheduler wizardWindows NT and 2000 90

scheduling options 88scrolllines option 238scrollprompt option 239selective backup

description 41GUI 47using commands 50using universal naming convention 58

selective command 438serialization

copy serializationdynamic 103shared static 103static 103

serverestablishing communications through

firewall 27specifying TCP/IP port address for 254


Index

session information, displaying 393set access command 441

restore-retrieve authorization 75set password command 444shared dynamic serialization 103Shared Memory communication method 197shared static serialization 103skipntpermissions option 240skipntsecuritycrc option 241sorting

files 30sparse files 10

restore size restriction 401restoring 401restoring to a non-NTFS file system 401

standard management classcopy destination 105copy frequency 101copy group name 101copy mode

absolute 104modified 104

copy serialization 103copy type 101default values 100retain extra versions 102retain only version 103retain versions 105versions data deleted

active versions 102inactive versions 102

versions data exists 102standard policy domain 98starting

a GUI session 20Tivoli Storage Manager automatically 29Web client 24

starting a sessionbatch mode 21interactive mode 21

starting Tivoli Storage Managerautomatically 89

static, shared serialization 103static serialization 103storage

displaying files 370, 373

storage(continued)displaying restartable restore sessions 389

Storage Agentusing for LAN-Free data movement 54, 171

storage area networkrestoring backup sets using 171, 408using for LAN-Free data movement 54, 171

storage management policies 9, 97copy groups 98default management class 98include-exclude list 99management classes 98policy domains

default 98standard 98

policy setsactive policy set 98

subdir option 243subdirectory path

restore, directory tree 63subfilebackup option 245subfilecachepath option 246subfilecachesize option 247summary of changes for Tivoli Storage Manager

V4.2 xxxiiiSystem access control list (auditing

information) 57system and boot files

query 394system object, back up 342system object, restore 427

system objectsactive directory

back up 326query 369restore 406

back up 343backing up 49certificate server database


cluster databaseback up 328query 379restore 412


system objects(continued)COM+ database


event logback up 330query 381restore 414

File Replication Services (FRS)query 384

query 395registry


Removable Storage Manager (RSM)back up 340query 391restore 425

replicated file systemback up 332restore 416

restore 428restoring 64system and boot files


system volumeback up 345restore 429

system volumesquery 396

system volumesystem object, back up 345system object, restore 429

Ttapeprompt option 248TCP/IP communication method

options 129tcpbuffsize option 250

tcpclientaddress option 251tcpclientport option 252tcpnodelay option 253tcpport option 254tcpserveraddress option 256tcpwindowsize option 257timeformat option 258Tivoli Storage Manager

ending a command line session 31ending a GUI session 31establishing communications through

firewall 27, 184, 254introducing 1migrating from earlier versions 2mobile dial-up support 29, 88online help 31online Help forum 31password 30service and technical support 31summary of changes for version 4.2 xxxiiiV4.2 client-server communication changes 2

todate option 305totime option 306transaction processing 259

summary of options 141troubleshooting

incremental memory constraints 44txnbytelimit option 259type option 307

UUNC names

back up, using 58excluding files 118remotely accessed files 118restore files, using 62using to specify domain list 57

Unicode 3backup and archive 43renaming file spaces that are not Unicode to

Unicode enabled 148, 356, 438Unicode migration 3


Index

universal naming conventionselective back up, using 58using to specify domain list 57

universal naming convention namesrestore, using 62

usedirectory option 261using

options with commands 269using options

client 318client command 318

Vv2archive option 308verbose option 263versions data

deleted attribute 102exists attribute 102

virtualnodename option 264

WWeb client

description 12establishing communications through

firewall 27, 184restrictions for NAS file systems 445services provided 12specifying TCP/IP port address for 184starting 24summary of options 142unsupported functions 12using through a firewall 266

webports option 266wildcard characters

include or exclude groups of files 118to include or exclude groups of files 120using 322

Windows 2000references to 35

Windows clientsautomatically starting Tivoli Storage

Manager 89Windows NT and 2000

Scheduler Service Configuration Utility 90workstation

restore or retrieve from another type 77


Program Number: 5697-TSS5698-TSM5698-DPA

Printed in the United States of Americaon recycled paper containing 10%recovered post-consumer fiber.

SH26-4117-02

Spine information:

Tivoli Storage Manager for Windows Using theBackup-Archive Client,Version 4 Release 2

Tivoli Storage Manager for Windows Using the … Storage Manager for Windows Using the...

Documents

Transcript of Tivoli Storage Manager for Windows Using the … Storage Manager for Windows Using the...